1 ;;; diary-lib.el --- diary functions
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995 Free Software
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This collection of functions implements the diary features as described
31 ;; Comments, corrections, and improvements should be sent to
32 ;; Edward M. Reingold Department of Computer Science
33 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
34 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
35 ;; Urbana, Illinois 61801
42 (defun diary (&optional arg
)
43 "Generate the diary window for ARG days starting with the current date.
44 If no argument is provided, the number of days of diary entries is governed
45 by the variable `number-of-diary-entries'. This function is suitable for
46 execution in a `.emacs' file."
48 (let ((d-file (substitute-in-file-name diary-file
))
49 (date (calendar-current-date)))
50 (if (and d-file
(file-exists-p d-file
))
51 (if (file-readable-p d-file
)
55 (arg (prefix-numeric-value arg
))
56 ((vectorp number-of-diary-entries
)
57 (aref number-of-diary-entries
(calendar-day-of-week date
)))
58 (t number-of-diary-entries
)))
59 (error "Your diary file is not readable!"))
60 (error "You don't have a diary file!"))))
62 (defun view-diary-entries (arg)
63 "Prepare and display a buffer with diary entries.
64 Searches the file named in `diary-file' for entries that
65 match ARG days starting with the date indicated by the cursor position
66 in the displayed three-month calendar."
68 (let ((d-file (substitute-in-file-name diary-file
)))
69 (if (and d-file
(file-exists-p d-file
))
70 (if (file-readable-p d-file
)
71 (list-diary-entries (calendar-cursor-to-date t
) arg
)
72 (error "Diary file is not readable!"))
73 (error "You don't have a diary file!"))))
75 (defun view-other-diary-entries (arg d-file
)
76 "Prepare and display buffer of diary entries from an alternative diary file.
77 Prompts for a file name and searches that file for entries that match ARG
78 days starting with the date indicated by the cursor position in the displayed
79 three-month calendar."
81 (list (cond ((null current-prefix-arg
) 1)
82 ((listp current-prefix-arg
) (car current-prefix-arg
))
83 (t current-prefix-arg
))
84 (read-file-name "Enter diary file name: " default-directory nil t
)))
85 (let ((diary-file d-file
))
86 (view-diary-entries arg
)))
88 (autoload 'check-calendar-holidays
"holidays"
89 "Check the list of holidays for any that occur on DATE.
90 The value returned is a list of strings of relevant holiday descriptions.
91 The holidays are those in the list `calendar-holidays'."
94 (autoload 'calendar-holiday-list
"holidays"
95 "Form the list of holidays that occur on dates in the calendar window.
96 The holidays are those in the list `calendar-holidays'."
99 (autoload 'diary-french-date
"cal-french"
100 "French calendar equivalent of date diary entry."
103 (autoload 'diary-mayan-date
"cal-mayan"
104 "Mayan calendar equivalent of date diary entry."
107 (autoload 'diary-iso-date
"cal-iso"
108 "ISO calendar equivalent of date diary entry."
111 (autoload 'diary-julian-date
"cal-julian"
112 "Julian calendar equivalent of date diary entry."
115 (autoload 'diary-astro-day-number
"cal-julian"
116 "Astronomical (Julian) day number diary entry."
119 (autoload 'diary-chinese-date
"cal-china"
120 "Chinese calendar equivalent of date diary entry."
123 (autoload 'diary-islamic-date
"cal-islam"
124 "Islamic calendar equivalent of date diary entry."
127 (autoload 'list-islamic-diary-entries
"cal-islam"
128 "Add any Islamic date entries from the diary file to `diary-entries-list'."
131 (autoload 'mark-islamic-diary-entries
"cal-islam"
132 "Mark days in the calendar window that have Islamic date diary entries."
135 (autoload 'mark-islamic-calendar-date-pattern
"cal-islam"
136 "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR."
139 (autoload 'diary-hebrew-date
"cal-hebrew"
140 "Hebrew calendar equivalent of date diary entry."
143 (autoload 'diary-omer
"cal-hebrew"
144 "Omer count diary entry."
147 (autoload 'diary-yahrzeit
"cal-hebrew"
148 "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before."
151 (autoload 'diary-parasha
"cal-hebrew"
152 "Parasha diary entry--entry applies if date is a Saturday."
155 (autoload 'diary-rosh-hodesh
"cal-hebrew"
156 "Rosh Hodesh diary entry."
159 (autoload 'list-hebrew-diary-entries
"cal-hebrew"
160 "Add any Hebrew date entries from the diary file to `diary-entries-list'."
163 (autoload 'mark-hebrew-diary-entries
"cal-hebrew"
164 "Mark days in the calendar window that have Hebrew date diary entries."
167 (autoload 'mark-hebrew-calendar-date-pattern
"cal-hebrew"
168 "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR."
171 (autoload 'diary-coptic-date
"cal-coptic"
172 "Coptic calendar equivalent of date diary entry."
175 (autoload 'diary-ethiopic-date
"cal-coptic"
176 "Ethiopic calendar equivalent of date diary entry."
179 (autoload 'diary-persian-date
"cal-persia"
180 "Persian calendar equivalent of date diary entry."
183 (autoload 'diary-phases-of-moon
"lunar" "Moon phases diary entry." t
)
185 (autoload 'diary-sunrise-sunset
"solar"
186 "Local time of sunrise and sunset as a diary entry."
189 (autoload 'diary-sabbath-candles
"solar"
190 "Local time of candle lighting diary entry--applies if date is a Friday.
191 No diary entry if there is no sunset on that date."
194 (defvar diary-syntax-table
(copy-syntax-table (standard-syntax-table))
195 "The syntax table used when parsing dates in the diary file.
196 It is the standard syntax table used in Fundamental mode, but with the
197 syntax of `*' changed to be a word constituent.")
199 (modify-syntax-entry ?
* "w" diary-syntax-table
)
200 (modify-syntax-entry ?
: "w" diary-syntax-table
)
202 (defun list-diary-entries (date number
)
203 "Create and display a buffer containing the relevant lines in diary-file.
204 The arguments are DATE and NUMBER; the entries selected are those
205 for NUMBER days starting with date DATE. The other entries are hidden
206 using selective display.
208 Returns a list of all relevant diary entries found, if any, in order by date.
209 The list entries have the form ((month day year) string specifier) where
210 \(month day year) is the date of the entry, string is the entry text, and
211 specifier is the applicability. If the variable `diary-list-include-blanks'
212 is t, this list includes a dummy diary entry consisting of the empty string)
213 for a date with no diary entries.
215 After the list is prepared, the hooks `nongregorian-diary-listing-hook',
216 `list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
217 These hooks have the following distinct roles:
219 `nongregorian-diary-listing-hook' can cull dates from the diary
220 and each included file. Usually used for Hebrew or Islamic
221 diary entries in files. Applied to *each* file.
223 `list-diary-entries-hook' adds or manipulates diary entries from
224 external sources. Used, for example, to include diary entries
225 from other files or to sort the diary entries. Invoked *once* only,
226 before the display hook is run.
228 `diary-display-hook' does the actual display of information. If this is
229 nil, simple-diary-display will be used. Use add-hook to set this to
230 fancy-diary-display, if desired. If you want no diary display, use
231 add-hook to set this to ignore.
233 `diary-hook' is run last. This can be used for an appointment
234 notification function."
237 (let* ((original-date date
);; save for possible use in the hooks
238 (old-diary-syntax-table)
240 (date-string (calendar-date-string date
))
241 (d-file (substitute-in-file-name diary-file
)))
242 (message "Preparing diary...")
244 (let ((diary-buffer (find-buffer-visiting d-file
)))
245 (if (not diary-buffer
)
246 (set-buffer (find-file-noselect d-file t
))
247 (set-buffer diary-buffer
)
248 (or (verify-visited-file-modtime diary-buffer
)
249 (revert-buffer t t
))))
250 (setq selective-display t
)
251 (setq selective-display-ellipses nil
)
252 (setq old-diary-syntax-table
(syntax-table))
253 (set-syntax-table diary-syntax-table
)
255 (let ((buffer-read-only nil
)
256 (diary-modified (buffer-modified-p))
257 (mark (regexp-quote diary-nonmarking-symbol
)))
258 ;; First and last characters must be ^M or \n for
259 ;; selective display to work properly
260 (goto-char (1- (point-max)))
261 (if (not (looking-at "\^M\\|\n"))
263 (goto-char (point-max))
265 (goto-char (point-min))
266 (if (not (looking-at "\^M\\|\n"))
268 (subst-char-in-region (point-min) (point-max) ?
\n ?\^M t
)
269 (calendar-for-loop i from
1 to number do
270 (let ((d diary-date-forms
)
271 (month (extract-calendar-month date
))
272 (day (extract-calendar-day date
))
273 (year (extract-calendar-year date
))
274 (entry-found (list-sexp-diary-entries date
)))
277 ((date-form (if (equal (car (car d
)) 'backup
)
280 (backup (equal (car (car d
)) 'backup
))
283 (calendar-day-name date
) "\\|"
284 (substring (calendar-day-name date
) 0 3) ".?"))
288 (calendar-month-name month
) "\\|"
289 (substring (calendar-month-name month
) 0 3) ".?"))
290 (month (concat "\\*\\|0*" (int-to-string month
)))
291 (day (concat "\\*\\|0*" (int-to-string day
)))
294 "\\*\\|0*" (int-to-string year
)
295 (if abbreviated-calendar-year
296 (concat "\\|" (format "%02d" (% year
100)))
300 "\\(\\`\\|\^M\\|\n\\)" mark
"?\\("
301 (mapconcat 'eval date-form
"\\)\\(")
303 (case-fold-search t
))
304 (goto-char (point-min))
305 (while (re-search-forward regexp nil t
)
306 (if backup
(re-search-backward "\\<" nil t
))
307 (if (and (or (char-equal (preceding-char) ?\^M
)
308 (char-equal (preceding-char) ?
\n))
309 (not (looking-at " \\|\^I")))
310 ;; Diary entry that consists only of date.
312 ;; Found a nonempty diary entry--make it visible and
313 ;; add it to the list.
315 (let ((entry-start (point))
317 (re-search-backward "\^M\\|\n\\|\\`")
318 (setq date-start
(point))
319 (re-search-forward "\^M\\|\n" nil t
2)
320 (while (looking-at " \\|\^I")
321 (re-search-forward "\^M\\|\n" nil t
))
323 (subst-char-in-region date-start
327 (buffer-substring-no-properties
329 (buffer-substring-no-properties
330 (1+ date-start
) (1- entry-start
)))))))
333 (not diary-list-include-blanks
)
334 (setq diary-entries-list
335 (append diary-entries-list
336 (list (list date
"" "")))))
338 (calendar-gregorian-from-absolute
339 (1+ (calendar-absolute-from-gregorian date
))))
340 (setq entry-found nil
)))
341 (set-buffer-modified-p diary-modified
))
342 (set-syntax-table old-diary-syntax-table
))
343 (goto-char (point-min))
344 (run-hooks 'nongregorian-diary-listing-hook
345 'list-diary-entries-hook
)
346 (if diary-display-hook
347 (run-hooks 'diary-display-hook
)
348 (simple-diary-display))
349 (run-hooks 'diary-hook
)
350 diary-entries-list
))))
352 (defun include-other-diary-files ()
353 "Include the diary entries from other diary files with those of diary-file.
354 This function is suitable for use in `list-diary-entries-hook';
355 it enables you to use shared diary files together with your own.
356 The files included are specified in the diaryfile by lines of this form:
357 #include \"filename\"
358 This is recursive; that is, #include directives in diary files thus included
359 are obeyed. You can change the `#include' to some other string by
360 changing the variable `diary-include-string'."
361 (goto-char (point-min))
362 (while (re-search-forward
364 "\\(\\`\\|\^M\\|\n\\)"
365 (regexp-quote diary-include-string
)
368 (let* ((diary-file (substitute-in-file-name
369 (buffer-substring-no-properties
370 (match-beginning 2) (match-end 2))))
371 (diary-list-include-blanks nil
)
372 (list-diary-entries-hook 'include-other-diary-files
)
373 (diary-display-hook 'ignore
)
375 (d-buffer (find-buffer-visiting diary-file
))
376 (diary-modified (if d-buffer
378 (set-buffer d-buffer
)
379 (buffer-modified-p)))))
380 (if (file-exists-p diary-file
)
381 (if (file-readable-p diary-file
)
383 (setq diary-entries-list
384 (append diary-entries-list
385 (list-diary-entries original-date number
)))
387 (set-buffer (find-buffer-visiting diary-file
))
388 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
389 (setq selective-display nil
)
390 (set-buffer-modified-p diary-modified
)))
392 (message "Can't read included diary file %s" diary-file
)
395 (message "Can't find included diary file %s" diary-file
)
397 (goto-char (point-min)))
399 (defun simple-diary-display ()
400 "Display the diary buffer if there are any relevant entries or holidays."
401 (let* ((holiday-list (if holidays-in-diary-buffer
402 (check-calendar-holidays original-date
)))
403 (msg (format "No diary entries for %s %s"
404 (concat date-string
(if holiday-list
":" ""))
405 (mapconcat 'identity holiday-list
"; "))))
406 (calendar-set-mode-line
407 (concat "Diary for " date-string
408 (if holiday-list
": " "")
409 (mapconcat 'identity holiday-list
"; ")))
410 (if (or (not diary-entries-list
)
411 (and (not (cdr diary-entries-list
))
412 (string-equal (car (cdr (car diary-entries-list
))) "")))
413 (if (<= (length msg
) (frame-width))
415 (set-buffer (get-buffer-create holiday-buffer
))
416 (setq buffer-read-only nil
)
417 (calendar-set-mode-line date-string
)
419 (insert (mapconcat 'identity holiday-list
"\n"))
420 (goto-char (point-min))
421 (set-buffer-modified-p nil
)
422 (setq buffer-read-only t
)
423 (display-buffer holiday-buffer
)
424 (message "No diary entries for %s" date-string
))
425 (display-buffer (find-buffer-visiting d-file
))
426 (message "Preparing diary...done"))))
428 (defun fancy-diary-display ()
429 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
430 This function is provided for optional use as the `diary-display-hook'."
431 (save-excursion;; Turn off selective-display in the diary file's buffer.
432 (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file
)))
433 (let ((diary-modified (buffer-modified-p)))
434 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
435 (setq selective-display nil
)
436 (kill-local-variable 'mode-line-format
)
437 (set-buffer-modified-p diary-modified
)))
438 (if (or (not diary-entries-list
)
439 (and (not (cdr diary-entries-list
))
440 (string-equal (car (cdr (car diary-entries-list
))) "")))
441 (let* ((holiday-list (if holidays-in-diary-buffer
442 (check-calendar-holidays original-date
)))
443 (msg (format "No diary entries for %s %s"
444 (concat date-string
(if holiday-list
":" ""))
445 (mapconcat 'identity holiday-list
"; "))))
446 (if (<= (length msg
) (frame-width))
448 (set-buffer (get-buffer-create holiday-buffer
))
449 (setq buffer-read-only nil
)
450 (calendar-set-mode-line date-string
)
452 (insert (mapconcat 'identity holiday-list
"\n"))
453 (goto-char (point-min))
454 (set-buffer-modified-p nil
)
455 (setq buffer-read-only t
)
456 (display-buffer holiday-buffer
)
457 (message "No diary entries for %s" date-string
)))
458 (save-excursion;; Prepare the fancy diary buffer.
459 (set-buffer (make-fancy-diary-buffer))
460 (setq buffer-read-only nil
)
461 (let ((entry-list diary-entries-list
)
463 (holiday-list-last-month 1)
464 (holiday-list-last-year 1)
467 (if (not (calendar-date-equal date
(car (car entry-list
))))
469 (setq date
(car (car entry-list
)))
470 (and holidays-in-diary-buffer
471 (calendar-date-compare
472 (list (list holiday-list-last-month
473 (calendar-last-day-of-month
474 holiday-list-last-month
475 holiday-list-last-year
)
476 holiday-list-last-year
))
478 ;; We need to get the holidays for the next 3 months.
479 (setq holiday-list-last-month
480 (extract-calendar-month date
))
481 (setq holiday-list-last-year
482 (extract-calendar-year date
))
483 (increment-calendar-month
484 holiday-list-last-month holiday-list-last-year
1)
486 (let ((displayed-month holiday-list-last-month
)
487 (displayed-year holiday-list-last-year
))
488 (calendar-holiday-list)))
489 (increment-calendar-month
490 holiday-list-last-month holiday-list-last-year
1))
491 (let* ((date-string (calendar-date-string date
))
493 (let ((h holiday-list
)
495 ;; Make a list of all holidays for date.
497 (if (calendar-date-equal date
(car (car h
)))
498 (setq d
(append d
(cdr (car h
)))))
501 (insert (if (= (point) (point-min)) "" ?
\n) date-string
)
502 (if date-holiday-list
(insert ": "))
503 (let* ((l (current-column))
505 (insert (mapconcat (lambda (x)
506 (if (< longest
(length x
))
507 (setq longest
(length x
)))
510 (concat "\n" (make-string l ?
))))
511 (insert ?
\n (make-string (+ l longest
) ?
=) ?
\n)))))
512 (if (< 0 (length (car (cdr (car entry-list
)))))
513 (insert (car (cdr (car entry-list
))) ?
\n))
514 (setq entry-list
(cdr entry-list
))))
515 (set-buffer-modified-p nil
)
516 (goto-char (point-min))
517 (setq buffer-read-only t
)
518 (display-buffer fancy-diary-buffer
)
519 (message "Preparing diary...done"))))
521 (defun make-fancy-diary-buffer ()
522 "Create and return the initial fancy diary buffer."
524 (set-buffer (get-buffer-create fancy-diary-buffer
))
525 (setq buffer-read-only nil
)
526 (make-local-variable 'mode-line-format
)
527 (calendar-set-mode-line "Diary Entries")
529 (set-buffer-modified-p nil
)
530 (setq buffer-read-only t
)
531 (get-buffer fancy-diary-buffer
)))
533 (defun print-diary-entries ()
534 "Print a hard copy of the diary display.
536 If the simple diary display is being used, prepare a temp buffer with the
537 visible lines of the diary buffer, add a heading line composed from the mode
538 line, print the temp buffer, and destroy it.
540 If the fancy diary display is being used, just print the buffer.
542 The hooks given by the variable `print-diary-entries-hook' are called to do
543 the actual printing."
545 (if (bufferp (get-buffer fancy-diary-buffer
))
547 (set-buffer (get-buffer fancy-diary-buffer
))
548 (run-hooks 'print-diary-entries-hook
))
550 (find-buffer-visiting (substitute-in-file-name diary-file
))))
552 (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
555 (set-buffer diary-buffer
)
557 (if (not (stringp mode-line-format
))
559 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format
)
560 (substring mode-line-format
561 (match-beginning 1) (match-end 1))))
562 (copy-to-buffer temp-buffer
(point-min) (point-max))
563 (set-buffer temp-buffer
)
564 (while (re-search-forward "\^M.*$" nil t
)
566 (goto-char (point-min))
568 (make-string (length heading
) ?
=) "\n")
569 (run-hooks 'print-diary-entries-hook
)
570 (kill-buffer temp-buffer
)))
571 (error "You don't have a diary buffer!")))))
573 (defun show-all-diary-entries ()
574 "Show all of the diary entries in the diary file.
575 This function gets rid of the selective display of the diary file so that
576 all entries, not just some, are visible. If there is no diary buffer, one
579 (let ((d-file (substitute-in-file-name diary-file
)))
580 (if (and d-file
(file-exists-p d-file
))
581 (if (file-readable-p d-file
)
583 (let ((diary-buffer (find-buffer-visiting d-file
)))
584 (set-buffer (if diary-buffer
586 (find-file-noselect d-file t
)))
587 (let ((buffer-read-only nil
)
588 (diary-modified (buffer-modified-p)))
589 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
590 (setq selective-display nil
)
591 (make-local-variable 'mode-line-format
)
592 (setq mode-line-format default-mode-line-format
)
593 (display-buffer (current-buffer))
594 (set-buffer-modified-p diary-modified
))))
595 (error "Your diary file is not readable!"))
596 (error "You don't have a diary file!"))))
600 (defcustom diary-mail-addr
601 (if (boundp 'user-mail-address
) user-mail-address nil
)
602 "*Email address that `diary-mail-entries' will send email to."
604 :type
'(choice string
(const nil
))
607 (defcustom diary-mail-days
7
608 "*Number of days for `diary-mail-entries' to check."
614 (defun diary-mail-entries (&optional ndays
)
615 "Send a mail message showing diary entries for next NDAYS days.
616 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
618 You can call `diary-mail-entries' every night using an at/cron job.
619 For example, this script will run the program at 2am daily. Since
620 `emacs -batch' does not load your `.emacs' file, you must ensure that
621 all relevant variables are set, as done here.
624 # diary-rem.sh -- repeatedly run the Emacs diary-reminder
626 -eval \"(setq diary-mail-days 3 \\
627 european-calendar-style t \\
628 diary-mail-addr \\\"user@host.name\\\" )\" \\
629 -l diary-lib -f diary-mail-entries
630 at -f diary-rem.sh 0200 tomorrow
632 You may have to tweak the syntax of the `at' command to suit your
633 system. Alternatively, you can specify a cron entry:
634 0 1 * * * diary-rem.sh
635 to run it every morning at 1am."
637 (let* ((diary-display-hook 'fancy-diary-display
)
638 (diary-list-include-blanks t
)
639 (text (progn (list-diary-entries (calendar-current-date)
640 (if ndays ndays diary-mail-days
))
641 (set-buffer fancy-diary-buffer
)
642 (buffer-substring (point-min) (point-max)))))
644 (mail-to) (insert diary-mail-addr
)
645 (mail-subject) (insert "Diary entries generated "
646 (calendar-date-string (calendar-current-date)))
647 (mail-text) (insert text
)
648 (mail-send-and-exit nil
)))
651 (defun diary-name-pattern (string-array &optional fullname
)
652 "Convert an STRING-ARRAY, an array of strings to a pattern.
653 The pattern will match any of the strings, either entirely or abbreviated
654 to three characters. An abbreviated form will match with or without a period;
655 If the optional FULLNAME is t, abbreviations will not match, just the full
658 (calendar-for-loop i from
0 to
(1- (length string-array
)) do
662 (if (string-equal pattern
"") "" "\\|")
663 (aref string-array i
)
668 (substring (aref string-array i
) 0 3) ".?")))))
671 (defvar marking-diary-entries nil
672 "True during the marking of diary entries, nil otherwise.")
674 (defvar marking-diary-entry nil
675 "True during the marking of diary entries, if current entry is marking.")
677 (defun mark-diary-entries ()
678 "Mark days in the calendar window that have diary entries.
679 Each entry in the diary file visible in the calendar window is marked.
680 After the entries are marked, the hooks `nongregorian-diary-marking-hook' and
681 `mark-diary-entries-hook' are run."
683 (setq mark-diary-entries-in-calendar t
)
684 (let ((d-file (substitute-in-file-name diary-file
))
685 (marking-diary-entries t
))
686 (if (and d-file
(file-exists-p d-file
))
687 (if (file-readable-p d-file
)
689 (message "Marking diary entries...")
690 (set-buffer (find-file-noselect d-file t
))
691 (let ((d diary-date-forms
)
692 (old-diary-syntax-table))
693 (setq old-diary-syntax-table
(syntax-table))
694 (set-syntax-table diary-syntax-table
)
697 ((date-form (if (equal (car (car d
)) 'backup
)
699 (car d
)));; ignore 'backup directive
700 (dayname (diary-name-pattern calendar-day-name-array
))
703 (diary-name-pattern calendar-month-name-array
)
705 (month "[0-9]+\\|\\*")
707 (year "[0-9]+\\|\\*")
708 (l (length date-form
))
709 (d-name-pos (- l
(length (memq 'dayname date-form
))))
710 (d-name-pos (if (/= l d-name-pos
) (+ 2 d-name-pos
)))
711 (m-name-pos (- l
(length (memq 'monthname date-form
))))
712 (m-name-pos (if (/= l m-name-pos
) (+ 2 m-name-pos
)))
713 (d-pos (- l
(length (memq 'day date-form
))))
714 (d-pos (if (/= l d-pos
) (+ 2 d-pos
)))
715 (m-pos (- l
(length (memq 'month date-form
))))
716 (m-pos (if (/= l m-pos
) (+ 2 m-pos
)))
717 (y-pos (- l
(length (memq 'year date-form
))))
718 (y-pos (if (/= l y-pos
) (+ 2 y-pos
)))
721 "\\(\\`\\|\^M\\|\n\\)\\("
722 (mapconcat 'eval date-form
"\\)\\(")
724 (case-fold-search t
))
725 (goto-char (point-min))
726 (while (re-search-forward regexp nil t
)
729 (buffer-substring-no-properties
730 (match-beginning d-name-pos
)
731 (match-end d-name-pos
))))
734 (buffer-substring-no-properties
735 (match-beginning m-name-pos
)
736 (match-end m-name-pos
))))
739 (buffer-substring-no-properties
740 (match-beginning m-pos
)
745 (buffer-substring-no-properties
746 (match-beginning d-pos
)
750 (buffer-substring-no-properties
751 (match-beginning y-pos
)
755 (if (and (= (length y-str
) 2)
756 abbreviated-calendar-year
)
758 (extract-calendar-year
759 (calendar-current-date)))
760 (y (+ (string-to-int y-str
)
762 (/ current-y
100)))))
763 (if (> (- y current-y
) 50)
765 (if (> (- current-y y
) 50)
768 (string-to-int y-str
)))))
770 (mark-calendar-days-named
771 (cdr (assoc-ignore-case
772 (substring dd-name
0 3)
774 calendar-day-name-array
776 (lambda (x) (substring x
0 3))))))
778 (if (string-equal mm-name
"*")
781 (cdr (assoc-ignore-case
782 (substring mm-name
0 3)
784 calendar-month-name-array
786 (lambda (x) (substring x
0 3)))
788 (mark-calendar-date-pattern mm dd yy
))))
790 (mark-sexp-diary-entries)
791 (run-hooks 'nongregorian-diary-marking-hook
792 'mark-diary-entries-hook
)
793 (set-syntax-table old-diary-syntax-table
)
794 (message "Marking diary entries...done")))
795 (error "Your diary file is not readable!"))
796 (error "You don't have a diary file!"))))
798 (defun mark-sexp-diary-entries ()
799 "Mark days in the calendar window that have sexp diary entries.
800 Each entry in the diary file (or included files) visible in the calendar window
801 is marked. See the documentation for the function `list-sexp-diary-entries'."
802 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol
))
803 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
804 (regexp-quote sexp-mark
) "(\\)\\|\\("
805 (regexp-quote diary-nonmarking-symbol
)
806 (regexp-quote sexp-mark
) "(diary-remind\\)"))
812 (set-buffer calendar-buffer
)
813 (setq m displayed-month
)
814 (setq y displayed-year
))
815 (increment-calendar-month m y -
1)
817 (calendar-absolute-from-gregorian (list m
1 y
)))
818 (increment-calendar-month m y
2)
820 (calendar-absolute-from-gregorian
821 (list m
(calendar-last-day-of-month m y
) y
)))
822 (goto-char (point-min))
823 (while (re-search-forward s-entry nil t
)
824 (if (char-equal (preceding-char) ?\
()
825 (setq marking-diary-entry t
)
826 (setq marking-diary-entry nil
))
827 (re-search-backward "(")
828 (let ((sexp-start (point))
834 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
836 (re-search-backward "\^M\\|\n\\|\\`")
837 (setq line-start
(point)))
839 (if (and (or (char-equal (preceding-char) ?\^M
)
840 (char-equal (preceding-char) ?
\n))
841 (not (looking-at " \\|\^I")))
842 (progn;; Diary entry consists only of the sexp
845 (setq entry-start
(point))
847 (re-search-forward "\^M\\|\n" nil t
)
848 (while (looking-at " \\|\^I")
849 (or (re-search-forward "\^M\\|\n" nil t
)
850 (re-search-forward "$" nil t
)))
851 (if (or (char-equal (preceding-char) ?\^M
)
852 (char-equal (preceding-char) ?
\n))
854 (setq entry
(buffer-substring-no-properties entry-start
(point)))
855 (while (string-match "[\^M]" entry
)
856 (aset entry
(match-beginning 0) ?
\n )))
857 (calendar-for-loop date from first-date to last-date do
858 (if (diary-sexp-entry sexp entry
859 (calendar-gregorian-from-absolute date
))
860 (mark-visible-calendar-date
861 (calendar-gregorian-from-absolute date
))))))))
863 (defun mark-included-diary-files ()
864 "Mark the diary entries from other diary files with those of the diary file.
865 This function is suitable for use as the `mark-diary-entries-hook'; it enables
866 you to use shared diary files together with your own. The files included are
867 specified in the diary-file by lines of this form:
868 #include \"filename\"
869 This is recursive; that is, #include directives in diary files thus included
870 are obeyed. You can change the `#include' to some other string by
871 changing the variable `diary-include-string'."
872 (goto-char (point-min))
873 (while (re-search-forward
875 "\\(\\`\\|\^M\\|\n\\)"
876 (regexp-quote diary-include-string
)
879 (let ((diary-file (substitute-in-file-name
880 (buffer-substring-no-properties
881 (match-beginning 2) (match-end 2))))
882 (mark-diary-entries-hook 'mark-included-diary-files
))
883 (if (file-exists-p diary-file
)
884 (if (file-readable-p diary-file
)
887 (kill-buffer (find-buffer-visiting diary-file
)))
889 (message "Can't read included diary file %s" diary-file
)
892 (message "Can't find included diary file %s" diary-file
)
894 (goto-char (point-min)))
896 (defun mark-calendar-days-named (dayname)
897 "Mark all dates in the calendar window that are day DAYNAME of the week.
898 0 means all Sundays, 1 means all Mondays, and so on."
900 (set-buffer calendar-buffer
)
901 (let ((prev-month displayed-month
)
902 (prev-year displayed-year
)
903 (succ-month displayed-month
)
904 (succ-year displayed-year
)
907 (increment-calendar-month succ-month succ-year
1)
908 (increment-calendar-month prev-month prev-year -
1)
909 (setq day
(calendar-absolute-from-gregorian
910 (calendar-nth-named-day 1 dayname prev-month prev-year
)))
911 (setq last-day
(calendar-absolute-from-gregorian
912 (calendar-nth-named-day -
1 dayname succ-month succ-year
)))
913 (while (<= day last-day
)
914 (mark-visible-calendar-date (calendar-gregorian-from-absolute day
))
915 (setq day
(+ day
7))))))
917 (defun mark-calendar-date-pattern (month day year
)
918 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
919 A value of 0 in any position is a wildcard."
921 (set-buffer calendar-buffer
)
922 (let ((m displayed-month
)
924 (increment-calendar-month m y -
1)
925 (calendar-for-loop i from
0 to
2 do
926 (mark-calendar-month m y month day year
)
927 (increment-calendar-month m y
1)))))
929 (defun mark-calendar-month (month year p-month p-day p-year
)
930 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
931 A value of 0 in any position of the pattern is a wildcard."
932 (if (or (and (= month p-month
)
933 (or (= p-year
0) (= year p-year
)))
935 (or (= p-year
0) (= year p-year
))))
938 i from
1 to
(calendar-last-day-of-month month year
) do
939 (mark-visible-calendar-date (list month i year
)))
940 (mark-visible-calendar-date (list month p-day year
)))))
942 (defun sort-diary-entries ()
943 "Sort the list of diary entries by time of day."
944 (setq diary-entries-list
(sort diary-entries-list
'diary-entry-compare
)))
946 (defun diary-entry-compare (e1 e2
)
947 "Returns t if E1 is earlier than E2."
948 (or (calendar-date-compare e1 e2
)
949 (and (calendar-date-equal (car e1
) (car e2
))
950 (let* ((ts1 (cadr e1
)) (t1 (diary-entry-time ts1
))
951 (ts2 (cadr e2
)) (t2 (diary-entry-time ts2
)))
954 (string-lessp ts1 ts2
)))))))
956 (defcustom diary-unknown-time
958 "*Value returned by diary-entry-time when no time is found.
959 The default value -9999 causes entries with no recognizable time to be placed
960 before those with times; 9999 would place entries with no recognizable time
961 after those with times."
966 (defun diary-entry-time (s)
967 "Time at the beginning of the string S in a military-style integer. For
968 example, returns 1325 for 1:25pm. Returns `diary-unknown-time' (default value
969 -9999) if no time is recognized. The recognized forms are XXXX, X:XX, or
970 XX:XX (military time), and XXam, XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm,
972 (let ((case-fold-search nil
))
973 (cond ((string-match ; Military time
974 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\):?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)" s
)
975 (+ (* 100 (string-to-int
976 (substring s
(match-beginning 1) (match-end 1))))
977 (string-to-int (substring s
(match-beginning 2) (match-end 2)))))
978 ((string-match ; Hour only XXam or XXpm
979 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s
)
980 (+ (* 100 (%
(string-to-int
981 (substring s
(match-beginning 1) (match-end 1)))
983 (if (equal ?a
(downcase (aref s
(match-beginning 2))))
985 ((string-match ; Hour and minute XX:XXam or XX:XXpm
986 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\):\\([0-9][0-9]\\)\\([ap]\\)m\\>" s
)
987 (+ (* 100 (%
(string-to-int
988 (substring s
(match-beginning 1) (match-end 1)))
990 (string-to-int (substring s
(match-beginning 2) (match-end 2)))
991 (if (equal ?a
(downcase (aref s
(match-beginning 3))))
993 (t diary-unknown-time
)))) ; Unrecognizable
995 (defun list-sexp-diary-entries (date)
996 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
997 Also, Make them visible in the diary file. Returns t if any entries were
1000 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
1001 `%%'). The form of a sexp diary entry is
1005 Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
1006 SEXP yields the value nil, the diary entry does not apply. If it yields a
1007 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1008 string, that string will be the diary entry in the fancy diary display.
1010 For example, the following diary entry will apply to the 21st of the month
1011 if it is a weekday and the Friday before if the 21st is on a weekend:
1013 &%%(let ((dayname (calendar-day-of-week date))
1014 (day (extract-calendar-day date)))
1016 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1017 (and (memq day '(19 20)) (= dayname 5)))
1018 ) UIUC pay checks deposited
1020 A number of built-in functions are available for this type of diary entry:
1022 %%(diary-date MONTH DAY YEAR) text
1023 Entry applies if date is MONTH, DAY, YEAR if
1024 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1025 `european-calendar-style' is t. DAY, MONTH, and YEAR
1026 can be lists of integers, the constant t, or an integer.
1027 The constant t means all values.
1029 %%(diary-float MONTH DAYNAME N &optional DAY) text
1030 Entry will appear on the Nth DAYNAME of MONTH.
1031 (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1032 if N is negative it counts backward from the end of
1033 the month. MONTH can be a list of months, a single
1034 month, or t to specify all months. Optional DAY means
1035 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
1036 to 1 if N>0 and the last day of the month if N<0.
1038 %%(diary-block M1 D1 Y1 M2 D2 Y2) text
1039 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1040 inclusive. (If `european-calendar-style' is t, the
1041 order of the parameters should be changed to D1, M1, Y1,
1044 %%(diary-anniversary MONTH DAY YEAR) text
1045 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1046 (If `european-calendar-style' is t, the order of the
1047 parameters should be changed to DAY, MONTH, YEAR.) Text
1048 can contain %d or %d%s; %d will be replaced by the number
1049 of years since the MONTH DAY, YEAR and %s will be replaced
1050 by the ordinal ending of that number (that is, `st', `nd',
1051 `rd' or `th', as appropriate. The anniversary of February
1052 29 is considered to be March 1 in a non-leap year.
1054 %%(diary-cyclic N MONTH DAY YEAR) text
1055 Entry will appear every N days, starting MONTH DAY, YEAR.
1056 (If `european-calendar-style' is t, the order of the
1057 parameters should be changed to N, DAY, MONTH, YEAR.) Text
1058 can contain %d or %d%s; %d will be replaced by the number
1059 of repetitions since the MONTH DAY, YEAR and %s will
1060 be replaced by the ordinal ending of that number (that is,
1061 `st', `nd', `rd' or `th', as appropriate.
1063 %%(diary-remind SEXP DAYS &optional MARKING) text
1064 Entry is a reminder for diary sexp SEXP. DAYS is either a
1065 single number or a list of numbers indicating the number(s)
1066 of days before the event that the warning(s) should occur.
1067 If the current date is (one of) DAYS before the event
1068 indicated by EXPR, then a suitable message (as specified
1069 by `diary-remind-message') appears. In addition to the
1070 reminders beforehand, the diary entry also appears on
1071 the date itself. If optional MARKING is non-nil then the
1072 *reminders* are marked on the calendar. Marking of
1073 reminders is independent of whether the entry *itself* is
1074 a marking or nonmarking one.
1076 %%(diary-day-of-year)
1077 Diary entries giving the day of the year and the number of
1078 days remaining in the year will be made every day. Note
1079 that since there is no text, it makes sense only if the
1080 fancy diary display is used.
1083 Diary entries giving the corresponding ISO commercial date
1084 will be made every day. Note that since there is no text,
1085 it makes sense only if the fancy diary display is used.
1087 %%(diary-french-date)
1088 Diary entries giving the corresponding French Revolutionary
1089 date will be made every day. Note that since there is no
1090 text, it makes sense only if the fancy diary display is used.
1092 %%(diary-islamic-date)
1093 Diary entries giving the corresponding Islamic date will be
1094 made every day. Note that since there is no text, it
1095 makes sense only if the fancy diary display is used.
1097 %%(diary-hebrew-date)
1098 Diary entries giving the corresponding Hebrew date will be
1099 made every day. Note that since there is no text, it
1100 makes sense only if the fancy diary display is used.
1102 %%(diary-astro-day-number) Diary entries giving the corresponding
1103 astronomical (Julian) day number will be made every day.
1104 Note that since there is no text, it makes sense only if the
1105 fancy diary display is used.
1107 %%(diary-julian-date) Diary entries giving the corresponding
1108 Julian date will be made every day. Note that since
1109 there is no text, it makes sense only if the fancy diary
1112 %%(diary-sunrise-sunset)
1113 Diary entries giving the local times of sunrise and sunset
1114 will be made every day. Note that since there is no text,
1115 it makes sense only if the fancy diary display is used.
1116 Floating point required.
1118 %%(diary-phases-of-moon)
1119 Diary entries giving the times of the phases of the moon
1120 will be when appropriate. Note that since there is no text,
1121 it makes sense only if the fancy diary display is used.
1122 Floating point required.
1124 %%(diary-yahrzeit MONTH DAY YEAR) text
1125 Text is assumed to be the name of the person; the date is
1126 the date of death on the *civil* calendar. The diary entry
1127 will appear on the proper Hebrew-date anniversary and on the
1128 day before. (If `european-calendar-style' is t, the order
1129 of the parameters should be changed to DAY, MONTH, YEAR.)
1131 %%(diary-rosh-hodesh)
1132 Diary entries will be made on the dates of Rosh Hodesh on
1133 the Hebrew calendar. Note that since there is no text, it
1134 makes sense only if the fancy diary display is used.
1137 Diary entries giving the weekly parasha will be made on
1138 every Saturday. Note that since there is no text, it
1139 makes sense only if the fancy diary display is used.
1142 Diary entries giving the omer count will be made every day
1143 from Passover to Shavuot. Note that since there is no text,
1144 it makes sense only if the fancy diary display is used.
1146 Marking these entries is *extremely* time consuming, so these entries are
1147 best if they are nonmarking."
1148 (let* ((mark (regexp-quote diary-nonmarking-symbol
))
1149 (sexp-mark (regexp-quote sexp-diary-entry-symbol
))
1150 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)" mark
"?" sexp-mark
"("))
1152 (goto-char (point-min))
1153 (while (re-search-forward s-entry nil t
)
1155 (let ((sexp-start (point))
1162 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
1164 (re-search-backward "\^M\\|\n\\|\\`")
1165 (setq line-start
(point)))
1167 (buffer-substring-no-properties (1+ line-start
) (point)))
1169 (if (and (or (char-equal (preceding-char) ?\^M
)
1170 (char-equal (preceding-char) ?
\n))
1171 (not (looking-at " \\|\^I")))
1172 (progn;; Diary entry consists only of the sexp
1175 (setq entry-start
(point))
1176 (re-search-forward "\^M\\|\n" nil t
)
1177 (while (looking-at " \\|\^I")
1178 (re-search-forward "\^M\\|\n" nil t
))
1180 (setq entry
(buffer-substring-no-properties entry-start
(point)))
1181 (while (string-match "[\^M]" entry
)
1182 (aset entry
(match-beginning 0) ?
\n )))
1183 (let ((diary-entry (diary-sexp-entry sexp entry date
)))
1185 (subst-char-in-region line-start
(point) ?\^M ?
\n t
))
1186 (add-to-diary-list date diary-entry specifier
)
1187 (setq entry-found
(or entry-found diary-entry
)))))
1190 (defun diary-sexp-entry (sexp entry date
)
1191 "Process a SEXP diary ENTRY for DATE."
1192 (let ((result (if calendar-debug-sexp
1193 (let ((stack-trace-on-error t
))
1194 (eval (car (read-from-string sexp
))))
1196 (eval (car (read-from-string sexp
)))
1199 (message "Bad sexp at line %d in %s: %s"
1202 (narrow-to-region 1 (point))
1203 (goto-char (point-min))
1205 (while (re-search-forward "\n\\|\^M" nil t
)
1206 (setq lines
(1+ lines
)))
1210 (if (stringp result
)
1216 (defun diary-date (month day year
)
1217 "Specific date(s) diary entry.
1218 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1219 and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR
1220 can be lists of integers, the constant t, or an integer. The constant t means
1222 (let* ((dd (if european-calendar-style
1225 (mm (if european-calendar-style
1228 (m (extract-calendar-month date
))
1229 (y (extract-calendar-year date
))
1230 (d (extract-calendar-day date
)))
1232 (or (and (listp dd
) (memq d dd
))
1235 (or (and (listp mm
) (memq m mm
))
1238 (or (and (listp year
) (memq y year
))
1243 (defun diary-block (m1 d1 y1 m2 d2 y2
)
1245 Entry applies if date is between two dates. Order of the parameters is
1246 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1247 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t."
1248 (let ((date1 (calendar-absolute-from-gregorian
1249 (if european-calendar-style
1252 (date2 (calendar-absolute-from-gregorian
1253 (if european-calendar-style
1256 (d (calendar-absolute-from-gregorian date
)))
1257 (if (and (<= date1 d
) (<= d date2
))
1260 (defun diary-float (month dayname n
&optional day
)
1261 "Floating diary entry--entry applies if date is the nth dayname of month.
1262 Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant
1263 t, or an integer. The constant t means all months. If N is negative, count
1264 backward from the end of the month.
1266 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY."
1267 ;; This is messy because the diary entry may apply, but the date on which it
1268 ;; is based can be in a different month/year. For example, asking for the
1269 ;; first Monday after December 30. For large values of |n| the problem is
1271 (and (= dayname
(calendar-day-of-week date
))
1272 (let* ((m (extract-calendar-month date
))
1273 (d (extract-calendar-day date
))
1274 (y (extract-calendar-year date
))
1275 (limit; last (n>0) or first (n<0) possible base date for entry
1276 (calendar-nth-named-absday (- n
) dayname m y d
))
1277 (last-abs (if (> n
0) limit
(+ limit
6)))
1278 (first-abs (if (> n
0) (- limit
6) limit
))
1279 (last (calendar-gregorian-from-absolute last-abs
))
1280 (first (calendar-gregorian-from-absolute first-abs
))
1281 ; m1, d1 is first possible base date
1282 (m1 (extract-calendar-month first
))
1283 (d1 (extract-calendar-day first
))
1284 (y1 (extract-calendar-year first
))
1285 ; m2, d2 is last possible base date
1286 (m2 (extract-calendar-month last
))
1287 (d2 (extract-calendar-day last
))
1288 (y2 (extract-calendar-year last
)))
1289 (if (or (and (= m1 m2
) ; only possible base dates in one month
1294 (let ((d (or day
(if (> n
0)
1296 (calendar-last-day-of-month m1 y1
)))))
1297 (and (<= d1 d
) (<= d d2
))))
1298 ;; only possible base dates straddle two months
1300 (and (= y1 y2
) (< m1 m2
)))
1302 ;; m1, d1 works as a base date
1308 (<= d1
(or day
(if (> n
0)
1310 (calendar-last-day-of-month m1 y1
)))))
1311 ;; m2, d2 works as a base date
1312 (and (or (eq month t
)
1316 (<= (or day
(if (> n
0)
1318 (calendar-last-day-of-month m2 y2
)))
1323 (defun diary-anniversary (month day year
)
1324 "Anniversary diary entry.
1325 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1326 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1327 `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
1328 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1329 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1330 `rd' or `th', as appropriate. The anniversary of February 29 is considered
1331 to be March 1 in non-leap years."
1332 (let* ((d (if european-calendar-style
1335 (m (if european-calendar-style
1338 (y (extract-calendar-year date
))
1340 (if (and (= m
2) (= d
29) (not (calendar-leap-year-p y
)))
1343 (if (and (> diff
0) (calendar-date-equal (list m d y
) date
))
1344 (format entry diff
(diary-ordinal-suffix diff
)))))
1346 (defun diary-cyclic (n month day year
)
1347 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1348 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1349 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1350 repetitions since the MONTH DAY, YEAR and %s will be replaced by the
1351 ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
1353 (let* ((d (if european-calendar-style
1356 (m (if european-calendar-style
1359 (diff (- (calendar-absolute-from-gregorian date
)
1360 (calendar-absolute-from-gregorian
1363 (if (and (>= diff
0) (zerop (% diff n
)))
1364 (format entry cycle
(diary-ordinal-suffix cycle
)))))
1366 (defun diary-ordinal-suffix (n)
1367 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1368 (if (or (memq (% n
100) '(11 12 13))
1371 (aref ["th" "st" "nd" "rd"] (% n
10))))
1373 (defun diary-day-of-year ()
1374 "Day of year and number of days remaining in the year of date diary entry."
1375 (calendar-day-of-year-string date
))
1377 (defcustom diary-remind-message
1379 (if (= 0 (% days
7))
1380 (concat (int-to-string (/ days
7)) (if (= 7 days
) " week" " weeks"))
1381 (concat (int-to-string days
) (if (= 1 days
) " day" " days")))
1384 "*Pseudo-pattern giving form of reminder messages in the fancy diary
1387 Used by the function `diary-remind', a pseudo-pattern is a list of
1388 expressions that can involve the keywords `days' (a number), `date' (a list of
1389 month, day, year), and `diary-entry' (a string)."
1393 (defun diary-remind (sexp days
&optional marking
)
1394 "Provide a reminder of a diary entry.
1395 SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
1396 indicating the number(s) of days before the event that the warning(s) should
1397 occur on. If the current date is (one of) DAYS before the event indicated by
1398 SEXP, then a suitable message (as specified by `diary-remind-message' is
1401 In addition to the reminders beforehand, the diary entry also appears on the
1404 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1405 entry specifies that the diary entry (not the reminder) is non-marking.
1406 Marking of reminders is independent of whether the entry itself is a marking
1407 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1408 marked on the calendar."
1409 (let ((diary-entry (eval sexp
)))
1411 ;; Diary entry applies on date
1413 (or (not marking-diary-entries
) marking-diary-entry
))
1415 ;; Diary entry may apply to `days' before date
1416 ((and (integerp days
)
1417 (not diary-entry
); Diary entry does not apply to date
1418 (or (not marking-diary-entries
) marking
))
1419 (let ((date (calendar-gregorian-from-absolute
1420 (+ (calendar-absolute-from-gregorian date
) days
))))
1421 (if (setq diary-entry
(eval sexp
))
1422 (mapconcat 'eval diary-remind-message
""))))
1423 ;; Diary entry may apply to one of a list of days before date
1424 ((and (listp days
) days
)
1425 (or (diary-remind sexp
(car days
) marking
)
1426 (diary-remind sexp
(cdr days
) marking
))))))
1428 (defun add-to-diary-list (date string specifier
)
1429 "Add the entry (DATE STRING SPECIFIER) to `diary-entries-list'.
1430 Do nothing if DATE or STRING is nil."
1432 (setq diary-entries-list
1433 (append diary-entries-list
(list (list date string specifier
))))))
1435 (defun make-diary-entry (string &optional nonmarking file
)
1436 "Insert a diary entry STRING which may be NONMARKING in FILE.
1437 If omitted, NONMARKING defaults to nil and FILE defaults to diary-file."
1438 (find-file-other-window
1439 (substitute-in-file-name (if file file diary-file
)))
1440 (goto-char (point-max))
1443 (if nonmarking diary-nonmarking-symbol
"")
1446 (defun insert-diary-entry (arg)
1447 "Insert a diary entry for the date indicated by point.
1448 Prefix arg will make the entry nonmarking."
1450 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t t
)
1453 (defun insert-weekly-diary-entry (arg)
1454 "Insert a weekly diary entry for the day of the week indicated by point.
1455 Prefix arg will make the entry nonmarking."
1457 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t
))
1460 (defun insert-monthly-diary-entry (arg)
1461 "Insert a monthly diary entry for the day of the month indicated by point.
1462 Prefix arg will make the entry nonmarking."
1464 (let* ((calendar-date-display-form
1465 (if european-calendar-style
1468 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t
)
1471 (defun insert-yearly-diary-entry (arg)
1472 "Insert an annual diary entry for the day of the year indicated by point.
1473 Prefix arg will make the entry nonmarking."
1475 (let* ((calendar-date-display-form
1476 (if european-calendar-style
1477 '(day " " monthname
)
1478 '(monthname " " day
))))
1479 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t
)
1482 (defun insert-anniversary-diary-entry (arg)
1483 "Insert an anniversary diary entry for the date given by point.
1484 Prefix arg will make the entry nonmarking."
1486 (let* ((calendar-date-display-form
1487 (if european-calendar-style
1488 '(day " " month
" " year
)
1489 '(month " " day
" " year
))))
1491 (format "%s(diary-anniversary %s)"
1492 sexp-diary-entry-symbol
1493 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
1496 (defun insert-block-diary-entry (arg)
1497 "Insert a block diary entry for the days between the point and marked date.
1498 Prefix arg will make the entry nonmarking."
1500 (let* ((calendar-date-display-form
1501 (if european-calendar-style
1502 '(day " " month
" " year
)
1503 '(month " " day
" " year
)))
1504 (cursor (calendar-cursor-to-date t
))
1505 (mark (or (car calendar-mark-ring
)
1506 (error "No mark set in this buffer")))
1509 (if (< (calendar-absolute-from-gregorian mark
)
1510 (calendar-absolute-from-gregorian cursor
))
1516 (format "%s(diary-block %s %s)"
1517 sexp-diary-entry-symbol
1518 (calendar-date-string start nil t
)
1519 (calendar-date-string end nil t
))
1522 (defun insert-cyclic-diary-entry (arg)
1523 "Insert a cyclic diary entry starting at the date given by point.
1524 Prefix arg will make the entry nonmarking."
1526 (let* ((calendar-date-display-form
1527 (if european-calendar-style
1528 '(day " " month
" " year
)
1529 '(month " " day
" " year
))))
1531 (format "%s(diary-cyclic %d %s)"
1532 sexp-diary-entry-symbol
1533 (calendar-read "Repeat every how many days: "
1534 (lambda (x) (> x
0)))
1535 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
1538 (provide 'diary-lib
)
1540 ;;; diary-lib.el ends here