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 (goto-char (1- (point-max)))
259 (if (not (looking-at "\^M\\|\n"))
262 (insert-string "\^M")))
263 (goto-char (point-min))
264 (if (not (looking-at "\^M\\|\n"))
265 (insert-string "\^M"))
266 (subst-char-in-region (point-min) (point-max) ?
\n ?\^M t
)
267 (calendar-for-loop i from
1 to number do
268 (let ((d diary-date-forms
)
269 (month (extract-calendar-month date
))
270 (day (extract-calendar-day date
))
271 (year (extract-calendar-year date
))
272 (entry-found (list-sexp-diary-entries date
)))
275 ((date-form (if (equal (car (car d
)) 'backup
)
278 (backup (equal (car (car d
)) 'backup
))
281 (calendar-day-name date
) "\\|"
282 (substring (calendar-day-name date
) 0 3) ".?"))
286 (calendar-month-name month
) "\\|"
287 (substring (calendar-month-name month
) 0 3) ".?"))
288 (month (concat "\\*\\|0*" (int-to-string month
)))
289 (day (concat "\\*\\|0*" (int-to-string day
)))
292 "\\*\\|0*" (int-to-string year
)
293 (if abbreviated-calendar-year
294 (concat "\\|" (format "%02d" (% year
100)))
298 "\\(\\`\\|\^M\\|\n\\)" mark
"?\\("
299 (mapconcat 'eval date-form
"\\)\\(")
301 (case-fold-search t
))
302 (goto-char (point-min))
303 (while (re-search-forward regexp nil t
)
304 (if backup
(re-search-backward "\\<" nil t
))
305 (if (and (or (char-equal (preceding-char) ?\^M
)
306 (char-equal (preceding-char) ?
\n))
307 (not (looking-at " \\|\^I")))
308 ;; Diary entry that consists only of date.
310 ;; Found a nonempty diary entry--make it visible and
311 ;; add it to the list.
313 (let ((entry-start (point))
315 (re-search-backward "\^M\\|\n\\|\\`")
316 (setq date-start
(point))
317 (re-search-forward "\^M\\|\n" nil t
2)
318 (while (looking-at " \\|\^I")
319 (re-search-forward "\^M\\|\n" nil t
))
321 (subst-char-in-region date-start
325 (buffer-substring-no-properties
327 (buffer-substring-no-properties
328 (1+ date-start
) (1- entry-start
)))))))
331 (not diary-list-include-blanks
)
332 (setq diary-entries-list
333 (append diary-entries-list
334 (list (list date
"" "")))))
336 (calendar-gregorian-from-absolute
337 (1+ (calendar-absolute-from-gregorian date
))))
338 (setq entry-found nil
)))
339 (set-buffer-modified-p diary-modified
))
340 (set-syntax-table old-diary-syntax-table
))
341 (goto-char (point-min))
342 (run-hooks 'nongregorian-diary-listing-hook
343 'list-diary-entries-hook
)
344 (if diary-display-hook
345 (run-hooks 'diary-display-hook
)
346 (simple-diary-display))
347 (run-hooks 'diary-hook
)
348 diary-entries-list
))))
350 (defun include-other-diary-files ()
351 "Include the diary entries from other diary files with those of diary-file.
352 This function is suitable for use in `list-diary-entries-hook';
353 it enables you to use shared diary files together with your own.
354 The files included are specified in the diaryfile by lines of this form:
355 #include \"filename\"
356 This is recursive; that is, #include directives in diary files thus included
357 are obeyed. You can change the `#include' to some other string by
358 changing the variable `diary-include-string'."
359 (goto-char (point-min))
360 (while (re-search-forward
362 "\\(\\`\\|\^M\\|\n\\)"
363 (regexp-quote diary-include-string
)
366 (let ((diary-file (substitute-in-file-name
367 (buffer-substring-no-properties
368 (match-beginning 2) (match-end 2))))
369 (diary-list-include-blanks nil
)
370 (list-diary-entries-hook 'include-other-diary-files
)
371 (diary-display-hook 'ignore
)
373 (if (file-exists-p diary-file
)
374 (if (file-readable-p diary-file
)
376 (setq diary-entries-list
377 (append diary-entries-list
378 (list-diary-entries original-date number
)))
379 (kill-buffer (find-buffer-visiting diary-file
)))
381 (message "Can't read included diary file %s" diary-file
)
384 (message "Can't find included diary file %s" diary-file
)
386 (goto-char (point-min)))
388 (defun simple-diary-display ()
389 "Display the diary buffer if there are any relevant entries or holidays."
390 (let* ((holiday-list (if holidays-in-diary-buffer
391 (check-calendar-holidays original-date
)))
392 (msg (format "No diary entries for %s %s"
393 (concat date-string
(if holiday-list
":" ""))
394 (mapconcat 'identity holiday-list
"; "))))
395 (if (or (not diary-entries-list
)
396 (and (not (cdr diary-entries-list
))
397 (string-equal (car (cdr (car diary-entries-list
))) "")))
398 (if (<= (length msg
) (frame-width))
400 (set-buffer (get-buffer-create holiday-buffer
))
401 (setq buffer-read-only nil
)
402 (calendar-set-mode-line date-string
)
404 (insert (mapconcat 'identity holiday-list
"\n"))
405 (goto-char (point-min))
406 (set-buffer-modified-p nil
)
407 (setq buffer-read-only t
)
408 (display-buffer holiday-buffer
)
409 (message "No diary entries for %s" date-string
))
410 (calendar-set-mode-line
411 (concat "Diary for " date-string
412 (if holiday-list
": " "")
413 (mapconcat 'identity holiday-list
"; ")))
414 (display-buffer (find-buffer-visiting d-file
))
415 (message "Preparing diary...done"))))
417 (defun fancy-diary-display ()
418 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
419 This function is provided for optional use as the `diary-display-hook'."
420 (save-excursion;; Turn off selective-display in the diary file's buffer.
421 (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file
)))
422 (let ((diary-modified (buffer-modified-p)))
423 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
424 (setq selective-display nil
)
425 (kill-local-variable 'mode-line-format
)
426 (set-buffer-modified-p diary-modified
)))
427 (if (or (not diary-entries-list
)
428 (and (not (cdr diary-entries-list
))
429 (string-equal (car (cdr (car diary-entries-list
))) "")))
430 (let* ((holiday-list (if holidays-in-diary-buffer
431 (check-calendar-holidays original-date
)))
432 (msg (format "No diary entries for %s %s"
433 (concat date-string
(if holiday-list
":" ""))
434 (mapconcat 'identity holiday-list
"; "))))
435 (if (<= (length msg
) (frame-width))
437 (set-buffer (get-buffer-create holiday-buffer
))
438 (setq buffer-read-only nil
)
439 (calendar-set-mode-line date-string
)
441 (insert (mapconcat 'identity holiday-list
"\n"))
442 (goto-char (point-min))
443 (set-buffer-modified-p nil
)
444 (setq buffer-read-only t
)
445 (display-buffer holiday-buffer
)
446 (message "No diary entries for %s" date-string
)))
447 (save-excursion;; Prepare the fancy diary buffer.
448 (set-buffer (make-fancy-diary-buffer))
449 (setq buffer-read-only nil
)
450 (let ((entry-list diary-entries-list
)
452 (holiday-list-last-month 1)
453 (holiday-list-last-year 1)
456 (if (not (calendar-date-equal date
(car (car entry-list
))))
458 (setq date
(car (car entry-list
)))
459 (and holidays-in-diary-buffer
460 (calendar-date-compare
461 (list (list holiday-list-last-month
462 (calendar-last-day-of-month
463 holiday-list-last-month
464 holiday-list-last-year
)
465 holiday-list-last-year
))
467 ;; We need to get the holidays for the next 3 months.
468 (setq holiday-list-last-month
469 (extract-calendar-month date
))
470 (setq holiday-list-last-year
471 (extract-calendar-year date
))
472 (increment-calendar-month
473 holiday-list-last-month holiday-list-last-year
1)
475 (let ((displayed-month holiday-list-last-month
)
476 (displayed-year holiday-list-last-year
))
477 (calendar-holiday-list)))
478 (increment-calendar-month
479 holiday-list-last-month holiday-list-last-year
1))
480 (let* ((date-string (calendar-date-string date
))
482 (let ((h holiday-list
)
484 ;; Make a list of all holidays for date.
486 (if (calendar-date-equal date
(car (car h
)))
487 (setq d
(append d
(cdr (car h
)))))
490 (insert (if (= (point) (point-min)) "" ?
\n) date-string
)
491 (if date-holiday-list
(insert ": "))
492 (let* ((l (current-column))
494 (insert (mapconcat '(lambda (x)
495 (if (< longest
(length x
))
496 (setq longest
(length x
)))
499 (concat "\n" (make-string l ?
))))
500 (insert ?
\n (make-string (+ l longest
) ?
=) ?
\n)))))
501 (if (< 0 (length (car (cdr (car entry-list
)))))
502 (insert (car (cdr (car entry-list
))) ?
\n))
503 (setq entry-list
(cdr entry-list
))))
504 (set-buffer-modified-p nil
)
505 (goto-char (point-min))
506 (setq buffer-read-only t
)
507 (display-buffer fancy-diary-buffer
)
508 (message "Preparing diary...done"))))
510 (defun make-fancy-diary-buffer ()
511 "Create and return the initial fancy diary buffer."
513 (set-buffer (get-buffer-create fancy-diary-buffer
))
514 (setq buffer-read-only nil
)
515 (make-local-variable 'mode-line-format
)
516 (calendar-set-mode-line "Diary Entries")
518 (set-buffer-modified-p nil
)
519 (setq buffer-read-only t
)
520 (get-buffer fancy-diary-buffer
)))
522 (defun print-diary-entries ()
523 "Print a hard copy of the diary display.
525 If the simple diary display is being used, prepare a temp buffer with the
526 visible lines of the diary buffer, add a heading line composed from the mode
527 line, print the temp buffer, and destroy it.
529 If the fancy diary display is being used, just print the buffer.
531 The hooks given by the variable `print-diary-entries-hook' are called to do
532 the actual printing."
534 (if (bufferp (get-buffer fancy-diary-buffer
))
536 (set-buffer (get-buffer fancy-diary-buffer
))
537 (run-hooks 'print-diary-entries-hook
))
539 (find-buffer-visiting (substitute-in-file-name diary-file
))))
541 (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
544 (set-buffer diary-buffer
)
546 (if (not (stringp mode-line-format
))
548 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format
)
549 (substring mode-line-format
550 (match-beginning 1) (match-end 1))))
551 (copy-to-buffer temp-buffer
(point-min) (point-max))
552 (set-buffer temp-buffer
)
553 (while (re-search-forward "\^M.*$" nil t
)
555 (goto-char (point-min))
557 (make-string (length heading
) ?
=) "\n")
558 (run-hooks 'print-diary-entries-hook
)
559 (kill-buffer temp-buffer
)))
560 (error "You don't have a diary buffer!")))))
562 (defun show-all-diary-entries ()
563 "Show all of the diary entries in the diary file.
564 This function gets rid of the selective display of the diary file so that
565 all entries, not just some, are visible. If there is no diary buffer, one
568 (let ((d-file (substitute-in-file-name diary-file
)))
569 (if (and d-file
(file-exists-p d-file
))
570 (if (file-readable-p d-file
)
572 (let ((diary-buffer (find-buffer-visiting d-file
)))
573 (set-buffer (if diary-buffer
575 (find-file-noselect d-file t
)))
576 (let ((buffer-read-only nil
)
577 (diary-modified (buffer-modified-p)))
578 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
579 (setq selective-display nil
)
580 (make-local-variable 'mode-line-format
)
581 (setq mode-line-format default-mode-line-format
)
582 (display-buffer (current-buffer))
583 (set-buffer-modified-p diary-modified
))))
584 (error "Your diary file is not readable!"))
585 (error "You don't have a diary file!"))))
589 (defcustom diary-mail-addr
590 (if (boundp 'user-mail-address
) user-mail-address nil
)
591 "*Email address that `diary-mail-entries' will send email to."
593 :type
'(choice string
(const nil
))
596 (defcustom diary-mail-days
7
597 "*Number of days for `diary-mail-entries' to check."
603 (defun diary-mail-entries (&optional ndays
)
604 "Send a mail message showing diary entries for next NDAYS days.
605 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
607 You can call `diary-mail-entries' every night using an at/cron job.
608 For example, this script will run the program at 2am daily. Since
609 `emacs -batch' does not load your `.emacs' file, you must ensure that
610 all relevant variables are set, as done here.
613 # diary-rem.sh -- repeatedly run the Emacs diary-reminder
615 -eval \"(setq diary-mail-days 3 \\
616 european-calendar-style t \\
617 diary-mail-addr \\\"user@host.name\\\" )\" \\
618 -l diary-lib -f diary-mail-entries
619 at -f diary-rem.sh 0200 tomorrow
621 You may have to tweak the syntax of the `at' command to suit your
622 system. Alternatively, you can specify a cron entry:
623 0 1 * * * diary-rem.sh
624 to run it every morning at 1am."
627 ;; Use the fancy-diary-display as it doesn't hide rest of
628 ;; diary file with ^M characters. It also looks nicer.
629 (diary-display-hook 'fancy-diary-display
))
630 (if (not current-prefix-arg
)
631 (setq ndays diary-mail-days
))
633 (view-diary-entries ndays
)
634 (set-buffer fancy-diary-buffer
)
635 (setq text
(buffer-substring (point-min) (point-max)))
637 ;; Now send text as a mail message.
640 (insert diary-mail-addr
)
642 (insert "Diary entries generated ")
643 (insert (format-time-string "%a %d %b %Y" (current-time)))
646 (mail-send-and-exit nil
)
649 (defun diary-name-pattern (string-array &optional fullname
)
650 "Convert an STRING-ARRAY, an array of strings to a pattern.
651 The pattern will match any of the strings, either entirely or abbreviated
652 to three characters. An abbreviated form will match with or without a period;
653 If the optional FULLNAME is t, abbreviations will not match, just the full
656 (calendar-for-loop i from
0 to
(1- (length string-array
)) do
660 (if (string-equal pattern
"") "" "\\|")
661 (aref string-array i
)
666 (substring (aref string-array i
) 0 3) ".?")))))
669 (defvar marking-diary-entries nil
670 "True during the marking of diary entries, nil otherwise.")
672 (defvar marking-diary-entry nil
673 "True during the marking of diary entries, if current entry is marking.")
675 (defun mark-diary-entries ()
676 "Mark days in the calendar window that have diary entries.
677 Each entry in the diary file visible in the calendar window is marked.
678 After the entries are marked, the hooks `nongregorian-diary-marking-hook' and
679 `mark-diary-entries-hook' are run."
681 (setq mark-diary-entries-in-calendar t
)
682 (let ((d-file (substitute-in-file-name diary-file
))
683 (marking-diary-entries t
))
684 (if (and d-file
(file-exists-p d-file
))
685 (if (file-readable-p d-file
)
687 (message "Marking diary entries...")
688 (set-buffer (find-file-noselect d-file t
))
689 (let ((d diary-date-forms
)
690 (old-diary-syntax-table))
691 (setq old-diary-syntax-table
(syntax-table))
692 (set-syntax-table diary-syntax-table
)
695 ((date-form (if (equal (car (car d
)) 'backup
)
697 (car d
)));; ignore 'backup directive
698 (dayname (diary-name-pattern calendar-day-name-array
))
701 (diary-name-pattern calendar-month-name-array
)
703 (month "[0-9]+\\|\\*")
705 (year "[0-9]+\\|\\*")
706 (l (length date-form
))
707 (d-name-pos (- l
(length (memq 'dayname date-form
))))
708 (d-name-pos (if (/= l d-name-pos
) (+ 2 d-name-pos
)))
709 (m-name-pos (- l
(length (memq 'monthname date-form
))))
710 (m-name-pos (if (/= l m-name-pos
) (+ 2 m-name-pos
)))
711 (d-pos (- l
(length (memq 'day date-form
))))
712 (d-pos (if (/= l d-pos
) (+ 2 d-pos
)))
713 (m-pos (- l
(length (memq 'month date-form
))))
714 (m-pos (if (/= l m-pos
) (+ 2 m-pos
)))
715 (y-pos (- l
(length (memq 'year date-form
))))
716 (y-pos (if (/= l y-pos
) (+ 2 y-pos
)))
719 "\\(\\`\\|\^M\\|\n\\)\\("
720 (mapconcat 'eval date-form
"\\)\\(")
722 (case-fold-search t
))
723 (goto-char (point-min))
724 (while (re-search-forward regexp nil t
)
727 (buffer-substring-no-properties
728 (match-beginning d-name-pos
)
729 (match-end d-name-pos
))))
732 (buffer-substring-no-properties
733 (match-beginning m-name-pos
)
734 (match-end m-name-pos
))))
737 (buffer-substring-no-properties
738 (match-beginning m-pos
)
743 (buffer-substring-no-properties
744 (match-beginning d-pos
)
748 (buffer-substring-no-properties
749 (match-beginning y-pos
)
753 (if (and (= (length y-str
) 2)
754 abbreviated-calendar-year
)
756 (extract-calendar-year
757 (calendar-current-date)))
758 (y (+ (string-to-int y-str
)
760 (/ current-y
100)))))
761 (if (> (- y current-y
) 50)
763 (if (> (- current-y y
) 50)
766 (string-to-int y-str
)))))
768 (mark-calendar-days-named
769 (cdr (assoc-ignore-case
770 (substring dd-name
0 3)
772 calendar-day-name-array
774 '(lambda (x) (substring x
0 3))))))
776 (if (string-equal mm-name
"*")
779 (cdr (assoc-ignore-case
780 (substring mm-name
0 3)
782 calendar-month-name-array
784 '(lambda (x) (substring x
0 3)))
786 (mark-calendar-date-pattern mm dd yy
))))
788 (mark-sexp-diary-entries)
789 (run-hooks 'nongregorian-diary-marking-hook
790 'mark-diary-entries-hook
)
791 (set-syntax-table old-diary-syntax-table
)
792 (message "Marking diary entries...done")))
793 (error "Your diary file is not readable!"))
794 (error "You don't have a diary file!"))))
796 (defun mark-sexp-diary-entries ()
797 "Mark days in the calendar window that have sexp diary entries.
798 Each entry in the diary file (or included files) visible in the calendar window
799 is marked. See the documentation for the function `list-sexp-diary-entries'."
800 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol
))
801 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
802 (regexp-quote sexp-mark
) "(\\)\\|\\("
803 (regexp-quote diary-nonmarking-symbol
)
804 (regexp-quote sexp-mark
) "(diary-remind\\)"))
810 (set-buffer calendar-buffer
)
811 (setq m displayed-month
)
812 (setq y displayed-year
))
813 (increment-calendar-month m y -
1)
815 (calendar-absolute-from-gregorian (list m
1 y
)))
816 (increment-calendar-month m y
2)
818 (calendar-absolute-from-gregorian
819 (list m
(calendar-last-day-of-month m y
) y
)))
820 (goto-char (point-min))
821 (while (re-search-forward s-entry nil t
)
822 (if (char-equal (preceding-char) ?\
()
823 (setq marking-diary-entry t
)
824 (setq marking-diary-entry nil
))
825 (re-search-backward "(")
826 (let ((sexp-start (point))
832 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
834 (re-search-backward "\^M\\|\n\\|\\`")
835 (setq line-start
(point)))
837 (if (and (or (char-equal (preceding-char) ?\^M
)
838 (char-equal (preceding-char) ?
\n))
839 (not (looking-at " \\|\^I")))
840 (progn;; Diary entry consists only of the sexp
843 (setq entry-start
(point))
845 (re-search-forward "\^M\\|\n" nil t
)
846 (while (looking-at " \\|\^I")
847 (or (re-search-forward "\^M\\|\n" nil t
)
848 (re-search-forward "$" nil t
)))
849 (if (or (char-equal (preceding-char) ?\^M
)
850 (char-equal (preceding-char) ?
\n))
852 (setq entry
(buffer-substring-no-properties entry-start
(point)))
853 (while (string-match "[\^M]" entry
)
854 (aset entry
(match-beginning 0) ?
\n )))
855 (calendar-for-loop date from first-date to last-date do
856 (if (diary-sexp-entry sexp entry
857 (calendar-gregorian-from-absolute date
))
858 (mark-visible-calendar-date
859 (calendar-gregorian-from-absolute date
))))))))
861 (defun mark-included-diary-files ()
862 "Mark the diary entries from other diary files with those of the diary file.
863 This function is suitable for use as the `mark-diary-entries-hook'; it enables
864 you to use shared diary files together with your own. The files included are
865 specified in the diary-file by lines of this form:
866 #include \"filename\"
867 This is recursive; that is, #include directives in diary files thus included
868 are obeyed. You can change the `#include' to some other string by
869 changing the variable `diary-include-string'."
870 (goto-char (point-min))
871 (while (re-search-forward
873 "\\(\\`\\|\^M\\|\n\\)"
874 (regexp-quote diary-include-string
)
877 (let ((diary-file (substitute-in-file-name
878 (buffer-substring-no-properties
879 (match-beginning 2) (match-end 2))))
880 (mark-diary-entries-hook 'mark-included-diary-files
))
881 (if (file-exists-p diary-file
)
882 (if (file-readable-p diary-file
)
885 (kill-buffer (find-buffer-visiting diary-file
)))
887 (message "Can't read included diary file %s" diary-file
)
890 (message "Can't find included diary file %s" diary-file
)
892 (goto-char (point-min)))
894 (defun mark-calendar-days-named (dayname)
895 "Mark all dates in the calendar window that are day DAYNAME of the week.
896 0 means all Sundays, 1 means all Mondays, and so on."
898 (set-buffer calendar-buffer
)
899 (let ((prev-month displayed-month
)
900 (prev-year displayed-year
)
901 (succ-month displayed-month
)
902 (succ-year displayed-year
)
905 (increment-calendar-month succ-month succ-year
1)
906 (increment-calendar-month prev-month prev-year -
1)
907 (setq day
(calendar-absolute-from-gregorian
908 (calendar-nth-named-day 1 dayname prev-month prev-year
)))
909 (setq last-day
(calendar-absolute-from-gregorian
910 (calendar-nth-named-day -
1 dayname succ-month succ-year
)))
911 (while (<= day last-day
)
912 (mark-visible-calendar-date (calendar-gregorian-from-absolute day
))
913 (setq day
(+ day
7))))))
915 (defun mark-calendar-date-pattern (month day year
)
916 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
917 A value of 0 in any position is a wildcard."
919 (set-buffer calendar-buffer
)
920 (let ((m displayed-month
)
922 (increment-calendar-month m y -
1)
923 (calendar-for-loop i from
0 to
2 do
924 (mark-calendar-month m y month day year
)
925 (increment-calendar-month m y
1)))))
927 (defun mark-calendar-month (month year p-month p-day p-year
)
928 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
929 A value of 0 in any position of the pattern is a wildcard."
930 (if (or (and (= month p-month
)
931 (or (= p-year
0) (= year p-year
)))
933 (or (= p-year
0) (= year p-year
))))
936 i from
1 to
(calendar-last-day-of-month month year
) do
937 (mark-visible-calendar-date (list month i year
)))
938 (mark-visible-calendar-date (list month p-day year
)))))
940 (defun sort-diary-entries ()
941 "Sort the list of diary entries by time of day."
942 (setq diary-entries-list
(sort diary-entries-list
'diary-entry-compare
)))
944 (defun diary-entry-compare (e1 e2
)
945 "Returns t if E1 is earlier than E2."
946 (or (calendar-date-compare e1 e2
)
947 (and (calendar-date-equal (car e1
) (car e2
))
948 (< (diary-entry-time (car (cdr e1
)))
949 (diary-entry-time (car (cdr e2
)))))))
951 (defcustom diary-unknown-time
953 "*Value returned by diary-entry-time when no time is found.
954 The default value -9999 causes entries with no recognizable time to be placed
955 before those with times; 9999 would place entries with no recognizable time
956 after those with times."
961 (defun diary-entry-time (s)
962 "Time at the beginning of the string S in a military-style integer. For
963 example, returns 1325 for 1:25pm. Returns `diary-unknown-time' (default value
964 -9999) if no time is recognized. The recognized forms are XXXX, X:XX, or
965 XX:XX (military time), and XXam, XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm,
967 (let ((case-fold-search nil
))
968 (cond ((string-match;; Military time
969 "^[ \t]*\\([0-9]?[0-9]\\):?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)" s
)
970 (+ (* 100 (string-to-int
971 (substring s
(match-beginning 1) (match-end 1))))
972 (string-to-int (substring s
(match-beginning 2) (match-end 2)))))
973 ((string-match;; Hour only XXam or XXpm
974 "^[ \t]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s
)
975 (+ (* 100 (%
(string-to-int
976 (substring s
(match-beginning 1) (match-end 1)))
978 (if (equal ?a
(downcase (aref s
(match-beginning 2))))
980 ((string-match;; Hour and minute XX:XXam or XX:XXpm
981 "^[ \t]*\\([0-9]?[0-9]\\):\\([0-9][0-9]\\)\\([ap]\\)m\\>" s
)
982 (+ (* 100 (%
(string-to-int
983 (substring s
(match-beginning 1) (match-end 1)))
985 (string-to-int (substring s
(match-beginning 2) (match-end 2)))
986 (if (equal ?a
(downcase (aref s
(match-beginning 3))))
988 (t diary-unknown-time
))));; Unrecognizable
990 (defun list-sexp-diary-entries (date)
991 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
992 Also, Make them visible in the diary file. Returns t if any entries were
995 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
996 `%%'). The form of a sexp diary entry is
1000 Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
1001 SEXP yields the value nil, the diary entry does not apply. If it yields a
1002 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1003 string, that string will be the diary entry in the fancy diary display.
1005 For example, the following diary entry will apply to the 21st of the month
1006 if it is a weekday and the Friday before if the 21st is on a weekend:
1008 &%%(let ((dayname (calendar-day-of-week date))
1009 (day (extract-calendar-day date)))
1011 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1012 (and (memq day '(19 20)) (= dayname 5)))
1013 ) UIUC pay checks deposited
1015 A number of built-in functions are available for this type of diary entry:
1017 %%(diary-date MONTH DAY YEAR) text
1018 Entry applies if date is MONTH, DAY, YEAR if
1019 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1020 `european-calendar-style' is t. DAY, MONTH, and YEAR
1021 can be lists of integers, the constant t, or an integer.
1022 The constant t means all values.
1024 %%(diary-float MONTH DAYNAME N &optional DAY) text
1025 Entry will appear on the Nth DAYNAME of MONTH.
1026 (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1027 if N is negative it counts backward from the end of
1028 the month. MONTH can be a list of months, a single
1029 month, or t to specify all months. Optional DAY means
1030 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
1031 to 1 if N>0 and the last day of the month if N<0.
1033 %%(diary-block M1 D1 Y1 M2 D2 Y2) text
1034 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1035 inclusive. (If `european-calendar-style' is t, the
1036 order of the parameters should be changed to D1, M1, Y1,
1039 %%(diary-anniversary MONTH DAY YEAR) text
1040 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1041 (If `european-calendar-style' is t, the order of the
1042 parameters should be changed to DAY, MONTH, YEAR.) Text
1043 can contain %d or %d%s; %d will be replaced by the number
1044 of years since the MONTH DAY, YEAR and %s will be replaced
1045 by the ordinal ending of that number (that is, `st', `nd',
1046 `rd' or `th', as appropriate. The anniversary of February
1047 29 is considered to be March 1 in a non-leap year.
1049 %%(diary-cyclic N MONTH DAY YEAR) text
1050 Entry will appear every N days, starting MONTH DAY, YEAR.
1051 (If `european-calendar-style' is t, the order of the
1052 parameters should be changed to N, DAY, MONTH, YEAR.) Text
1053 can contain %d or %d%s; %d will be replaced by the number
1054 of repetitions since the MONTH DAY, YEAR and %s will
1055 be replaced by the ordinal ending of that number (that is,
1056 `st', `nd', `rd' or `th', as appropriate.
1058 %%(diary-remind SEXP DAYS &optional MARKING) text
1059 Entry is a reminder for diary sexp SEXP. DAYS is either a
1060 single number or a list of numbers indicating the number(s)
1061 of days before the event that the warning(s) should occur.
1062 If the current date is (one of) DAYS before the event
1063 indicated by EXPR, then a suitable message (as specified
1064 by `diary-remind-message') appears. In addition to the
1065 reminders beforehand, the diary entry also appears on
1066 the date itself. If optional MARKING is non-nil then the
1067 *reminders* are marked on the calendar. Marking of
1068 reminders is independent of whether the entry *itself* is
1069 a marking or nonmarking one.
1071 %%(diary-day-of-year)
1072 Diary entries giving the day of the year and the number of
1073 days remaining in the year will be made every day. Note
1074 that since there is no text, it makes sense only if the
1075 fancy diary display is used.
1078 Diary entries giving the corresponding ISO commercial date
1079 will be made every day. Note that since there is no text,
1080 it makes sense only if the fancy diary display is used.
1082 %%(diary-french-date)
1083 Diary entries giving the corresponding French Revolutionary
1084 date will be made every day. Note that since there is no
1085 text, it makes sense only if the fancy diary display is used.
1087 %%(diary-islamic-date)
1088 Diary entries giving the corresponding Islamic date will be
1089 made every day. Note that since there is no text, it
1090 makes sense only if the fancy diary display is used.
1092 %%(diary-hebrew-date)
1093 Diary entries giving the corresponding Hebrew 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-astro-day-number) Diary entries giving the corresponding
1098 astronomical (Julian) day number will be made every day.
1099 Note that since there is no text, it makes sense only if the
1100 fancy diary display is used.
1102 %%(diary-julian-date) Diary entries giving the corresponding
1103 Julian date will be made every day. Note that since
1104 there is no text, it makes sense only if the fancy diary
1107 %%(diary-sunrise-sunset)
1108 Diary entries giving the local times of sunrise and sunset
1109 will be made every day. Note that since there is no text,
1110 it makes sense only if the fancy diary display is used.
1111 Floating point required.
1113 %%(diary-phases-of-moon)
1114 Diary entries giving the times of the phases of the moon
1115 will be when appropriate. Note that since there is no text,
1116 it makes sense only if the fancy diary display is used.
1117 Floating point required.
1119 %%(diary-yahrzeit MONTH DAY YEAR) text
1120 Text is assumed to be the name of the person; the date is
1121 the date of death on the *civil* calendar. The diary entry
1122 will appear on the proper Hebrew-date anniversary and on the
1123 day before. (If `european-calendar-style' is t, the order
1124 of the parameters should be changed to DAY, MONTH, YEAR.)
1126 %%(diary-rosh-hodesh)
1127 Diary entries will be made on the dates of Rosh Hodesh on
1128 the Hebrew calendar. Note that since there is no text, it
1129 makes sense only if the fancy diary display is used.
1132 Diary entries giving the weekly parasha will be made on
1133 every Saturday. Note that since there is no text, it
1134 makes sense only if the fancy diary display is used.
1137 Diary entries giving the omer count will be made every day
1138 from Passover to Shavuot. Note that since there is no text,
1139 it makes sense only if the fancy diary display is used.
1141 Marking these entries is *extremely* time consuming, so these entries are
1142 best if they are nonmarking."
1143 (let* ((mark (regexp-quote diary-nonmarking-symbol
))
1144 (sexp-mark (regexp-quote sexp-diary-entry-symbol
))
1145 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)" mark
"?" sexp-mark
"("))
1147 (goto-char (point-min))
1148 (while (re-search-forward s-entry nil t
)
1150 (let ((sexp-start (point))
1157 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
1159 (re-search-backward "\^M\\|\n\\|\\`")
1160 (setq line-start
(point)))
1162 (buffer-substring-no-properties (1+ line-start
) (point)))
1164 (if (and (or (char-equal (preceding-char) ?\^M
)
1165 (char-equal (preceding-char) ?
\n))
1166 (not (looking-at " \\|\^I")))
1167 (progn;; Diary entry consists only of the sexp
1170 (setq entry-start
(point))
1171 (re-search-forward "\^M\\|\n" nil t
)
1172 (while (looking-at " \\|\^I")
1173 (re-search-forward "\^M\\|\n" nil t
))
1175 (setq entry
(buffer-substring-no-properties entry-start
(point)))
1176 (while (string-match "[\^M]" entry
)
1177 (aset entry
(match-beginning 0) ?
\n )))
1178 (let ((diary-entry (diary-sexp-entry sexp entry date
)))
1180 (subst-char-in-region line-start
(point) ?\^M ?
\n t
))
1181 (add-to-diary-list date diary-entry specifier
)
1182 (setq entry-found
(or entry-found diary-entry
)))))
1185 (defun diary-sexp-entry (sexp entry date
)
1186 "Process a SEXP diary ENTRY for DATE."
1187 (let ((result (if calendar-debug-sexp
1188 (let ((stack-trace-on-error t
))
1189 (eval (car (read-from-string sexp
))))
1191 (eval (car (read-from-string sexp
)))
1194 (message "Bad sexp at line %d in %s: %s"
1197 (narrow-to-region 1 (point))
1198 (goto-char (point-min))
1200 (while (re-search-forward "\n\\|\^M" nil t
)
1201 (setq lines
(1+ lines
)))
1205 (if (stringp result
)
1211 (defun diary-date (month day year
)
1212 "Specific date(s) diary entry.
1213 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1214 and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR
1215 can be lists of integers, the constant t, or an integer. The constant t means
1217 (let* ((dd (if european-calendar-style
1220 (mm (if european-calendar-style
1223 (m (extract-calendar-month date
))
1224 (y (extract-calendar-year date
))
1225 (d (extract-calendar-day date
)))
1227 (or (and (listp dd
) (memq d dd
))
1230 (or (and (listp mm
) (memq m mm
))
1233 (or (and (listp year
) (memq y year
))
1238 (defun diary-block (m1 d1 y1 m2 d2 y2
)
1240 Entry applies if date is between two dates. Order of the parameters is
1241 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1242 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t."
1243 (let ((date1 (calendar-absolute-from-gregorian
1244 (if european-calendar-style
1247 (date2 (calendar-absolute-from-gregorian
1248 (if european-calendar-style
1251 (d (calendar-absolute-from-gregorian date
)))
1252 (if (and (<= date1 d
) (<= d date2
))
1255 (defun diary-float (month dayname n
&optional day
)
1256 "Floating diary entry--entry applies if date is the nth dayname of month.
1257 Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant
1258 t, or an integer. The constant t means all months. If N is negative, count
1259 backward from the end of the month.
1261 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY."
1262 ;; This is messy because the diary entry may apply, but the date on which it
1263 ;; is based can be in a different month/year. For example, asking for the
1264 ;; first Monday after December 30. For large values of |n| the problem is
1266 (and (= dayname
(calendar-day-of-week date
))
1267 (let* ((m (extract-calendar-month date
))
1268 (d (extract-calendar-day date
))
1269 (y (extract-calendar-year date
))
1270 (limit; last (n>0) or first (n<0) possible base date for entry
1271 (calendar-nth-named-absday (- n
) dayname m y d
))
1272 (last-abs (if (> n
0) limit
(+ limit
6)))
1273 (first-abs (if (> n
0) (- limit
6) limit
))
1274 (last (calendar-gregorian-from-absolute last-abs
))
1275 (first (calendar-gregorian-from-absolute first-abs
))
1276 ; m1, d1 is first possible base date
1277 (m1 (extract-calendar-month first
))
1278 (d1 (extract-calendar-day first
))
1279 (y1 (extract-calendar-year first
))
1280 ; m2, d2 is last possible base date
1281 (m2 (extract-calendar-month last
))
1282 (d2 (extract-calendar-day last
))
1283 (y2 (extract-calendar-year last
)))
1284 (if (or (and (= m1 m2
) ; only possible base dates in one month
1285 (or (and (listp month
) (memq m1 month
))
1288 (let ((d (or day
(if (> n
0)
1290 (calendar-last-day-of-month m1 y1
)))))
1291 (and (<= d1 d
) (<= d d2
))))
1292 ;; only possible base dates straddle two months
1294 (and (= y1 y2
) (< m1 m2
)))
1296 ;; m1, d1 works as a base date
1298 (or (and (listp month
) (memq m1 month
))
1301 (<= d1
(or day
(if (> n
0)
1303 (calendar-last-day-of-month m1 y1
)))))
1304 ;; m2, d2 works as a base date
1305 (and (or (and (listp month
) (memq m2 month
))
1308 (<= (or day
(if (> n
0)
1310 (calendar-last-day-of-month m2 y2
)))
1314 (defun diary-anniversary (month day year
)
1315 "Anniversary diary entry.
1316 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1317 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1318 `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
1319 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1320 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1321 `rd' or `th', as appropriate. The anniversary of February 29 is considered
1322 to be March 1 in non-leap years."
1323 (let* ((d (if european-calendar-style
1326 (m (if european-calendar-style
1329 (y (extract-calendar-year date
))
1331 (if (and (= m
2) (= d
29) (not (calendar-leap-year-p y
)))
1334 (if (and (> diff
0) (calendar-date-equal (list m d y
) date
))
1335 (format entry diff
(diary-ordinal-suffix diff
)))))
1337 (defun diary-cyclic (n month day year
)
1338 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1339 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1340 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1341 years since the MONTH DAY, YEAR and the %s will be replaced by the ordinal
1342 ending of that number (that is, `st', `nd', `rd' or `th', as appropriate."
1343 (let* ((d (if european-calendar-style
1346 (m (if european-calendar-style
1349 (diff (- (calendar-absolute-from-gregorian date
)
1350 (calendar-absolute-from-gregorian
1353 (if (and (>= diff
0) (zerop (% diff n
)))
1354 (format entry cycle
(diary-ordinal-suffix cycle
)))))
1356 (defun diary-ordinal-suffix (n)
1357 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1358 (if (or (memq (% n
100) '(11 12 13))
1361 (aref ["th" "st" "nd" "rd"] (% n
10))))
1363 (defun diary-day-of-year ()
1364 "Day of year and number of days remaining in the year of date diary entry."
1365 (calendar-day-of-year-string date
))
1367 (defcustom diary-remind-message
1369 (if (= 0 (% days
7))
1370 (concat (int-to-string (/ days
7)) (if (= 7 days
) " week" " weeks"))
1371 (concat (int-to-string days
) (if (= 1 days
) " day" " days")))
1374 "*Pseudo-pattern giving form of reminder messages in the fancy diary
1377 Used by the function `diary-remind', a pseudo-pattern is a list of
1378 expressions that can involve the keywords `days' (a number), `date' (a list of
1379 month, day, year), and `diary-entry' (a string)."
1383 (defun diary-remind (sexp days
&optional marking
)
1384 "Provide a reminder of a diary entry.
1385 SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
1386 indicating the number(s) of days before the event that the warning(s) should
1387 occur on. If the current date is (one of) DAYS before the event indicated by
1388 SEXP, then a suitable message (as specified by `diary-remind-message' is
1391 In addition to the reminders beforehand, the diary entry also appears on the
1394 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1395 entry specifies that the diary entry (not the reminder) is non-marking.
1396 Marking of reminders is independent of whether the entry itself is a marking
1397 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1398 marked on the calendar."
1399 (let ((diary-entry (eval sexp
)))
1401 ;; Diary entry applies on date
1403 (or (not marking-diary-entries
) marking-diary-entry
))
1405 ;; Diary entry may apply to `days' before date
1406 ((and (integerp days
)
1407 (not diary-entry
); Diary entry does not apply to date
1408 (or (not marking-diary-entries
) marking
))
1409 (let ((date (calendar-gregorian-from-absolute
1410 (+ (calendar-absolute-from-gregorian date
) days
))))
1411 (if (setq diary-entry
(eval sexp
))
1412 (mapconcat 'eval diary-remind-message
""))))
1413 ;; Diary entry may apply to one of a list of days before date
1414 ((and (listp days
) days
)
1415 (or (diary-remind sexp
(car days
) marking
)
1416 (diary-remind sexp
(cdr days
) marking
))))))
1418 (defun add-to-diary-list (date string specifier
)
1419 "Add the entry (DATE STRING SPECIFIER) to `diary-entries-list'.
1420 Do nothing if DATE or STRING is nil."
1422 (setq diary-entries-list
1423 (append diary-entries-list
(list (list date string specifier
))))))
1425 (defun make-diary-entry (string &optional nonmarking file
)
1426 "Insert a diary entry STRING which may be NONMARKING in FILE.
1427 If omitted, NONMARKING defaults to nil and FILE defaults to diary-file."
1428 (find-file-other-window
1429 (substitute-in-file-name (if file file diary-file
)))
1430 (goto-char (point-max))
1433 (if nonmarking diary-nonmarking-symbol
"")
1436 (defun insert-diary-entry (arg)
1437 "Insert a diary entry for the date indicated by point.
1438 Prefix arg will make the entry nonmarking."
1440 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t t
)
1443 (defun insert-weekly-diary-entry (arg)
1444 "Insert a weekly diary entry for the day of the week indicated by point.
1445 Prefix arg will make the entry nonmarking."
1447 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t
))
1450 (defun insert-monthly-diary-entry (arg)
1451 "Insert a monthly diary entry for the day of the month indicated by point.
1452 Prefix arg will make the entry nonmarking."
1454 (let* ((calendar-date-display-form
1455 (if european-calendar-style
1458 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t
)
1461 (defun insert-yearly-diary-entry (arg)
1462 "Insert an annual diary entry for the day of the year indicated by point.
1463 Prefix arg will make the entry nonmarking."
1465 (let* ((calendar-date-display-form
1466 (if european-calendar-style
1467 '(day " " monthname
)
1468 '(monthname " " day
))))
1469 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t
)
1472 (defun insert-anniversary-diary-entry (arg)
1473 "Insert an anniversary diary entry for the date given by point.
1474 Prefix arg will make the entry nonmarking."
1476 (let* ((calendar-date-display-form
1477 (if european-calendar-style
1478 '(day " " month
" " year
)
1479 '(month " " day
" " year
))))
1481 (format "%s(diary-anniversary %s)"
1482 sexp-diary-entry-symbol
1483 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
1486 (defun insert-block-diary-entry (arg)
1487 "Insert a block diary entry for the days between the point and marked date.
1488 Prefix arg will make the entry nonmarking."
1490 (let* ((calendar-date-display-form
1491 (if european-calendar-style
1492 '(day " " month
" " year
)
1493 '(month " " day
" " year
)))
1494 (cursor (calendar-cursor-to-date t
))
1495 (mark (or (car calendar-mark-ring
)
1496 (error "No mark set in this buffer")))
1499 (if (< (calendar-absolute-from-gregorian mark
)
1500 (calendar-absolute-from-gregorian cursor
))
1506 (format "%s(diary-block %s %s)"
1507 sexp-diary-entry-symbol
1508 (calendar-date-string start nil t
)
1509 (calendar-date-string end nil t
))
1512 (defun insert-cyclic-diary-entry (arg)
1513 "Insert a cyclic diary entry starting at the date given by point.
1514 Prefix arg will make the entry nonmarking."
1516 (let* ((calendar-date-display-form
1517 (if european-calendar-style
1518 '(day " " month
" " year
)
1519 '(month " " day
" " year
))))
1521 (format "%s(diary-cyclic %d %s)"
1522 sexp-diary-entry-symbol
1523 (calendar-read "Repeat every how many days: "
1524 '(lambda (x) (> x
0)))
1525 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
1528 (provide 'diary-lib
)
1530 ;;; diary-lib.el ends here