]> code.delx.au - gnu-emacs/blob - lisp/calendar/diary-lib.el
From Ulf Jasper <ulf.jasper@web.de>:
[gnu-emacs] / lisp / calendar / diary-lib.el
1 ;;; diary-lib.el --- diary functions
2
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2003, 2004, 2005
4 ;; Free Software Foundation, Inc.
5
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
8 ;; Keywords: calendar
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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.
26
27 ;;; Commentary:
28
29 ;; This collection of functions implements the diary features as described
30 ;; in calendar.el.
31
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
37
38 ;;; Code:
39
40 (require 'calendar)
41
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))))
51
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)))))
67
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))
76
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 (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)))
87
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'.")
92
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'.")
96
97 (autoload 'diary-french-date "cal-french"
98 "French calendar equivalent of date diary entry.")
99
100 (autoload 'diary-mayan-date "cal-mayan"
101 "Mayan calendar equivalent of date diary entry.")
102
103 (autoload 'diary-iso-date "cal-iso"
104 "ISO calendar equivalent of date diary entry.")
105
106 (autoload 'diary-julian-date "cal-julian"
107 "Julian calendar equivalent of date diary entry.")
108
109 (autoload 'diary-astro-day-number "cal-julian"
110 "Astronomical (Julian) day number diary entry.")
111
112 (autoload 'diary-chinese-date "cal-china"
113 "Chinese calendar equivalent of date diary entry.")
114
115 (autoload 'diary-islamic-date "cal-islam"
116 "Islamic calendar equivalent of date diary entry.")
117
118 (autoload 'list-islamic-diary-entries "cal-islam"
119 "Add any Islamic date entries from the diary file to `diary-entries-list'.")
120
121 (autoload 'mark-islamic-diary-entries "cal-islam"
122 "Mark days in the calendar window that have Islamic date diary entries.")
123
124 (autoload 'mark-islamic-calendar-date-pattern "cal-islam"
125 "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR.")
126
127 (autoload 'diary-bahai-date "cal-bahai"
128 "Baha'i calendar equivalent of date diary entry."
129 t)
130
131 (autoload 'list-bahai-diary-entries "cal-bahai"
132 "Add any Baha'i date entries from the diary file to `diary-entries-list'."
133 t)
134
135 (autoload 'mark-bahai-diary-entries "cal-bahai"
136 "Mark days in the calendar window that have Baha'i date diary entries."
137 t)
138
139 (autoload 'mark-bahai-calendar-date-pattern "cal-bahai"
140 "Mark dates in calendar window that conform to Baha'i date MONTH/DAY/YEAR."
141 t)
142
143 (autoload 'diary-hebrew-date "cal-hebrew"
144 "Hebrew calendar equivalent of date diary entry.")
145
146 (autoload 'diary-omer "cal-hebrew"
147 "Omer count diary entry.")
148
149 (autoload 'diary-yahrzeit "cal-hebrew"
150 "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before.")
151
152 (autoload 'diary-parasha "cal-hebrew"
153 "Parasha diary entry--entry applies if date is a Saturday.")
154
155 (autoload 'diary-rosh-hodesh "cal-hebrew"
156 "Rosh Hodesh diary entry.")
157
158 (autoload 'list-hebrew-diary-entries "cal-hebrew"
159 "Add any Hebrew date entries from the diary file to `diary-entries-list'.")
160
161 (autoload 'mark-hebrew-diary-entries "cal-hebrew"
162 "Mark days in the calendar window that have Hebrew date diary entries.")
163
164 (autoload 'mark-hebrew-calendar-date-pattern "cal-hebrew"
165 "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR.")
166
167 (autoload 'diary-coptic-date "cal-coptic"
168 "Coptic calendar equivalent of date diary entry.")
169
170 (autoload 'diary-ethiopic-date "cal-coptic"
171 "Ethiopic calendar equivalent of date diary entry.")
172
173 (autoload 'diary-persian-date "cal-persia"
174 "Persian calendar equivalent of date diary entry.")
175
176 (autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
177
178 (autoload 'diary-sunrise-sunset "solar"
179 "Local time of sunrise and sunset as a diary entry.")
180
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.")
184
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.")
189
190 (modify-syntax-entry ?* "w" diary-syntax-table)
191 (modify-syntax-entry ?: "w" diary-syntax-table)
192
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)
201
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))
218
219
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))))
276
277
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 "22.1")
286
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 "22.1")
299
300 (defvar diary-saved-point) ; internal
301
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.
307
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.
314
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:
318
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.
322
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.
327
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.
332
333 `diary-hook' is run last. This can be used for an appointment
334 notification function."
335
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))))))
461
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)))
509
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"))))
545
546 (defface diary-button-face '((((type pc) (class color))
547 (:foreground "lightblue")))
548 "Default face used for buttons."
549 :version "22.1"
550 :group 'diary)
551
552 (define-button-type 'diary-entry
553 'action #'diary-goto-entry
554 'face #'diary-button-face)
555
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)))))
561
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)
619 t)
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)))
643 x)
644 date-holiday-list
645 (concat "\n" (make-string l ? ))))
646 (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
647
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)
663 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"))))
689
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)))
700
701 (defun print-diary-entries ()
702 "Print a hard copy of the diary display.
703
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.
707
708 If the fancy diary display is being used, just print the buffer.
709
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!")))))
740
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)))))
759
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")
766
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")
772
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'.
778
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.
783
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
793
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))))
813
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))
831
832 (defvar marking-diary-entries nil
833 "True during the marking of diary entries, nil otherwise.")
834
835 (defvar marking-diary-entry nil
836 "True during the marking of diary entries, if current entry is marking.")
837
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 ;; To remove any deleted diary entries.
845 (when mark-diary-entries-in-calendar
846 (setq mark-diary-entries-in-calendar nil)
847 (redraw-calendar))
848 (let ((marking-diary-entries t)
849 file-glob-attrs marks)
850 (save-excursion
851 (set-buffer (find-file-noselect (diary-check-diary-file) t))
852 (setq mark-diary-entries-in-calendar t)
853 (message "Marking diary entries...")
854 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
855 (let ((d diary-date-forms)
856 (old-diary-syntax-table (syntax-table))
857 temp)
858 (set-syntax-table diary-syntax-table)
859 (while d
860 (let* ((date-form (if (equal (car (car d)) 'backup)
861 (cdr (car d))
862 (car d)));; ignore 'backup directive
863 (dayname
864 (diary-name-pattern calendar-day-name-array
865 calendar-day-abbrev-array))
866 (monthname
867 (format "%s\\|\\*"
868 (diary-name-pattern calendar-month-name-array
869 calendar-month-abbrev-array)))
870 (month "[0-9]+\\|\\*")
871 (day "[0-9]+\\|\\*")
872 (year "[0-9]+\\|\\*")
873 (l (length date-form))
874 (d-name-pos (- l (length (memq 'dayname date-form))))
875 (d-name-pos (if (/= l d-name-pos) (+ 2 d-name-pos)))
876 (m-name-pos (- l (length (memq 'monthname date-form))))
877 (m-name-pos (if (/= l m-name-pos) (+ 2 m-name-pos)))
878 (d-pos (- l (length (memq 'day date-form))))
879 (d-pos (if (/= l d-pos) (+ 2 d-pos)))
880 (m-pos (- l (length (memq 'month date-form))))
881 (m-pos (if (/= l m-pos) (+ 2 m-pos)))
882 (y-pos (- l (length (memq 'year date-form))))
883 (y-pos (if (/= l y-pos) (+ 2 y-pos)))
884 (regexp
885 (concat
886 "\\(\\`\\|\^M\\|\n\\)\\("
887 (mapconcat 'eval date-form "\\)\\(")
888 "\\)"))
889 (case-fold-search t))
890 (goto-char (point-min))
891 (while (re-search-forward regexp nil t)
892 (let* ((dd-name
893 (if d-name-pos
894 (buffer-substring-no-properties
895 (match-beginning d-name-pos)
896 (match-end d-name-pos))))
897 (mm-name
898 (if m-name-pos
899 (buffer-substring-no-properties
900 (match-beginning m-name-pos)
901 (match-end m-name-pos))))
902 (mm (string-to-int
903 (if m-pos
904 (buffer-substring-no-properties
905 (match-beginning m-pos)
906 (match-end m-pos))
907 "")))
908 (dd (string-to-int
909 (if d-pos
910 (buffer-substring-no-properties
911 (match-beginning d-pos)
912 (match-end d-pos))
913 "")))
914 (y-str (if y-pos
915 (buffer-substring-no-properties
916 (match-beginning y-pos)
917 (match-end y-pos))))
918 (yy (if (not y-str)
919 0
920 (if (and (= (length y-str) 2)
921 abbreviated-calendar-year)
922 (let* ((current-y
923 (extract-calendar-year
924 (calendar-current-date)))
925 (y (+ (string-to-int y-str)
926 (* 100
927 (/ current-y 100)))))
928 (if (> (- y current-y) 50)
929 (- y 100)
930 (if (> (- current-y y) 50)
931 (+ y 100)
932 y)))
933 (string-to-int y-str))))
934 (save-excursion
935 (setq entry (buffer-substring-no-properties
936 (point) (line-end-position))
937 temp (diary-pull-attrs entry file-glob-attrs)
938 entry (nth 0 temp)
939 marks (nth 1 temp))))
940 (if dd-name
941 (mark-calendar-days-named
942 (cdr (assoc-string
943 dd-name
944 (calendar-make-alist
945 calendar-day-name-array
946 0 nil calendar-day-abbrev-array) t)) marks)
947 (if mm-name
948 (setq mm
949 (if (string-equal mm-name "*") 0
950 (cdr (assoc-string
951 mm-name
952 (calendar-make-alist
953 calendar-month-name-array
954 1 nil calendar-month-abbrev-array) t)))))
955 (mark-calendar-date-pattern mm dd yy marks))))
956 (setq d (cdr d))))
957 (mark-sexp-diary-entries)
958 (run-hooks 'nongregorian-diary-marking-hook
959 'mark-diary-entries-hook)
960 (set-syntax-table old-diary-syntax-table)
961 (message "Marking diary entries...done")))))
962
963 (defun mark-sexp-diary-entries ()
964 "Mark days in the calendar window that have sexp diary entries.
965 Each entry in the diary file (or included files) visible in the calendar window
966 is marked. See the documentation for the function `list-sexp-diary-entries'."
967 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
968 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
969 sexp-mark "(\\)\\|\\("
970 (regexp-quote diary-nonmarking-symbol)
971 sexp-mark "(diary-remind\\)"))
972 (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
973 m y first-date last-date mark file-glob-attrs)
974 (save-excursion
975 (set-buffer calendar-buffer)
976 (setq m displayed-month)
977 (setq y displayed-year))
978 (increment-calendar-month m y -1)
979 (setq first-date
980 (calendar-absolute-from-gregorian (list m 1 y)))
981 (increment-calendar-month m y 2)
982 (setq last-date
983 (calendar-absolute-from-gregorian
984 (list m (calendar-last-day-of-month m y) y)))
985 (goto-char (point-min))
986 (while (re-search-forward s-entry nil t)
987 (setq marking-diary-entry (char-equal (preceding-char) ?\())
988 (re-search-backward "(")
989 (let ((sexp-start (point))
990 sexp entry entry-start line-start marks)
991 (forward-sexp)
992 (setq sexp (buffer-substring-no-properties sexp-start (point)))
993 (save-excursion
994 (re-search-backward "\^M\\|\n\\|\\`")
995 (setq line-start (point)))
996 (forward-char 1)
997 (if (and (or (char-equal (preceding-char) ?\^M)
998 (char-equal (preceding-char) ?\n))
999 (not (looking-at " \\|\^I")))
1000 (progn;; Diary entry consists only of the sexp
1001 (backward-char 1)
1002 (setq entry ""))
1003 (setq entry-start (point))
1004 ;; Find end of entry
1005 (re-search-forward "\^M\\|\n" nil t)
1006 (while (looking-at " \\|\^I")
1007 (or (re-search-forward "\^M\\|\n" nil t)
1008 (re-search-forward "$" nil t)))
1009 (if (or (char-equal (preceding-char) ?\^M)
1010 (char-equal (preceding-char) ?\n))
1011 (backward-char 1))
1012 (setq entry (buffer-substring-no-properties entry-start (point)))
1013 (while (string-match "[\^M]" entry)
1014 (aset entry (match-beginning 0) ?\n )))
1015 (calendar-for-loop date from first-date to last-date do
1016 (if (setq mark (diary-sexp-entry sexp entry
1017 (calendar-gregorian-from-absolute date)))
1018 (progn
1019 (setq marks (diary-pull-attrs entry file-glob-attrs)
1020 marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
1021 (mark-visible-calendar-date
1022 (calendar-gregorian-from-absolute date)
1023 (if (< 0 (length marks))
1024 marks
1025 (if (consp mark)
1026 (car mark)))))))))))
1027
1028 (defun mark-included-diary-files ()
1029 "Mark the diary entries from other diary files with those of the diary file.
1030 This function is suitable for use as the `mark-diary-entries-hook'; it enables
1031 you to use shared diary files together with your own. The files included are
1032 specified in the diary-file by lines of this form:
1033 #include \"filename\"
1034 This is recursive; that is, #include directives in diary files thus included
1035 are obeyed. You can change the `#include' to some other string by
1036 changing the variable `diary-include-string'."
1037 (goto-char (point-min))
1038 (while (re-search-forward
1039 (concat
1040 "\\(\\`\\|\^M\\|\n\\)"
1041 (regexp-quote diary-include-string)
1042 " \"\\([^\"]*\\)\"")
1043 nil t)
1044 (let ((diary-file (substitute-in-file-name
1045 (buffer-substring-no-properties
1046 (match-beginning 2) (match-end 2))))
1047 (mark-diary-entries-hook 'mark-included-diary-files))
1048 (if (file-exists-p diary-file)
1049 (if (file-readable-p diary-file)
1050 (progn
1051 (mark-diary-entries)
1052 (kill-buffer (find-buffer-visiting diary-file)))
1053 (beep)
1054 (message "Can't read included diary file %s" diary-file)
1055 (sleep-for 2))
1056 (beep)
1057 (message "Can't find included diary file %s" diary-file)
1058 (sleep-for 2))))
1059 (goto-char (point-min)))
1060
1061 (defun mark-calendar-days-named (dayname &optional color)
1062 "Mark all dates in the calendar window that are day DAYNAME of the week.
1063 0 means all Sundays, 1 means all Mondays, and so on."
1064 (save-excursion
1065 (set-buffer calendar-buffer)
1066 (let ((prev-month displayed-month)
1067 (prev-year displayed-year)
1068 (succ-month displayed-month)
1069 (succ-year displayed-year)
1070 (last-day)
1071 (day))
1072 (increment-calendar-month succ-month succ-year 1)
1073 (increment-calendar-month prev-month prev-year -1)
1074 (setq day (calendar-absolute-from-gregorian
1075 (calendar-nth-named-day 1 dayname prev-month prev-year)))
1076 (setq last-day (calendar-absolute-from-gregorian
1077 (calendar-nth-named-day -1 dayname succ-month succ-year)))
1078 (while (<= day last-day)
1079 (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color)
1080 (setq day (+ day 7))))))
1081
1082 (defun mark-calendar-date-pattern (month day year &optional color)
1083 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
1084 A value of 0 in any position is a wildcard."
1085 (save-excursion
1086 (set-buffer calendar-buffer)
1087 (let ((m displayed-month)
1088 (y displayed-year))
1089 (increment-calendar-month m y -1)
1090 (calendar-for-loop i from 0 to 2 do
1091 (mark-calendar-month m y month day year color)
1092 (increment-calendar-month m y 1)))))
1093
1094 (defun mark-calendar-month (month year p-month p-day p-year &optional color)
1095 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
1096 A value of 0 in any position of the pattern is a wildcard."
1097 (if (or (and (= month p-month)
1098 (or (= p-year 0) (= year p-year)))
1099 (and (= p-month 0)
1100 (or (= p-year 0) (= year p-year))))
1101 (if (= p-day 0)
1102 (calendar-for-loop
1103 i from 1 to (calendar-last-day-of-month month year) do
1104 (mark-visible-calendar-date (list month i year) color))
1105 (mark-visible-calendar-date (list month p-day year) color))))
1106
1107 (defun sort-diary-entries ()
1108 "Sort the list of diary entries by time of day."
1109 (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))
1110
1111 (defun diary-entry-compare (e1 e2)
1112 "Returns t if E1 is earlier than E2."
1113 (or (calendar-date-compare e1 e2)
1114 (and (calendar-date-equal (car e1) (car e2))
1115 (let* ((ts1 (cadr e1)) (t1 (diary-entry-time ts1))
1116 (ts2 (cadr e2)) (t2 (diary-entry-time ts2)))
1117 (or (< t1 t2)
1118 (and (= t1 t2)
1119 (string-lessp ts1 ts2)))))))
1120
1121 (defcustom diary-unknown-time
1122 -9999
1123 "*Value returned by diary-entry-time when no time is found.
1124 The default value -9999 causes entries with no recognizable time to be placed
1125 before those with times; 9999 would place entries with no recognizable time
1126 after those with times."
1127 :type 'integer
1128 :group 'diary
1129 :version "20.3")
1130
1131 (defun diary-entry-time (s)
1132 "Return time at the beginning of the string S as a military-style integer.
1133 For example, returns 1325 for 1:25pm.
1134
1135 Returns `diary-unknown-time' (default value -9999) if no time is recognized.
1136 The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
1137 XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A period (.) can
1138 be used instead of a colon (:) to separate the hour and minute parts."
1139 (let ((case-fold-search nil))
1140 (cond ((string-match ; Military time
1141 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
1142 s)
1143 (+ (* 100 (string-to-int
1144 (substring s (match-beginning 1) (match-end 1))))
1145 (string-to-int (substring s (match-beginning 2) (match-end 2)))))
1146 ((string-match ; Hour only XXam or XXpm
1147 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s)
1148 (+ (* 100 (% (string-to-int
1149 (substring s (match-beginning 1) (match-end 1)))
1150 12))
1151 (if (equal ?a (downcase (aref s (match-beginning 2))))
1152 0 1200)))
1153 ((string-match ; Hour and minute XX:XXam or XX:XXpm
1154 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s)
1155 (+ (* 100 (% (string-to-int
1156 (substring s (match-beginning 1) (match-end 1)))
1157 12))
1158 (string-to-int (substring s (match-beginning 2) (match-end 2)))
1159 (if (equal ?a (downcase (aref s (match-beginning 3))))
1160 0 1200)))
1161 (t diary-unknown-time)))) ; Unrecognizable
1162
1163 ;; Unrecognizable
1164
1165 (defun list-sexp-diary-entries (date)
1166 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
1167 Also, Make them visible in the diary file. Returns t if any entries were
1168 found.
1169
1170 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
1171 `%%'). The form of a sexp diary entry is
1172
1173 %%(SEXP) ENTRY
1174
1175 Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
1176 SEXP yields the value nil, the diary entry does not apply. If it yields a
1177 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1178 string, that string will be the diary entry in the fancy diary display.
1179
1180 For example, the following diary entry will apply to the 21st of the month
1181 if it is a weekday and the Friday before if the 21st is on a weekend:
1182
1183 &%%(let ((dayname (calendar-day-of-week date))
1184 (day (extract-calendar-day date)))
1185 (or
1186 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1187 (and (memq day '(19 20)) (= dayname 5)))
1188 ) UIUC pay checks deposited
1189
1190 A number of built-in functions are available for this type of diary entry:
1191
1192 %%(diary-date MONTH DAY YEAR &optional MARK) text
1193 Entry applies if date is MONTH, DAY, YEAR if
1194 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1195 `european-calendar-style' is t. DAY, MONTH, and YEAR
1196 can be lists of integers, the constant t, or an integer.
1197 The constant t means all values. An optional parameter
1198 MARK specifies a face or single-character string to use
1199 when highlighting the day in the calendar.
1200
1201 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
1202 Entry will appear on the Nth DAYNAME of MONTH.
1203 (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1204 if N is negative it counts backward from the end of
1205 the month. MONTH can be a list of months, a single
1206 month, or t to specify all months. Optional DAY means
1207 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
1208 to 1 if N>0 and the last day of the month if N<0. An
1209 optional parameter MARK specifies a face or single-character
1210 string to use when highlighting the day in the calendar.
1211
1212 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
1213 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1214 inclusive. (If `european-calendar-style' is t, the
1215 order of the parameters should be changed to D1, M1, Y1,
1216 D2, M2, Y2.) An optional parameter MARK specifies a face
1217 or single-character string to use when highlighting the
1218 day in the calendar.
1219
1220 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
1221 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1222 (If `european-calendar-style' is t, the order of the
1223 parameters should be changed to DAY, MONTH, YEAR.) Text
1224 can contain %d or %d%s; %d will be replaced by the number
1225 of years since the MONTH DAY, YEAR and %s will be replaced
1226 by the ordinal ending of that number (that is, `st', `nd',
1227 `rd' or `th', as appropriate. The anniversary of February
1228 29 is considered to be March 1 in a non-leap year. An
1229 optional parameter MARK specifies a face or single-character
1230 string to use when highlighting the day in the calendar.
1231
1232 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
1233 Entry will appear every N days, starting MONTH DAY, YEAR.
1234 (If `european-calendar-style' is t, the order of the
1235 parameters should be changed to N, DAY, MONTH, YEAR.) Text
1236 can contain %d or %d%s; %d will be replaced by the number
1237 of repetitions since the MONTH DAY, YEAR and %s will
1238 be replaced by the ordinal ending of that number (that is,
1239 `st', `nd', `rd' or `th', as appropriate. An optional
1240 parameter MARK specifies a face or single-character string
1241 to use when highlighting the day in the calendar.
1242
1243 %%(diary-remind SEXP DAYS &optional MARKING) text
1244 Entry is a reminder for diary sexp SEXP. DAYS is either a
1245 single number or a list of numbers indicating the number(s)
1246 of days before the event that the warning(s) should occur.
1247 If the current date is (one of) DAYS before the event
1248 indicated by EXPR, then a suitable message (as specified
1249 by `diary-remind-message') appears. In addition to the
1250 reminders beforehand, the diary entry also appears on
1251 the date itself. If optional MARKING is non-nil then the
1252 *reminders* are marked on the calendar. Marking of
1253 reminders is independent of whether the entry *itself* is
1254 a marking or nonmarking one.
1255
1256 %%(diary-day-of-year)
1257 Diary entries giving the day of the year and the number of
1258 days remaining in the year will be made every day. Note
1259 that since there is no text, it makes sense only if the
1260 fancy diary display is used.
1261
1262 %%(diary-iso-date)
1263 Diary entries giving the corresponding ISO commercial date
1264 will be made every day. Note that since there is no text,
1265 it makes sense only if the fancy diary display is used.
1266
1267 %%(diary-french-date)
1268 Diary entries giving the corresponding French Revolutionary
1269 date will be made every day. Note that since there is no
1270 text, it makes sense only if the fancy diary display is used.
1271
1272 %%(diary-islamic-date)
1273 Diary entries giving the corresponding Islamic date will be
1274 made every day. Note that since there is no text, it
1275 makes sense only if the fancy diary display is used.
1276
1277 %%(diary-hebrew-date)
1278 Diary entries giving the corresponding Hebrew date will be
1279 made every day. Note that since there is no text, it
1280 makes sense only if the fancy diary display is used.
1281
1282 %%(diary-astro-day-number) Diary entries giving the corresponding
1283 astronomical (Julian) day number will be made every day.
1284 Note that since there is no text, it makes sense only if the
1285 fancy diary display is used.
1286
1287 %%(diary-julian-date) Diary entries giving the corresponding
1288 Julian date will be made every day. Note that since
1289 there is no text, it makes sense only if the fancy diary
1290 display is used.
1291
1292 %%(diary-sunrise-sunset)
1293 Diary entries giving the local times of sunrise and sunset
1294 will be made every day. Note that since there is no text,
1295 it makes sense only if the fancy diary display is used.
1296 Floating point required.
1297
1298 %%(diary-phases-of-moon)
1299 Diary entries giving the times of the phases of the moon
1300 will be when appropriate. Note that since there is no text,
1301 it makes sense only if the fancy diary display is used.
1302 Floating point required.
1303
1304 %%(diary-yahrzeit MONTH DAY YEAR) text
1305 Text is assumed to be the name of the person; the date is
1306 the date of death on the *civil* calendar. The diary entry
1307 will appear on the proper Hebrew-date anniversary and on the
1308 day before. (If `european-calendar-style' is t, the order
1309 of the parameters should be changed to DAY, MONTH, YEAR.)
1310
1311 %%(diary-rosh-hodesh)
1312 Diary entries will be made on the dates of Rosh Hodesh on
1313 the Hebrew calendar. Note that since there is no text, it
1314 makes sense only if the fancy diary display is used.
1315
1316 %%(diary-parasha)
1317 Diary entries giving the weekly parasha will be made on
1318 every Saturday. Note that since there is no text, it
1319 makes sense only if the fancy diary display is used.
1320
1321 %%(diary-omer)
1322 Diary entries giving the omer count will be made every day
1323 from Passover to Shavuot. Note that since there is no text,
1324 it makes sense only if the fancy diary display is used.
1325
1326 Marking these entries is *extremely* time consuming, so these entries are
1327 best if they are nonmarking."
1328 (let ((s-entry (concat "\\(\\`\\|\^M\\|\n\\)"
1329 (regexp-quote diary-nonmarking-symbol)
1330 "?"
1331 (regexp-quote sexp-diary-entry-symbol)
1332 "("))
1333 entry-found file-glob-attrs marks)
1334 (goto-char (point-min))
1335 (save-excursion
1336 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '()))))
1337 (while (re-search-forward s-entry nil t)
1338 (backward-char 1)
1339 (let ((sexp-start (point))
1340 sexp entry specifier entry-start line-start)
1341 (forward-sexp)
1342 (setq sexp (buffer-substring-no-properties sexp-start (point)))
1343 (save-excursion
1344 (re-search-backward "\^M\\|\n\\|\\`")
1345 (setq line-start (point)))
1346 (setq specifier
1347 (buffer-substring-no-properties (1+ line-start) (point))
1348 entry-start (1+ line-start))
1349 (forward-char 1)
1350 (if (and (or (char-equal (preceding-char) ?\^M)
1351 (char-equal (preceding-char) ?\n))
1352 (not (looking-at " \\|\^I")))
1353 (progn;; Diary entry consists only of the sexp
1354 (backward-char 1)
1355 (setq entry ""))
1356 (setq entry-start (point))
1357 (re-search-forward "\^M\\|\n" nil t)
1358 (while (looking-at " \\|\^I")
1359 (re-search-forward "\^M\\|\n" nil t))
1360 (backward-char 1)
1361 (setq entry (buffer-substring-no-properties entry-start (point)))
1362 (while (string-match "[\^M]" entry)
1363 (aset entry (match-beginning 0) ?\n )))
1364 (let ((diary-entry (diary-sexp-entry sexp entry date))
1365 temp)
1366 (setq entry (if (consp diary-entry)
1367 (cdr diary-entry)
1368 diary-entry))
1369 (if diary-entry
1370 (progn
1371 (subst-char-in-region line-start (point) ?\^M ?\n t)
1372 (if (< 0 (length entry))
1373 (setq temp (diary-pull-attrs entry file-glob-attrs)
1374 entry (nth 0 temp)
1375 marks (nth 1 temp)))))
1376 (add-to-diary-list date
1377 entry
1378 specifier
1379 (if entry-start (copy-marker entry-start)
1380 nil)
1381 marks)
1382 (setq entry-found (or entry-found diary-entry)))))
1383 entry-found))
1384
1385 (defun diary-sexp-entry (sexp entry date)
1386 "Process a SEXP diary ENTRY for DATE."
1387 (let ((result (if calendar-debug-sexp
1388 (let ((stack-trace-on-error t))
1389 (eval (car (read-from-string sexp))))
1390 (condition-case nil
1391 (eval (car (read-from-string sexp)))
1392 (error
1393 (beep)
1394 (message "Bad sexp at line %d in %s: %s"
1395 (save-excursion
1396 (save-restriction
1397 (narrow-to-region 1 (point))
1398 (goto-char (point-min))
1399 (let ((lines 1))
1400 (while (re-search-forward "\n\\|\^M" nil t)
1401 (setq lines (1+ lines)))
1402 lines)))
1403 diary-file sexp)
1404 (sleep-for 2))))))
1405 (cond ((stringp result) result)
1406 ((and (consp result)
1407 (stringp (cdr result))) result)
1408 (result entry)
1409 (t nil))))
1410
1411 (defun diary-date (month day year &optional mark)
1412 "Specific date(s) diary entry.
1413 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1414 and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR
1415 can be lists of integers, the constant t, or an integer. The constant t means
1416 all values.
1417
1418 An optional parameter MARK specifies a face or single-character string to
1419 use when highlighting the day in the calendar."
1420 (let ((dd (if european-calendar-style
1421 month
1422 day))
1423 (mm (if european-calendar-style
1424 day
1425 month))
1426 (m (extract-calendar-month date))
1427 (y (extract-calendar-year date))
1428 (d (extract-calendar-day date)))
1429 (if (and
1430 (or (and (listp dd) (memq d dd))
1431 (equal d dd)
1432 (eq dd t))
1433 (or (and (listp mm) (memq m mm))
1434 (equal m mm)
1435 (eq mm t))
1436 (or (and (listp year) (memq y year))
1437 (equal y year)
1438 (eq year t)))
1439 (cons mark entry))))
1440
1441 (defun diary-block (m1 d1 y1 m2 d2 y2 &optional mark)
1442 "Block diary entry.
1443 Entry applies if date is between, or on one of, two dates.
1444 The order of the parameters is
1445 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1446 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t.
1447
1448 An optional parameter MARK specifies a face or single-character string to
1449 use when highlighting the day in the calendar."
1450
1451 (let ((date1 (calendar-absolute-from-gregorian
1452 (if european-calendar-style
1453 (list d1 m1 y1)
1454 (list m1 d1 y1))))
1455 (date2 (calendar-absolute-from-gregorian
1456 (if european-calendar-style
1457 (list d2 m2 y2)
1458 (list m2 d2 y2))))
1459 (d (calendar-absolute-from-gregorian date)))
1460 (if (and (<= date1 d) (<= d date2))
1461 (cons mark entry))))
1462
1463 (defun diary-float (month dayname n &optional day mark)
1464 "Floating diary entry--entry applies if date is the nth dayname of month.
1465 Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant
1466 t, or an integer. The constant t means all months. If N is negative, count
1467 backward from the end of the month.
1468
1469 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY.
1470 Optional MARK specifies a face or single-character string to use when
1471 highlighting the day in the calendar."
1472 ;; This is messy because the diary entry may apply, but the date on which it
1473 ;; is based can be in a different month/year. For example, asking for the
1474 ;; first Monday after December 30. For large values of |n| the problem is
1475 ;; more grotesque.
1476 (and (= dayname (calendar-day-of-week date))
1477 (let* ((m (extract-calendar-month date))
1478 (d (extract-calendar-day date))
1479 (y (extract-calendar-year date))
1480 (limit; last (n>0) or first (n<0) possible base date for entry
1481 (calendar-nth-named-absday (- n) dayname m y d))
1482 (last-abs (if (> n 0) limit (+ limit 6)))
1483 (first-abs (if (> n 0) (- limit 6) limit))
1484 (last (calendar-gregorian-from-absolute last-abs))
1485 (first (calendar-gregorian-from-absolute first-abs))
1486 ; m1, d1 is first possible base date
1487 (m1 (extract-calendar-month first))
1488 (d1 (extract-calendar-day first))
1489 (y1 (extract-calendar-year first))
1490 ; m2, d2 is last possible base date
1491 (m2 (extract-calendar-month last))
1492 (d2 (extract-calendar-day last))
1493 (y2 (extract-calendar-year last)))
1494 (if (or (and (= m1 m2) ; only possible base dates in one month
1495 (or (eq month t)
1496 (if (listp month)
1497 (memq m1 month)
1498 (= m1 month)))
1499 (let ((d (or day (if (> n 0)
1500 1
1501 (calendar-last-day-of-month m1 y1)))))
1502 (and (<= d1 d) (<= d d2))))
1503 ;; only possible base dates straddle two months
1504 (and (or (< y1 y2)
1505 (and (= y1 y2) (< m1 m2)))
1506 (or
1507 ;; m1, d1 works as a base date
1508 (and
1509 (or (eq month t)
1510 (if (listp month)
1511 (memq m1 month)
1512 (= m1 month)))
1513 (<= d1 (or day (if (> n 0)
1514 1
1515 (calendar-last-day-of-month m1 y1)))))
1516 ;; m2, d2 works as a base date
1517 (and (or (eq month t)
1518 (if (listp month)
1519 (memq m2 month)
1520 (= m2 month)))
1521 (<= (or day (if (> n 0)
1522 1
1523 (calendar-last-day-of-month m2 y2)))
1524 d2)))))
1525 (cons mark entry)))))
1526
1527
1528 (defun diary-anniversary (month day year &optional mark)
1529 "Anniversary diary entry.
1530 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1531 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1532 `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
1533 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1534 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1535 `rd' or `th', as appropriate. The anniversary of February 29 is considered
1536 to be March 1 in non-leap years.
1537
1538 An optional parameter MARK specifies a face or single-character string to
1539 use when highlighting the day in the calendar."
1540 (let* ((d (if european-calendar-style
1541 month
1542 day))
1543 (m (if european-calendar-style
1544 day
1545 month))
1546 (y (extract-calendar-year date))
1547 (diff (- y year)))
1548 (if (and (= m 2) (= d 29) (not (calendar-leap-year-p y)))
1549 (setq m 3
1550 d 1))
1551 (if (and (> diff 0) (calendar-date-equal (list m d y) date))
1552 (cons mark (format entry diff (diary-ordinal-suffix diff))))))
1553
1554 (defun diary-cyclic (n month day year &optional mark)
1555 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1556 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1557 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1558 repetitions since the MONTH DAY, YEAR and %s will be replaced by the
1559 ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
1560 appropriate.
1561
1562 An optional parameter MARK specifies a face or single-character string to
1563 use when highlighting the day in the calendar."
1564 (let* ((d (if european-calendar-style
1565 month
1566 day))
1567 (m (if european-calendar-style
1568 day
1569 month))
1570 (diff (- (calendar-absolute-from-gregorian date)
1571 (calendar-absolute-from-gregorian
1572 (list m d year))))
1573 (cycle (/ diff n)))
1574 (if (and (>= diff 0) (zerop (% diff n)))
1575 (cons mark (format entry cycle (diary-ordinal-suffix cycle))))))
1576
1577 (defun diary-ordinal-suffix (n)
1578 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1579 (if (or (memq (% n 100) '(11 12 13))
1580 (< 3 (% n 10)))
1581 "th"
1582 (aref ["th" "st" "nd" "rd"] (% n 10))))
1583
1584 (defun diary-day-of-year ()
1585 "Day of year and number of days remaining in the year of date diary entry."
1586 (calendar-day-of-year-string date))
1587
1588 (defcustom diary-remind-message
1589 '("Reminder: Only "
1590 (if (= 0 (% days 7))
1591 (concat (int-to-string (/ days 7)) (if (= 7 days) " week" " weeks"))
1592 (concat (int-to-string days) (if (= 1 days) " day" " days")))
1593 " until "
1594 diary-entry)
1595 "*Pseudo-pattern giving form of reminder messages in the fancy diary
1596 display.
1597
1598 Used by the function `diary-remind', a pseudo-pattern is a list of
1599 expressions that can involve the keywords `days' (a number), `date' (a list of
1600 month, day, year), and `diary-entry' (a string)."
1601 :type 'sexp
1602 :group 'diary)
1603
1604 (defun diary-remind (sexp days &optional marking)
1605 "Provide a reminder of a diary entry.
1606 SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
1607 indicating the number(s) of days before the event that the warning(s) should
1608 occur on. If the current date is (one of) DAYS before the event indicated by
1609 SEXP, then a suitable message (as specified by `diary-remind-message' is
1610 returned.
1611
1612 In addition to the reminders beforehand, the diary entry also appears on the
1613 date itself.
1614
1615 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1616 entry specifies that the diary entry (not the reminder) is non-marking.
1617 Marking of reminders is independent of whether the entry itself is a marking
1618 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1619 marked on the calendar."
1620 (let ((diary-entry (eval sexp)))
1621 (cond
1622 ;; Diary entry applies on date
1623 ((and diary-entry
1624 (or (not marking-diary-entries) marking-diary-entry))
1625 diary-entry)
1626 ;; Diary entry may apply to `days' before date
1627 ((and (integerp days)
1628 (not diary-entry); Diary entry does not apply to date
1629 (or (not marking-diary-entries) marking))
1630 (let ((date (calendar-gregorian-from-absolute
1631 (+ (calendar-absolute-from-gregorian date) days))))
1632 (when (setq diary-entry (eval sexp)) ; re-evaluate with adjusted date
1633 ;; Discard any mark portion from diary-anniversary, etc.
1634 (if (consp diary-entry) (setq diary-entry (cdr diary-entry)))
1635 (mapconcat 'eval diary-remind-message ""))))
1636 ;; Diary entry may apply to one of a list of days before date
1637 ((and (listp days) days)
1638 (or (diary-remind sexp (car days) marking)
1639 (diary-remind sexp (cdr days) marking))))))
1640
1641 (defun add-to-diary-list (date string specifier marker &optional globcolor)
1642 "Add the entry (DATE STRING SPECIFIER MARKER GLOBCOLOR) to `diary-entries-list'.
1643 Do nothing if DATE or STRING is nil."
1644 (when (and date string)
1645 (if diary-file-name-prefix
1646 (let ((prefix (funcall diary-file-name-prefix-function
1647 (buffer-file-name))))
1648 (or (string= prefix "")
1649 (setq string (format "[%s] %s" prefix string)))))
1650 (setq diary-entries-list
1651 (append diary-entries-list
1652 (list (list date string specifier marker globcolor))))))
1653
1654 (defun diary-redraw-calendar ()
1655 "If `calendar-buffer' is live and diary entries are marked, redraw it."
1656 (and mark-diary-entries-in-calendar
1657 (redraw-calendar))
1658 ;; Return value suitable for `write-contents-functions'.
1659 nil)
1660
1661 (defun make-diary-entry (string &optional nonmarking file)
1662 "Insert a diary entry STRING which may be NONMARKING in FILE.
1663 If omitted, NONMARKING defaults to nil and FILE defaults to
1664 `diary-file'. Adds `diary-redraw-calendar' to
1665 `write-contents-functions' for FILE, so that the calendar will be
1666 redrawn with the new entry marked, if necessary."
1667 (let ((pop-up-frames (window-dedicated-p (selected-window))))
1668 (find-file-other-window (substitute-in-file-name (or file diary-file))))
1669 (add-hook 'write-contents-functions 'diary-redraw-calendar nil t)
1670 (when selective-display
1671 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
1672 (setq selective-display nil)
1673 (kill-local-variable 'mode-line-format))
1674 (widen)
1675 (goto-char (point-max))
1676 (when (let ((case-fold-search t))
1677 (search-backward "Local Variables:"
1678 (max (- (point-max) 3000) (point-min))
1679 t))
1680 (beginning-of-line)
1681 (insert "\n")
1682 (previous-line 1))
1683 (insert
1684 (if (bolp) "" "\n")
1685 (if nonmarking diary-nonmarking-symbol "")
1686 string " "))
1687
1688 (defun insert-diary-entry (arg)
1689 "Insert a diary entry for the date indicated by point.
1690 Prefix arg will make the entry nonmarking."
1691 (interactive "P")
1692 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t t)
1693 arg))
1694
1695 (defun insert-weekly-diary-entry (arg)
1696 "Insert a weekly diary entry for the day of the week indicated by point.
1697 Prefix arg will make the entry nonmarking."
1698 (interactive "P")
1699 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t))
1700 arg))
1701
1702 (defun insert-monthly-diary-entry (arg)
1703 "Insert a monthly diary entry for the day of the month indicated by point.
1704 Prefix arg will make the entry nonmarking."
1705 (interactive "P")
1706 (let ((calendar-date-display-form
1707 (if european-calendar-style
1708 '(day " * ")
1709 '("* " day))))
1710 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1711 arg)))
1712
1713 (defun insert-yearly-diary-entry (arg)
1714 "Insert an annual diary entry for the day of the year indicated by point.
1715 Prefix arg will make the entry nonmarking."
1716 (interactive "P")
1717 (let ((calendar-date-display-form
1718 (if european-calendar-style
1719 '(day " " monthname)
1720 '(monthname " " day))))
1721 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1722 arg)))
1723
1724 (defun insert-anniversary-diary-entry (arg)
1725 "Insert an anniversary diary entry for the date given by point.
1726 Prefix arg will make the entry nonmarking."
1727 (interactive "P")
1728 (let ((calendar-date-display-form
1729 (if european-calendar-style
1730 '(day " " month " " year)
1731 '(month " " day " " year))))
1732 (make-diary-entry
1733 (format "%s(diary-anniversary %s)"
1734 sexp-diary-entry-symbol
1735 (calendar-date-string (calendar-cursor-to-date t) nil t))
1736 arg)))
1737
1738 (defun insert-block-diary-entry (arg)
1739 "Insert a block diary entry for the days between the point and marked date.
1740 Prefix arg will make the entry nonmarking."
1741 (interactive "P")
1742 (let ((calendar-date-display-form
1743 (if european-calendar-style
1744 '(day " " month " " year)
1745 '(month " " day " " year)))
1746 (cursor (calendar-cursor-to-date t))
1747 (mark (or (car calendar-mark-ring)
1748 (error "No mark set in this buffer")))
1749 start end)
1750 (if (< (calendar-absolute-from-gregorian mark)
1751 (calendar-absolute-from-gregorian cursor))
1752 (setq start mark
1753 end cursor)
1754 (setq start cursor
1755 end mark))
1756 (make-diary-entry
1757 (format "%s(diary-block %s %s)"
1758 sexp-diary-entry-symbol
1759 (calendar-date-string start nil t)
1760 (calendar-date-string end nil t))
1761 arg)))
1762
1763 (defun insert-cyclic-diary-entry (arg)
1764 "Insert a cyclic diary entry starting at the date given by point.
1765 Prefix arg will make the entry nonmarking."
1766 (interactive "P")
1767 (let ((calendar-date-display-form
1768 (if european-calendar-style
1769 '(day " " month " " year)
1770 '(month " " day " " year))))
1771 (make-diary-entry
1772 (format "%s(diary-cyclic %d %s)"
1773 sexp-diary-entry-symbol
1774 (calendar-read "Repeat every how many days: "
1775 (lambda (x) (> x 0)))
1776 (calendar-date-string (calendar-cursor-to-date t) nil t))
1777 arg)))
1778
1779 ;;;###autoload
1780 (define-derived-mode diary-mode fundamental-mode
1781 "Diary"
1782 "Major mode for editing the diary file."
1783 (set (make-local-variable 'font-lock-defaults)
1784 '(diary-font-lock-keywords t)))
1785
1786 (define-derived-mode fancy-diary-display-mode fundamental-mode
1787 "Diary"
1788 "Major mode used while displaying diary entries using Fancy Display."
1789 (set (make-local-variable 'font-lock-defaults)
1790 '(fancy-diary-font-lock-keywords t))
1791 (define-key (current-local-map) "q" 'quit-window))
1792
1793
1794 (defvar fancy-diary-font-lock-keywords
1795 (list
1796 (cons
1797 (concat
1798 (let ((dayname (diary-name-pattern calendar-day-name-array nil t))
1799 (monthname (diary-name-pattern calendar-month-name-array nil t))
1800 (day "[0-9]+")
1801 (month "[0-9]+")
1802 (year "-?[0-9]+"))
1803 (mapconcat 'eval calendar-date-display-form ""))
1804 "\\(\\(: .*\\)\\|\\(\n +.*\\)\\)*\n=+$")
1805 'diary-face)
1806 '("^.*anniversary.*$" . font-lock-keyword-face)
1807 '("^.*birthday.*$" . font-lock-keyword-face)
1808 '("^.*Yahrzeit.*$" . font-lock-reference-face)
1809 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face)
1810 '("^Day.*omer.*$" . font-lock-builtin-face)
1811 '("^Parashat.*$" . font-lock-comment-face)
1812 '("^[ \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\\)?\\)?"
1813 . font-lock-variable-name-face))
1814 "Keywords to highlight in fancy diary display")
1815
1816
1817 (defun font-lock-diary-sexps (limit)
1818 "Recognize sexp diary entry for font-locking."
1819 (if (re-search-forward
1820 (concat "^" (regexp-quote diary-nonmarking-symbol)
1821 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)")
1822 limit t)
1823 (condition-case nil
1824 (save-restriction
1825 (narrow-to-region (point-min) limit)
1826 (let ((start (point)))
1827 (forward-sexp 1)
1828 (store-match-data (list start (point)))
1829 t))
1830 (error t))))
1831
1832 (defun font-lock-diary-date-forms (month-array &optional symbol abbrev-array)
1833 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY.
1834 If given, optional SYMBOL must be a prefix to entries.
1835 If optional ABBREV-ARRAY is present, the abbreviations constructed
1836 from this array by the function `calendar-abbrev-construct' are
1837 matched (with or without a final `.'), in addition to the full month
1838 names."
1839 (let ((dayname (diary-name-pattern calendar-day-name-array
1840 calendar-day-abbrev-array t))
1841 (monthname (format "\\(%s\\|\\*\\)"
1842 (diary-name-pattern month-array abbrev-array)))
1843 (month "\\([0-9]+\\|\\*\\)")
1844 (day "\\([0-9]+\\|\\*\\)")
1845 (year "-?\\([0-9]+\\|\\*\\)"))
1846 (mapcar '(lambda (x)
1847 (cons
1848 (concat "^" (regexp-quote diary-nonmarking-symbol) "?"
1849 (if symbol (regexp-quote symbol) "") "\\("
1850 (mapconcat 'eval
1851 ;; If backup, omit first item (backup)
1852 ;; and last item (not part of date)
1853 (if (equal (car x) 'backup)
1854 (reverse (cdr (reverse (cdr x))))
1855 x)
1856 "")
1857 ;; With backup, last item is not part of date
1858 (if (equal (car x) 'backup)
1859 (concat "\\)" (eval (car (reverse x))))
1860 "\\)"))
1861 '(1 diary-face)))
1862 diary-date-forms)))
1863
1864 (eval-when-compile (require 'cal-hebrew)
1865 (require 'cal-islam))
1866
1867 (defvar diary-font-lock-keywords
1868 (append
1869 (font-lock-diary-date-forms calendar-month-name-array
1870 nil calendar-month-abbrev-array)
1871 (when (or (memq 'mark-hebrew-diary-entries
1872 nongregorian-diary-marking-hook)
1873 (memq 'list-hebrew-diary-entries
1874 nongregorian-diary-listing-hook))
1875 (require 'cal-hebrew)
1876 (font-lock-diary-date-forms
1877 calendar-hebrew-month-name-array-leap-year
1878 hebrew-diary-entry-symbol))
1879 (when (or (memq 'mark-islamic-diary-entries
1880 nongregorian-diary-marking-hook)
1881 (memq 'list-islamic-diary-entries
1882 nongregorian-diary-listing-hook))
1883 (require 'cal-islam)
1884 (font-lock-diary-date-forms
1885 calendar-islamic-month-name-array
1886 islamic-diary-entry-symbol))
1887 (list
1888 (cons
1889 (concat "^" (regexp-quote diary-include-string) ".*$")
1890 'font-lock-keyword-face)
1891 (cons
1892 (concat "^" (regexp-quote diary-nonmarking-symbol)
1893 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)")
1894 '(1 font-lock-reference-face))
1895 (cons
1896 (concat "^" (regexp-quote diary-nonmarking-symbol))
1897 'font-lock-reference-face)
1898 (cons
1899 (concat "^" (regexp-quote diary-nonmarking-symbol)
1900 "?\\(" (regexp-quote hebrew-diary-entry-symbol) "\\)")
1901 '(1 font-lock-reference-face))
1902 (cons
1903 (concat "^" (regexp-quote diary-nonmarking-symbol)
1904 "?\\(" (regexp-quote islamic-diary-entry-symbol) "\\)")
1905 '(1 font-lock-reference-face))
1906 '(font-lock-diary-sexps . font-lock-keyword-face)
1907 '("[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\(-[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\)?"
1908 . font-lock-function-name-face)))
1909 "Forms to highlight in diary-mode")
1910
1911
1912 ;; Following code from Dave Love <fx@gnu.org>.
1913 ;; Import Outlook-format appointments from mail messages in Gnus or
1914 ;; Rmail using command `diary-from-outlook'. This, or the specialized
1915 ;; functions `diary-from-outlook-gnus' and `diary-from-outlook-rmail',
1916 ;; could be run from hooks to notice appointments automatically (in
1917 ;; which case they will prompt about adding to the diary). The
1918 ;; message formats recognized are customizable through
1919 ;; `diary-outlook-formats'.
1920
1921 (defcustom diary-outlook-formats
1922 '(
1923 ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
1924 ;; [Current UK format? The timezone is meaningless. Sometimes the
1925 ;; Where is missing.]
1926 ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
1927 \\([^ ]+\\) [^\n]+
1928 \[^\n]+
1929 \\(?:Where: \\([^\n]+\\)\n+\\)?
1930 \\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
1931 . "\\1\n \\2 %s, \\3")
1932 ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
1933 ;; [Old UK format?]
1934 ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
1935 \\([^ ]+\\) [^\n]+
1936 \[^\n]+
1937 \\(?:Where: \\([^\n]+\\)\\)?\n+"
1938 . "\\2 \\1 \\3\n \\4 %s, \\5")
1939 (
1940 ;; German format, apparently.
1941 "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
1942 . "\\1 \\2 \\3\n \\4 %s"))
1943 "Alist of regexps matching message text and replacement text.
1944
1945 The regexp must match the start of the message text containing an
1946 appointment, but need not include a leading `^'. If it matches the
1947 current message, a diary entry is made from the corresponding
1948 template. If the template is a string, it should be suitable for
1949 passing to `replace-match', and so will have occurrences of `\\D' to
1950 substitute the match for the Dth subexpression. It must also contain
1951 a single `%s' which will be replaced with the text of the message's
1952 Subject field. Any other `%' characters must be doubled, so that the
1953 template can be passed to `format'.
1954
1955 If the template is actually a function, it is called with the message
1956 body text as argument, and may use `match-string' etc. to make a
1957 template following the rules above."
1958 :type '(alist :key-type (regexp :tag "Regexp matching time/place")
1959 :value-type (choice
1960 (string :tag "Template for entry")
1961 (function :tag "Unary function providing template")))
1962 :version "22.1"
1963 :group 'diary)
1964
1965
1966 ;; Dynamically bound.
1967 (defvar body)
1968 (defvar subject)
1969
1970 (defun diary-from-outlook-internal (&optional test-only)
1971 "Snarf a diary entry from a message assumed to be from MS Outlook.
1972 Assumes `body' is bound to a string comprising the body of the message and
1973 `subject' is bound to a string comprising its subject.
1974 Arg TEST-ONLY non-nil means return non-nil if and only if the
1975 message contains an appointment, don't make a diary entry."
1976 (catch 'finished
1977 (let (format-string)
1978 (dotimes (i (length diary-outlook-formats))
1979 (when (eq 0 (string-match (car (nth i diary-outlook-formats))
1980 body))
1981 (unless test-only
1982 (setq format-string (cdr (nth i diary-outlook-formats)))
1983 (save-excursion
1984 (save-window-excursion
1985 ;; Fixme: References to optional fields in the format
1986 ;; are treated literally, not replaced by the empty
1987 ;; string. I think this is an Emacs bug.
1988 (make-diary-entry
1989 (format (replace-match (if (functionp format-string)
1990 (funcall format-string body)
1991 format-string)
1992 t nil (match-string 0 body))
1993 subject))
1994 (save-buffer))))
1995 (throw 'finished t))))
1996 nil))
1997
1998 (defun diary-from-outlook (&optional noconfirm)
1999 "Maybe snarf diary entry from current Outlook-generated message.
2000 Currently knows about Gnus and Rmail modes. Unless the optional
2001 argument NOCONFIRM is non-nil (which is the case when this
2002 function is called interactively), then if an entry is found the
2003 user is asked to confirm its addition."
2004 (interactive "p")
2005 (let ((func (cond
2006 ((eq major-mode 'rmail-mode)
2007 #'diary-from-outlook-rmail)
2008 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
2009 #'diary-from-outlook-gnus)
2010 (t (error "Don't know how to snarf in `%s'" major-mode)))))
2011 (funcall func noconfirm)))
2012
2013
2014 (defvar gnus-article-mime-handles)
2015 (defvar gnus-article-buffer)
2016
2017 (autoload 'gnus-fetch-field "gnus-util")
2018 (autoload 'gnus-narrow-to-body "gnus")
2019 (autoload 'mm-get-part "mm-decode")
2020
2021 (defun diary-from-outlook-gnus (&optional noconfirm)
2022 "Maybe snarf diary entry from Outlook-generated message in Gnus.
2023 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2024 this function is called interactively), then if an entry is found the
2025 user is asked to confirm its addition.
2026 Add this function to `gnus-article-prepare-hook' to notice appointments
2027 automatically."
2028 (interactive "p")
2029 (with-current-buffer gnus-article-buffer
2030 (let ((subject (gnus-fetch-field "subject"))
2031 (body (if gnus-article-mime-handles
2032 ;; We're multipart. Don't get confused by part
2033 ;; buttons &c. Assume info is in first part.
2034 (mm-get-part (nth 1 gnus-article-mime-handles))
2035 (save-restriction
2036 (gnus-narrow-to-body)
2037 (buffer-string)))))
2038 (when (diary-from-outlook-internal t)
2039 (when (or noconfirm (y-or-n-p "Snarf diary entry? "))
2040 (diary-from-outlook-internal)
2041 (message "Diary entry added"))))))
2042
2043 (custom-add-option 'gnus-article-prepare-hook 'diary-from-outlook-gnus)
2044
2045
2046 (defvar rmail-buffer)
2047
2048 (defun diary-from-outlook-rmail (&optional noconfirm)
2049 "Maybe snarf diary entry from Outlook-generated message in Rmail.
2050 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2051 this function is called interactively), then if an entry is found the
2052 user is asked to confirm its addition."
2053 (interactive "p")
2054 (with-current-buffer rmail-buffer
2055 (let ((subject (mail-fetch-field "subject"))
2056 (body (buffer-substring (save-excursion
2057 (rfc822-goto-eoh)
2058 (point))
2059 (point-max))))
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"))))))
2064
2065
2066 (provide 'diary-lib)
2067
2068 ;;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010
2069 ;;; diary-lib.el ends here