1 ;;; diary-lib.el --- diary functions
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2003, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
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
41 (defun diary-check-diary-file ()
42 "Check that the file specified by `diary-file' exists and is readable.
43 If so, return the expanded file name, otherwise signal an error."
44 (let ((d-file (substitute-in-file-name diary-file
)))
45 (if (and d-file
(file-exists-p d-file
))
46 (if (file-readable-p d-file
)
48 (error "Diary file `%s' is not readable" diary-file
))
49 (error "Diary file `%s' does not exist" diary-file
))))
52 (defun diary (&optional arg
)
53 "Generate the diary window for ARG days starting with the current date.
54 If no argument is provided, the number of days of diary entries is governed
55 by the variable `number-of-diary-entries'. A value of ARG less than 1
56 does nothing. This function is suitable for execution in a `.emacs' file."
58 (diary-check-diary-file)
59 (let ((date (calendar-current-date)))
62 (cond (arg (prefix-numeric-value arg
))
63 ((vectorp number-of-diary-entries
)
64 (aref number-of-diary-entries
(calendar-day-of-week date
)))
65 (t number-of-diary-entries
)))))
67 (defun view-diary-entries (arg)
68 "Prepare and display a buffer with diary entries.
69 Searches the file named in `diary-file' for entries that
70 match ARG days starting with the date indicated by the cursor position
71 in the displayed three-month calendar."
73 (diary-check-diary-file)
74 (list-diary-entries (calendar-cursor-to-date t
) arg
))
76 (defun view-other-diary-entries (arg d-file
)
77 "Prepare and display buffer of diary entries from an alternative diary file.
78 Searches for entries that match ARG days, starting with the date indicated
79 by the cursor position in the displayed three-month calendar.
80 D-FILE specifies the file to use as the diary file."
82 (list (if arg
(prefix-numeric-value arg
) 1)
83 (read-file-name "Enter diary file name: " default-directory nil t
)))
84 (let ((diary-file d-file
))
85 (view-diary-entries arg
)))
87 (autoload 'check-calendar-holidays
"holidays"
88 "Check the list of holidays for any that occur on DATE.
89 The value returned is a list of strings of relevant holiday descriptions.
90 The holidays are those in the list `calendar-holidays'.")
92 (autoload 'calendar-holiday-list
"holidays"
93 "Form the list of holidays that occur on dates in the calendar window.
94 The holidays are those in the list `calendar-holidays'.")
96 (autoload 'diary-french-date
"cal-french"
97 "French calendar equivalent of date diary entry.")
99 (autoload 'diary-mayan-date
"cal-mayan"
100 "Mayan calendar equivalent of date diary entry.")
102 (autoload 'diary-iso-date
"cal-iso"
103 "ISO calendar equivalent of date diary entry.")
105 (autoload 'diary-julian-date
"cal-julian"
106 "Julian calendar equivalent of date diary entry.")
108 (autoload 'diary-astro-day-number
"cal-julian"
109 "Astronomical (Julian) day number diary entry.")
111 (autoload 'diary-chinese-date
"cal-china"
112 "Chinese calendar equivalent of date diary entry.")
114 (autoload 'diary-islamic-date
"cal-islam"
115 "Islamic calendar equivalent of date diary entry.")
117 (autoload 'list-islamic-diary-entries
"cal-islam"
118 "Add any Islamic date entries from the diary file to `diary-entries-list'.")
120 (autoload 'mark-islamic-diary-entries
"cal-islam"
121 "Mark days in the calendar window that have Islamic date diary entries.")
123 (autoload 'mark-islamic-calendar-date-pattern
"cal-islam"
124 "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR.")
126 (autoload 'diary-hebrew-date
"cal-hebrew"
127 "Hebrew calendar equivalent of date diary entry.")
129 (autoload 'diary-omer
"cal-hebrew"
130 "Omer count diary entry.")
132 (autoload 'diary-yahrzeit
"cal-hebrew"
133 "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before.")
135 (autoload 'diary-parasha
"cal-hebrew"
136 "Parasha diary entry--entry applies if date is a Saturday.")
138 (autoload 'diary-rosh-hodesh
"cal-hebrew"
139 "Rosh Hodesh diary entry.")
141 (autoload 'list-hebrew-diary-entries
"cal-hebrew"
142 "Add any Hebrew date entries from the diary file to `diary-entries-list'.")
144 (autoload 'mark-hebrew-diary-entries
"cal-hebrew"
145 "Mark days in the calendar window that have Hebrew date diary entries.")
147 (autoload 'mark-hebrew-calendar-date-pattern
"cal-hebrew"
148 "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR.")
150 (autoload 'diary-coptic-date
"cal-coptic"
151 "Coptic calendar equivalent of date diary entry.")
153 (autoload 'diary-ethiopic-date
"cal-coptic"
154 "Ethiopic calendar equivalent of date diary entry.")
156 (autoload 'diary-persian-date
"cal-persia"
157 "Persian calendar equivalent of date diary entry.")
159 (autoload 'diary-phases-of-moon
"lunar" "Moon phases diary entry.")
161 (autoload 'diary-sunrise-sunset
"solar"
162 "Local time of sunrise and sunset as a diary entry.")
164 (autoload 'diary-sabbath-candles
"solar"
165 "Local time of candle lighting diary entry--applies if date is a Friday.
166 No diary entry if there is no sunset on that date.")
168 (defvar diary-syntax-table
(copy-syntax-table (standard-syntax-table))
169 "The syntax table used when parsing dates in the diary file.
170 It is the standard syntax table used in Fundamental mode, but with the
171 syntax of `*' and `:' changed to be word constituents.")
173 (modify-syntax-entry ?
* "w" diary-syntax-table
)
174 (modify-syntax-entry ?
: "w" diary-syntax-table
)
176 (defvar diary-entries-list
)
177 (defvar displayed-year
)
178 (defvar displayed-month
)
183 (defvar original-date
)
185 (defun diary-attrtype-convert (attrvalue type
)
186 "Convert string ATTRVALUE to TYPE appropriate for a face description.
187 Valid TYPEs are: string, symbol, int, stringtnil, tnil."
189 (setq ret
(cond ((eq type
'string
) attrvalue
)
190 ((eq type
'symbol
) (read attrvalue
))
191 ((eq type
'int
) (string-to-int attrvalue
))
192 ((eq type
'stringtnil
)
193 (cond ((string= "t" attrvalue
) t
)
194 ((string= "nil" attrvalue
) nil
)
197 (cond ((string= "t" attrvalue
) t
)
198 ((string= "nil" attrvalue
) nil
)))))
199 ; (message "(%s)[%s]=[%s]" (print type) attrvalue ret)
203 (defun diary-pull-attrs (entry fileglobattrs
)
204 "Pull the face-related attributes off the entry, merge with the
205 fileglobattrs, and return the (possibly modified) entry and face
206 data in a list of attrname attrvalue values.
207 The entry will be modified to drop all tags that are used for face matching.
208 If entry is nil, then the fileglobattrs are being searched for,
209 the fileglobattrs variable is ignored, and
210 diary-glob-file-regexp-prefix is prepended to the regexps before each
213 (let (regexp regnum attrname attr-list attrname attrvalue type
218 attr-list diary-face-attrs
)
220 (goto-char (point-min))
221 (setq attr
(car attr-list
)
224 attrname
(nth 2 attr
)
226 regexp
(concat diary-glob-file-regexp-prefix regexp
))
228 (if (re-search-forward regexp
(point-max) t
)
229 (setq attrvalue
(buffer-substring-no-properties
230 (match-beginning regnum
)
231 (match-end regnum
))))
233 (setq attrvalue
(diary-attrtype-convert attrvalue type
)))
234 (setq ret-attr
(append ret-attr
(list attrname attrvalue
))))
235 (setq attr-list
(cdr attr-list
)))
236 (setq fileglobattrs ret-attr
))
238 (setq ret-attr fileglobattrs
239 attr-list diary-face-attrs
)
241 (goto-char (point-min))
242 (setq attr
(car attr-list
)
245 attrname
(nth 2 attr
)
248 (if (string-match regexp entry
)
250 (setq attrvalue
(substring-no-properties entry
251 (match-beginning regnum
)
253 (setq entry
(replace-match "" t t entry
))))
255 (setq attrvalue
(diary-attrtype-convert attrvalue type
)))
256 (setq ret-attr
(append ret-attr
(list attrname attrvalue
))))
257 (setq attr-list
(cdr attr-list
)))))
258 (list entry ret-attr
))))
261 ;; This can be removed once the kill/yank treatment of invisible text
262 ;; (see etc/TODO) is fixed. -- gm
263 (defcustom diary-header-line-flag t
264 "*If non-nil, `simple-diary-display' will show a header line.
265 The format of the header is specified by `diary-header-line-format'."
270 (defcustom diary-header-line-format
271 '(:eval
(calendar-string-spread
272 (list (if selective-display
273 "Selective display active - press \"s\" in calendar \
277 "*Format of the header line displayed by `simple-diary-display'.
278 Only used if `diary-header-line-flag' is non-nil."
283 (defun list-diary-entries (date number
)
284 "Create and display a buffer containing the relevant lines in diary-file.
285 The arguments are DATE and NUMBER; the entries selected are those
286 for NUMBER days starting with date DATE. The other entries are hidden
287 using selective display. If NUMBER is less than 1, this function does nothing.
289 Returns a list of all relevant diary entries found, if any, in order by date.
290 The list entries have the form ((month day year) string specifier) where
291 \(month day year) is the date of the entry, string is the entry text, and
292 specifier is the applicability. If the variable `diary-list-include-blanks'
293 is t, this list includes a dummy diary entry consisting of the empty string)
294 for a date with no diary entries.
296 After the list is prepared, the hooks `nongregorian-diary-listing-hook',
297 `list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
298 These hooks have the following distinct roles:
300 `nongregorian-diary-listing-hook' can cull dates from the diary
301 and each included file. Usually used for Hebrew or Islamic
302 diary entries in files. Applied to *each* file.
304 `list-diary-entries-hook' adds or manipulates diary entries from
305 external sources. Used, for example, to include diary entries
306 from other files or to sort the diary entries. Invoked *once* only,
307 before the display hook is run.
309 `diary-display-hook' does the actual display of information. If this is
310 nil, simple-diary-display will be used. Use add-hook to set this to
311 fancy-diary-display, if desired. If you want no diary display, use
312 add-hook to set this to ignore.
314 `diary-hook' is run last. This can be used for an appointment
315 notification function."
318 (let ((original-date date
);; save for possible use in the hooks
319 old-diary-syntax-table
322 (date-string (calendar-date-string date
))
323 (d-file (substitute-in-file-name diary-file
)))
324 (message "Preparing diary...")
326 (let ((diary-buffer (find-buffer-visiting d-file
)))
327 (if (not diary-buffer
)
328 (set-buffer (find-file-noselect d-file t
))
329 (set-buffer diary-buffer
)
330 (or (verify-visited-file-modtime diary-buffer
)
331 (revert-buffer t t
))))
332 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
"")))
333 (setq selective-display t
)
334 (setq selective-display-ellipses nil
)
335 (if diary-header-line-flag
336 (setq header-line-format diary-header-line-format
))
337 (setq old-diary-syntax-table
(syntax-table))
338 (set-syntax-table diary-syntax-table
)
340 (let ((buffer-read-only nil
)
341 (diary-modified (buffer-modified-p))
342 (mark (regexp-quote diary-nonmarking-symbol
)))
343 ;; First and last characters must be ^M or \n for
344 ;; selective display to work properly
345 (goto-char (1- (point-max)))
346 (if (not (looking-at "\^M\\|\n"))
348 (goto-char (point-max))
350 (goto-char (point-min))
351 (if (not (looking-at "\^M\\|\n"))
353 (subst-char-in-region (point-min) (point-max) ?
\n ?\^M t
)
354 (calendar-for-loop i from
1 to number do
355 (let ((d diary-date-forms
)
356 (month (extract-calendar-month date
))
357 (day (extract-calendar-day date
))
358 (year (extract-calendar-year date
))
359 (entry-found (list-sexp-diary-entries date
)))
362 ((date-form (if (equal (car (car d
)) 'backup
)
365 (backup (equal (car (car d
)) 'backup
))
367 (format "%s\\|%s\\.?"
368 (calendar-day-name date
)
369 (calendar-day-name date
'abbrev
)))
371 (format "\\*\\|%s\\|%s\\.?"
372 (calendar-month-name month
)
373 (calendar-month-name month
'abbrev
)))
374 (month (concat "\\*\\|0*" (int-to-string month
)))
375 (day (concat "\\*\\|0*" (int-to-string day
)))
378 "\\*\\|0*" (int-to-string year
)
379 (if abbreviated-calendar-year
380 (concat "\\|" (format "%02d" (% year
100)))
384 "\\(\\`\\|\^M\\|\n\\)" mark
"?\\("
385 (mapconcat 'eval date-form
"\\)\\(")
387 (case-fold-search t
))
388 (goto-char (point-min))
389 (while (re-search-forward regexp nil t
)
390 (if backup
(re-search-backward "\\<" nil t
))
391 (if (and (or (char-equal (preceding-char) ?\^M
)
392 (char-equal (preceding-char) ?
\n))
393 (not (looking-at " \\|\^I")))
394 ;; Diary entry that consists only of date.
396 ;; Found a nonempty diary entry--make it visible and
397 ;; add it to the list.
399 (let ((entry-start (point))
401 (re-search-backward "\^M\\|\n\\|\\`")
402 (setq date-start
(point))
403 (re-search-forward "\^M\\|\n" nil t
2)
404 (while (looking-at " \\|\^I")
405 (re-search-forward "\^M\\|\n" nil t
))
407 (subst-char-in-region date-start
409 (setq entry
(buffer-substring entry-start
(point))
410 temp
(diary-pull-attrs entry file-glob-attrs
)
416 (1+ date-start
) (1- entry-start
))
417 (copy-marker entry-start
) (nth 1 temp
))))))
420 (not diary-list-include-blanks
)
421 (setq diary-entries-list
422 (append diary-entries-list
423 (list (list date
"" "" "" "")))))
425 (calendar-gregorian-from-absolute
426 (1+ (calendar-absolute-from-gregorian date
))))
427 (setq entry-found nil
)))
428 (set-buffer-modified-p diary-modified
))
429 (set-syntax-table old-diary-syntax-table
))
430 (goto-char (point-min))
431 (run-hooks 'nongregorian-diary-listing-hook
432 'list-diary-entries-hook
)
433 (if diary-display-hook
434 (run-hooks 'diary-display-hook
)
435 (simple-diary-display))
436 (run-hooks 'diary-hook
)
437 diary-entries-list
))))
439 (defun include-other-diary-files ()
440 "Include the diary entries from other diary files with those of diary-file.
441 This function is suitable for use in `list-diary-entries-hook';
442 it enables you to use shared diary files together with your own.
443 The files included are specified in the diaryfile by lines of this form:
444 #include \"filename\"
445 This is recursive; that is, #include directives in diary files thus included
446 are obeyed. You can change the `#include' to some other string by
447 changing the variable `diary-include-string'."
448 (goto-char (point-min))
449 (while (re-search-forward
451 "\\(\\`\\|\^M\\|\n\\)"
452 (regexp-quote diary-include-string
)
455 (let* ((diary-file (substitute-in-file-name
456 (buffer-substring-no-properties
457 (match-beginning 2) (match-end 2))))
458 (diary-list-include-blanks nil
)
459 (list-diary-entries-hook 'include-other-diary-files
)
460 (diary-display-hook 'ignore
)
462 (d-buffer (find-buffer-visiting diary-file
))
463 (diary-modified (if d-buffer
465 (set-buffer d-buffer
)
466 (buffer-modified-p)))))
467 (if (file-exists-p diary-file
)
468 (if (file-readable-p diary-file
)
470 (setq diary-entries-list
471 (append diary-entries-list
472 (list-diary-entries original-date number
)))
474 (set-buffer (find-buffer-visiting diary-file
))
475 (let ((inhibit-read-only t
))
476 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
))
477 (setq selective-display nil
)
478 (set-buffer-modified-p diary-modified
)))
480 (message "Can't read included diary file %s" diary-file
)
483 (message "Can't find included diary file %s" diary-file
)
485 (goto-char (point-min)))
487 (defun simple-diary-display ()
488 "Display the diary buffer if there are any relevant entries or holidays."
489 (let* ((holiday-list (if holidays-in-diary-buffer
490 (check-calendar-holidays original-date
)))
491 (hol-string (format "%s%s%s"
493 (if holiday-list
": " "")
494 (mapconcat 'identity holiday-list
"; ")))
495 (msg (format "No diary entries for %s" hol-string
))
496 ;; If selected window is dedicated (to the calendar),
497 ;; need a new one to display the diary.
498 (pop-up-frames (window-dedicated-p (selected-window))))
499 (calendar-set-mode-line (format "Diary for %s" hol-string
))
500 (if (or (not diary-entries-list
)
501 (and (not (cdr diary-entries-list
))
502 (string-equal (car (cdr (car diary-entries-list
))) "")))
503 (if (< (length msg
) (frame-width))
505 (set-buffer (get-buffer-create holiday-buffer
))
506 (setq buffer-read-only nil
)
507 (calendar-set-mode-line date-string
)
509 (insert (mapconcat 'identity holiday-list
"\n"))
510 (goto-char (point-min))
511 (set-buffer-modified-p nil
)
512 (setq buffer-read-only t
)
513 (display-buffer holiday-buffer
)
514 (message "No diary entries for %s" date-string
))
515 (display-buffer (find-buffer-visiting
516 (substitute-in-file-name diary-file
)))
517 (message "Preparing diary...done"))))
519 (defface diary-button-face
'((((type pc
) (class color
))
520 (:foreground
"lightblue")))
521 "Default face used for buttons."
525 (define-button-type 'diary-entry
526 'action
#'diary-goto-entry
527 'face
#'diary-button-face
)
529 (defun diary-goto-entry (button)
530 (let ((marker (button-get button
'marker
)))
532 (pop-to-buffer (marker-buffer marker
))
533 (goto-char (marker-position marker
)))))
535 (defun fancy-diary-display ()
536 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
537 This function is provided for optional use as the `diary-display-hook'."
538 (save-excursion;; Turn off selective-display in the diary file's buffer.
539 (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file
)))
540 (let ((diary-modified (buffer-modified-p)))
541 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
542 (setq selective-display nil
)
543 (kill-local-variable 'mode-line-format
)
544 (set-buffer-modified-p diary-modified
)))
545 (if (or (not diary-entries-list
)
546 (and (not (cdr diary-entries-list
))
547 (string-equal (car (cdr (car diary-entries-list
))) "")))
548 (let* ((holiday-list (if holidays-in-diary-buffer
549 (check-calendar-holidays original-date
)))
550 (msg (format "No diary entries for %s %s"
551 (concat date-string
(if holiday-list
":" ""))
552 (mapconcat 'identity holiday-list
"; "))))
553 (if (<= (length msg
) (frame-width))
555 (set-buffer (get-buffer-create holiday-buffer
))
556 (setq buffer-read-only nil
)
558 (insert (mapconcat 'identity holiday-list
"\n"))
559 (goto-char (point-min))
560 (set-buffer-modified-p nil
)
561 (setq buffer-read-only t
)
562 (display-buffer holiday-buffer
)
563 (message "No diary entries for %s" date-string
)))
564 (save-excursion;; Prepare the fancy diary buffer.
565 (set-buffer (make-fancy-diary-buffer))
566 (setq buffer-read-only nil
)
567 (let ((entry-list diary-entries-list
)
569 (holiday-list-last-month 1)
570 (holiday-list-last-year 1)
573 (if (not (calendar-date-equal date
(car (car entry-list
))))
575 (setq date
(car (car entry-list
)))
576 (and holidays-in-diary-buffer
577 (calendar-date-compare
578 (list (list holiday-list-last-month
579 (calendar-last-day-of-month
580 holiday-list-last-month
581 holiday-list-last-year
)
582 holiday-list-last-year
))
584 ;; We need to get the holidays for the next 3 months.
585 (setq holiday-list-last-month
586 (extract-calendar-month date
))
587 (setq holiday-list-last-year
588 (extract-calendar-year date
))
590 (increment-calendar-month
591 holiday-list-last-month holiday-list-last-year
1)
594 (let ((displayed-month holiday-list-last-month
)
595 (displayed-year holiday-list-last-year
))
596 (calendar-holiday-list)))
597 (increment-calendar-month
598 holiday-list-last-month holiday-list-last-year
1))
599 (let* ((date-string (calendar-date-string date
))
601 (let ((h holiday-list
)
603 ;; Make a list of all holidays for date.
605 (if (calendar-date-equal date
(car (car h
)))
606 (setq d
(append d
(cdr (car h
)))))
609 (insert (if (= (point) (point-min)) "" ?
\n) date-string
)
610 (if date-holiday-list
(insert ": "))
611 (let* ((l (current-column))
613 (insert (mapconcat (lambda (x)
614 (if (< longest
(length x
))
615 (setq longest
(length x
)))
618 (concat "\n" (make-string l ?
))))
619 (insert ?
\n (make-string (+ l longest
) ?
=) ?
\n)))))
621 (setq entry
(car (cdr (car entry-list
))))
622 (if (< 0 (length entry
))
624 (if (nth 3 (car entry-list
))
625 (insert-button (concat entry
"\n")
626 'marker
(nth 3 (car entry-list
))
630 (let* ((marks (nth 4 (car entry-list
)))
631 (temp-face (make-symbol
634 (mapcar '(lambda (sym)
640 (make-face temp-face
)
641 ;; Remove :face info from the marks,
642 ;; copy the face info into temp-face
643 (while (setq faceinfo
(memq :face faceinfo
))
644 (copy-face (read (nth 1 faceinfo
)) temp-face
)
645 (setcar faceinfo nil
)
646 (setcar (cdr faceinfo
) nil
))
647 (setq marks
(delq nil marks
))
648 ;; Apply the font aspects
649 (apply 'set-face-attribute temp-face nil marks
)
650 (search-backward entry
)
652 (make-overlay (match-beginning 0) (match-end 0))
654 (setq entry-list
(cdr entry-list
))))
655 (set-buffer-modified-p nil
)
656 (goto-char (point-min))
657 (setq buffer-read-only t
)
658 (display-buffer fancy-diary-buffer
)
659 (fancy-diary-display-mode)
660 (calendar-set-mode-line date-string
)
661 (message "Preparing diary...done"))))
663 (defun make-fancy-diary-buffer ()
664 "Create and return the initial fancy diary buffer."
666 (set-buffer (get-buffer-create fancy-diary-buffer
))
667 (setq buffer-read-only nil
)
668 (calendar-set-mode-line "Diary Entries")
670 (set-buffer-modified-p nil
)
671 (setq buffer-read-only t
)
672 (get-buffer fancy-diary-buffer
)))
674 (defun print-diary-entries ()
675 "Print a hard copy of the diary display.
677 If the simple diary display is being used, prepare a temp buffer with the
678 visible lines of the diary buffer, add a heading line composed from the mode
679 line, print the temp buffer, and destroy it.
681 If the fancy diary display is being used, just print the buffer.
683 The hooks given by the variable `print-diary-entries-hook' are called to do
684 the actual printing."
686 (if (bufferp (get-buffer fancy-diary-buffer
))
688 (set-buffer (get-buffer fancy-diary-buffer
))
689 (run-hooks 'print-diary-entries-hook
))
691 (find-buffer-visiting (substitute-in-file-name diary-file
))))
693 (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
696 (set-buffer diary-buffer
)
698 (if (not (stringp mode-line-format
))
700 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format
)
701 (substring mode-line-format
702 (match-beginning 1) (match-end 1))))
703 (copy-to-buffer temp-buffer
(point-min) (point-max))
704 (set-buffer temp-buffer
)
705 (while (re-search-forward "\^M.*$" nil t
)
707 (goto-char (point-min))
709 (make-string (length heading
) ?
=) "\n")
710 (run-hooks 'print-diary-entries-hook
)
711 (kill-buffer temp-buffer
)))
712 (error "You don't have a diary buffer!")))))
714 (defun show-all-diary-entries ()
715 "Show all of the diary entries in the diary file.
716 This function gets rid of the selective display of the diary file so that
717 all entries, not just some, are visible. If there is no diary buffer, one
720 (let ((d-file (diary-check-diary-file))
721 (pop-up-frames (window-dedicated-p (selected-window))))
723 (set-buffer (or (find-buffer-visiting d-file
)
724 (find-file-noselect d-file t
)))
725 (let ((buffer-read-only nil
)
726 (diary-modified (buffer-modified-p)))
727 (subst-char-in-region (point-min) (point-max) ?\^M ?
\n t
)
728 (setq selective-display nil
729 mode-line-format default-mode-line-format
)
730 (display-buffer (current-buffer))
731 (set-buffer-modified-p diary-modified
)))))
733 (defcustom diary-mail-addr
734 (if (boundp 'user-mail-address
) user-mail-address
"")
735 "*Email address that `diary-mail-entries' will send email to."
740 (defcustom diary-mail-days
7
741 "*Default number of days for `diary-mail-entries' to check."
747 (defun diary-mail-entries (&optional ndays
)
748 "Send a mail message showing diary entries for next NDAYS days.
749 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
750 Mail is sent to the address specified by `diary-mail-addr'.
752 You can call `diary-mail-entries' every night using an at/cron job.
753 For example, this script will run the program at 2am daily. Since
754 `emacs -batch' does not load your `.emacs' file, you must ensure that
755 all relevant variables are set, as done here.
758 # diary-rem.sh -- repeatedly run the Emacs diary-reminder
760 -eval \"(setq diary-mail-days 3 \\
761 diary-file \\\"/path/to/diary.file\\\" \\
762 european-calendar-style t \\
763 diary-mail-addr \\\"user@host.name\\\" )\" \\
764 -l diary-lib -f diary-mail-entries
765 at -f diary-rem.sh 0200 tomorrow
767 You may have to tweak the syntax of the `at' command to suit your
768 system. Alternatively, you can specify a cron entry:
769 0 1 * * * diary-rem.sh
770 to run it every morning at 1am."
772 (if (string-equal diary-mail-addr
"")
773 (error "You must set `diary-mail-addr' to use this command")
774 (let ((diary-display-hook 'fancy-diary-display
))
775 (list-diary-entries (calendar-current-date) (or ndays diary-mail-days
)))
776 (compose-mail diary-mail-addr
777 (concat "Diary entries generated "
778 (calendar-date-string (calendar-current-date))))
780 (if (get-buffer fancy-diary-buffer
)
782 (set-buffer fancy-diary-buffer
)
783 (buffer-substring (point-min) (point-max)))
785 (call-interactively (get mail-user-agent
'sendfunc
))))
787 (defun diary-name-pattern (string-array &optional abbrev-array paren
)
788 "Return a regexp matching the strings in the array STRING-ARRAY.
789 If the optional argument ABBREV-ARRAY is present, then the function
790 `calendar-abbrev-construct' is used to construct abbreviations from the
791 two supplied arrays. The returned regexp will then also match these
792 abbreviations, with or without final `.' characters. If the optional
793 argument PAREN is non-nil, the regexp is surrounded by parentheses."
794 (regexp-opt (append string-array
796 (calendar-abbrev-construct abbrev-array
799 (calendar-abbrev-construct abbrev-array
805 (defvar marking-diary-entries nil
806 "True during the marking of diary entries, nil otherwise.")
808 (defvar marking-diary-entry nil
809 "True during the marking of diary entries, if current entry is marking.")
811 (defun mark-diary-entries ()
812 "Mark days in the calendar window that have diary entries.
813 Each entry in the diary file visible in the calendar window is marked.
814 After the entries are marked, the hooks `nongregorian-diary-marking-hook' and
815 `mark-diary-entries-hook' are run."
817 (setq mark-diary-entries-in-calendar t
)
818 (let ((marking-diary-entries t
)
819 file-glob-attrs marks
)
821 (set-buffer (find-file-noselect (diary-check-diary-file) t
))
822 (message "Marking diary entries...")
823 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
'())))
824 (let ((d diary-date-forms
)
825 (old-diary-syntax-table (syntax-table))
827 (set-syntax-table diary-syntax-table
)
829 (let* ((date-form (if (equal (car (car d
)) 'backup
)
831 (car d
)));; ignore 'backup directive
833 (diary-name-pattern calendar-day-name-array
834 calendar-day-abbrev-array
))
837 (diary-name-pattern calendar-month-name-array
838 calendar-month-abbrev-array
)))
839 (month "[0-9]+\\|\\*")
841 (year "[0-9]+\\|\\*")
842 (l (length date-form
))
843 (d-name-pos (- l
(length (memq 'dayname date-form
))))
844 (d-name-pos (if (/= l d-name-pos
) (+ 2 d-name-pos
)))
845 (m-name-pos (- l
(length (memq 'monthname date-form
))))
846 (m-name-pos (if (/= l m-name-pos
) (+ 2 m-name-pos
)))
847 (d-pos (- l
(length (memq 'day date-form
))))
848 (d-pos (if (/= l d-pos
) (+ 2 d-pos
)))
849 (m-pos (- l
(length (memq 'month date-form
))))
850 (m-pos (if (/= l m-pos
) (+ 2 m-pos
)))
851 (y-pos (- l
(length (memq 'year date-form
))))
852 (y-pos (if (/= l y-pos
) (+ 2 y-pos
)))
855 "\\(\\`\\|\^M\\|\n\\)\\("
856 (mapconcat 'eval date-form
"\\)\\(")
858 (case-fold-search t
))
859 (goto-char (point-min))
860 (while (re-search-forward regexp nil t
)
863 (buffer-substring-no-properties
864 (match-beginning d-name-pos
)
865 (match-end d-name-pos
))))
868 (buffer-substring-no-properties
869 (match-beginning m-name-pos
)
870 (match-end m-name-pos
))))
873 (buffer-substring-no-properties
874 (match-beginning m-pos
)
879 (buffer-substring-no-properties
880 (match-beginning d-pos
)
884 (buffer-substring-no-properties
885 (match-beginning y-pos
)
889 (if (and (= (length y-str
) 2)
890 abbreviated-calendar-year
)
892 (extract-calendar-year
893 (calendar-current-date)))
894 (y (+ (string-to-int y-str
)
896 (/ current-y
100)))))
897 (if (> (- y current-y
) 50)
899 (if (> (- current-y y
) 50)
902 (string-to-int y-str
))))
904 (setq entry
(buffer-substring-no-properties
905 (point) (line-end-position))
906 temp
(diary-pull-attrs entry file-glob-attrs
)
908 marks
(nth 1 temp
))))
910 (mark-calendar-days-named
914 calendar-day-name-array
915 0 nil calendar-day-abbrev-array
) t
)) marks
)
918 (if (string-equal mm-name
"*") 0
922 calendar-month-name-array
923 1 nil calendar-month-abbrev-array
) t
)))))
924 (mark-calendar-date-pattern mm dd yy marks
))))
926 (mark-sexp-diary-entries)
927 (run-hooks 'nongregorian-diary-marking-hook
928 'mark-diary-entries-hook
)
929 (set-syntax-table old-diary-syntax-table
)
930 (message "Marking diary entries...done")))))
932 (defun mark-sexp-diary-entries ()
933 "Mark days in the calendar window that have sexp diary entries.
934 Each entry in the diary file (or included files) visible in the calendar window
935 is marked. See the documentation for the function `list-sexp-diary-entries'."
936 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol
))
937 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
938 sexp-mark
"(\\)\\|\\("
939 (regexp-quote diary-nonmarking-symbol
)
940 sexp-mark
"(diary-remind\\)"))
941 (file-glob-attrs (nth 1 (diary-pull-attrs nil
'())))
942 m y first-date last-date mark file-glob-attrs
)
944 (set-buffer calendar-buffer
)
945 (setq m displayed-month
)
946 (setq y displayed-year
))
947 (increment-calendar-month m y -
1)
949 (calendar-absolute-from-gregorian (list m
1 y
)))
950 (increment-calendar-month m y
2)
952 (calendar-absolute-from-gregorian
953 (list m
(calendar-last-day-of-month m y
) y
)))
954 (goto-char (point-min))
955 (while (re-search-forward s-entry nil t
)
956 (setq marking-diary-entry
(char-equal (preceding-char) ?\
())
957 (re-search-backward "(")
958 (let ((sexp-start (point))
959 sexp entry entry-start line-start marks
)
961 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
963 (re-search-backward "\^M\\|\n\\|\\`")
964 (setq line-start
(point)))
966 (if (and (or (char-equal (preceding-char) ?\^M
)
967 (char-equal (preceding-char) ?
\n))
968 (not (looking-at " \\|\^I")))
969 (progn;; Diary entry consists only of the sexp
972 (setq entry-start
(point))
974 (re-search-forward "\^M\\|\n" nil t
)
975 (while (looking-at " \\|\^I")
976 (or (re-search-forward "\^M\\|\n" nil t
)
977 (re-search-forward "$" nil t
)))
978 (if (or (char-equal (preceding-char) ?\^M
)
979 (char-equal (preceding-char) ?
\n))
981 (setq entry
(buffer-substring-no-properties entry-start
(point)))
982 (while (string-match "[\^M]" entry
)
983 (aset entry
(match-beginning 0) ?
\n )))
984 (calendar-for-loop date from first-date to last-date do
985 (if (setq mark
(diary-sexp-entry sexp entry
986 (calendar-gregorian-from-absolute date
)))
988 (setq marks
(diary-pull-attrs entry file-glob-attrs
)
989 marks
(nth 1 (diary-pull-attrs entry file-glob-attrs
)))
990 (mark-visible-calendar-date
991 (calendar-gregorian-from-absolute date
)
992 (if (< 0 (length marks
))
997 (defun mark-included-diary-files ()
998 "Mark the diary entries from other diary files with those of the diary file.
999 This function is suitable for use as the `mark-diary-entries-hook'; it enables
1000 you to use shared diary files together with your own. The files included are
1001 specified in the diary-file by lines of this form:
1002 #include \"filename\"
1003 This is recursive; that is, #include directives in diary files thus included
1004 are obeyed. You can change the `#include' to some other string by
1005 changing the variable `diary-include-string'."
1006 (goto-char (point-min))
1007 (while (re-search-forward
1009 "\\(\\`\\|\^M\\|\n\\)"
1010 (regexp-quote diary-include-string
)
1011 " \"\\([^\"]*\\)\"")
1013 (let ((diary-file (substitute-in-file-name
1014 (buffer-substring-no-properties
1015 (match-beginning 2) (match-end 2))))
1016 (mark-diary-entries-hook 'mark-included-diary-files
))
1017 (if (file-exists-p diary-file
)
1018 (if (file-readable-p diary-file
)
1020 (mark-diary-entries)
1021 (kill-buffer (find-buffer-visiting diary-file
)))
1023 (message "Can't read included diary file %s" diary-file
)
1026 (message "Can't find included diary file %s" diary-file
)
1028 (goto-char (point-min)))
1030 (defun mark-calendar-days-named (dayname &optional color
)
1031 "Mark all dates in the calendar window that are day DAYNAME of the week.
1032 0 means all Sundays, 1 means all Mondays, and so on."
1034 (set-buffer calendar-buffer
)
1035 (let ((prev-month displayed-month
)
1036 (prev-year displayed-year
)
1037 (succ-month displayed-month
)
1038 (succ-year displayed-year
)
1041 (increment-calendar-month succ-month succ-year
1)
1042 (increment-calendar-month prev-month prev-year -
1)
1043 (setq day
(calendar-absolute-from-gregorian
1044 (calendar-nth-named-day 1 dayname prev-month prev-year
)))
1045 (setq last-day
(calendar-absolute-from-gregorian
1046 (calendar-nth-named-day -
1 dayname succ-month succ-year
)))
1047 (while (<= day last-day
)
1048 (mark-visible-calendar-date (calendar-gregorian-from-absolute day
) color
)
1049 (setq day
(+ day
7))))))
1051 (defun mark-calendar-date-pattern (month day year
&optional color
)
1052 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
1053 A value of 0 in any position is a wildcard."
1055 (set-buffer calendar-buffer
)
1056 (let ((m displayed-month
)
1058 (increment-calendar-month m y -
1)
1059 (calendar-for-loop i from
0 to
2 do
1060 (mark-calendar-month m y month day year color
)
1061 (increment-calendar-month m y
1)))))
1063 (defun mark-calendar-month (month year p-month p-day p-year
&optional color
)
1064 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
1065 A value of 0 in any position of the pattern is a wildcard."
1066 (if (or (and (= month p-month
)
1067 (or (= p-year
0) (= year p-year
)))
1069 (or (= p-year
0) (= year p-year
))))
1072 i from
1 to
(calendar-last-day-of-month month year
) do
1073 (mark-visible-calendar-date (list month i year
) color
))
1074 (mark-visible-calendar-date (list month p-day year
) color
))))
1076 (defun sort-diary-entries ()
1077 "Sort the list of diary entries by time of day."
1078 (setq diary-entries-list
(sort diary-entries-list
'diary-entry-compare
)))
1080 (defun diary-entry-compare (e1 e2
)
1081 "Returns t if E1 is earlier than E2."
1082 (or (calendar-date-compare e1 e2
)
1083 (and (calendar-date-equal (car e1
) (car e2
))
1084 (let* ((ts1 (cadr e1
)) (t1 (diary-entry-time ts1
))
1085 (ts2 (cadr e2
)) (t2 (diary-entry-time ts2
)))
1088 (string-lessp ts1 ts2
)))))))
1090 (defcustom diary-unknown-time
1092 "*Value returned by diary-entry-time when no time is found.
1093 The default value -9999 causes entries with no recognizable time to be placed
1094 before those with times; 9999 would place entries with no recognizable time
1095 after those with times."
1100 (defun diary-entry-time (s)
1101 "Return time at the beginning of the string S as a military-style integer.
1102 For example, returns 1325 for 1:25pm.
1104 Returns `diary-unknown-time' (default value -9999) if no time is recognized.
1105 The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
1106 XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A period (.) can
1107 be used instead of a colon (:) to separate the hour and minute parts."
1108 (let ((case-fold-search nil
))
1109 (cond ((string-match ; Military time
1110 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
1112 (+ (* 100 (string-to-int
1113 (substring s
(match-beginning 1) (match-end 1))))
1114 (string-to-int (substring s
(match-beginning 2) (match-end 2)))))
1115 ((string-match ; Hour only XXam or XXpm
1116 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s
)
1117 (+ (* 100 (%
(string-to-int
1118 (substring s
(match-beginning 1) (match-end 1)))
1120 (if (equal ?a
(downcase (aref s
(match-beginning 2))))
1122 ((string-match ; Hour and minute XX:XXam or XX:XXpm
1123 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s
)
1124 (+ (* 100 (%
(string-to-int
1125 (substring s
(match-beginning 1) (match-end 1)))
1127 (string-to-int (substring s
(match-beginning 2) (match-end 2)))
1128 (if (equal ?a
(downcase (aref s
(match-beginning 3))))
1130 (t diary-unknown-time
)))) ; Unrecognizable
1132 (defun list-sexp-diary-entries (date)
1133 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
1134 Also, Make them visible in the diary file. Returns t if any entries were
1137 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
1138 `%%'). The form of a sexp diary entry is
1142 Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
1143 SEXP yields the value nil, the diary entry does not apply. If it yields a
1144 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1145 string, that string will be the diary entry in the fancy diary display.
1147 For example, the following diary entry will apply to the 21st of the month
1148 if it is a weekday and the Friday before if the 21st is on a weekend:
1150 &%%(let ((dayname (calendar-day-of-week date))
1151 (day (extract-calendar-day date)))
1153 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1154 (and (memq day '(19 20)) (= dayname 5)))
1155 ) UIUC pay checks deposited
1157 A number of built-in functions are available for this type of diary entry:
1159 %%(diary-date MONTH DAY YEAR &optional MARK) text
1160 Entry applies if date is MONTH, DAY, YEAR if
1161 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1162 `european-calendar-style' is t. DAY, MONTH, and YEAR
1163 can be lists of integers, the constant t, or an integer.
1164 The constant t means all values. An optional parameter
1165 MARK specifies a face or single-character string to use
1166 when highlighting the day in the calendar.
1168 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
1169 Entry will appear on the Nth DAYNAME of MONTH.
1170 (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1171 if N is negative it counts backward from the end of
1172 the month. MONTH can be a list of months, a single
1173 month, or t to specify all months. Optional DAY means
1174 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
1175 to 1 if N>0 and the last day of the month if N<0. An
1176 optional parameter MARK specifies a face or single-character
1177 string to use when highlighting the day in the calendar.
1179 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
1180 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1181 inclusive. (If `european-calendar-style' is t, the
1182 order of the parameters should be changed to D1, M1, Y1,
1183 D2, M2, Y2.) An optional parameter MARK specifies a face
1184 or single-character string to use when highlighting the
1185 day in the calendar.
1187 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
1188 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1189 (If `european-calendar-style' is t, the order of the
1190 parameters should be changed to DAY, MONTH, YEAR.) Text
1191 can contain %d or %d%s; %d will be replaced by the number
1192 of years since the MONTH DAY, YEAR and %s will be replaced
1193 by the ordinal ending of that number (that is, `st', `nd',
1194 `rd' or `th', as appropriate. The anniversary of February
1195 29 is considered to be March 1 in a non-leap year. An
1196 optional parameter MARK specifies a face or single-character
1197 string to use when highlighting the day in the calendar.
1199 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
1200 Entry will appear every N days, starting MONTH DAY, YEAR.
1201 (If `european-calendar-style' is t, the order of the
1202 parameters should be changed to N, DAY, MONTH, YEAR.) Text
1203 can contain %d or %d%s; %d will be replaced by the number
1204 of repetitions since the MONTH DAY, YEAR and %s will
1205 be replaced by the ordinal ending of that number (that is,
1206 `st', `nd', `rd' or `th', as appropriate. An optional
1207 parameter MARK specifies a face or single-character string
1208 to use when highlighting the day in the calendar.
1210 %%(diary-remind SEXP DAYS &optional MARKING) text
1211 Entry is a reminder for diary sexp SEXP. DAYS is either a
1212 single number or a list of numbers indicating the number(s)
1213 of days before the event that the warning(s) should occur.
1214 If the current date is (one of) DAYS before the event
1215 indicated by EXPR, then a suitable message (as specified
1216 by `diary-remind-message') appears. In addition to the
1217 reminders beforehand, the diary entry also appears on
1218 the date itself. If optional MARKING is non-nil then the
1219 *reminders* are marked on the calendar. Marking of
1220 reminders is independent of whether the entry *itself* is
1221 a marking or nonmarking one.
1223 %%(diary-day-of-year)
1224 Diary entries giving the day of the year and the number of
1225 days remaining in the year will be made every day. Note
1226 that since there is no text, it makes sense only if the
1227 fancy diary display is used.
1230 Diary entries giving the corresponding ISO commercial date
1231 will be made every day. Note that since there is no text,
1232 it makes sense only if the fancy diary display is used.
1234 %%(diary-french-date)
1235 Diary entries giving the corresponding French Revolutionary
1236 date will be made every day. Note that since there is no
1237 text, it makes sense only if the fancy diary display is used.
1239 %%(diary-islamic-date)
1240 Diary entries giving the corresponding Islamic date will be
1241 made every day. Note that since there is no text, it
1242 makes sense only if the fancy diary display is used.
1244 %%(diary-hebrew-date)
1245 Diary entries giving the corresponding Hebrew date will be
1246 made every day. Note that since there is no text, it
1247 makes sense only if the fancy diary display is used.
1249 %%(diary-astro-day-number) Diary entries giving the corresponding
1250 astronomical (Julian) day number will be made every day.
1251 Note that since there is no text, it makes sense only if the
1252 fancy diary display is used.
1254 %%(diary-julian-date) Diary entries giving the corresponding
1255 Julian date will be made every day. Note that since
1256 there is no text, it makes sense only if the fancy diary
1259 %%(diary-sunrise-sunset)
1260 Diary entries giving the local times of sunrise and sunset
1261 will be made every day. Note that since there is no text,
1262 it makes sense only if the fancy diary display is used.
1263 Floating point required.
1265 %%(diary-phases-of-moon)
1266 Diary entries giving the times of the phases of the moon
1267 will be when appropriate. Note that since there is no text,
1268 it makes sense only if the fancy diary display is used.
1269 Floating point required.
1271 %%(diary-yahrzeit MONTH DAY YEAR) text
1272 Text is assumed to be the name of the person; the date is
1273 the date of death on the *civil* calendar. The diary entry
1274 will appear on the proper Hebrew-date anniversary and on the
1275 day before. (If `european-calendar-style' is t, the order
1276 of the parameters should be changed to DAY, MONTH, YEAR.)
1278 %%(diary-rosh-hodesh)
1279 Diary entries will be made on the dates of Rosh Hodesh on
1280 the Hebrew calendar. Note that since there is no text, it
1281 makes sense only if the fancy diary display is used.
1284 Diary entries giving the weekly parasha will be made on
1285 every Saturday. Note that since there is no text, it
1286 makes sense only if the fancy diary display is used.
1289 Diary entries giving the omer count will be made every day
1290 from Passover to Shavuot. Note that since there is no text,
1291 it makes sense only if the fancy diary display is used.
1293 Marking these entries is *extremely* time consuming, so these entries are
1294 best if they are nonmarking."
1295 (let ((s-entry (concat "\\(\\`\\|\^M\\|\n\\)"
1296 (regexp-quote diary-nonmarking-symbol
)
1298 (regexp-quote sexp-diary-entry-symbol
)
1300 entry-found file-glob-attrs marks
)
1301 (goto-char (point-min))
1303 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
'()))))
1304 (while (re-search-forward s-entry nil t
)
1306 (let ((sexp-start (point))
1307 sexp entry specifier entry-start line-start
)
1309 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
1311 (re-search-backward "\^M\\|\n\\|\\`")
1312 (setq line-start
(point)))
1314 (buffer-substring-no-properties (1+ line-start
) (point))
1315 entry-start
(1+ line-start
))
1317 (if (and (or (char-equal (preceding-char) ?\^M
)
1318 (char-equal (preceding-char) ?
\n))
1319 (not (looking-at " \\|\^I")))
1320 (progn;; Diary entry consists only of the sexp
1323 (setq entry-start
(point))
1324 (re-search-forward "\^M\\|\n" nil t
)
1325 (while (looking-at " \\|\^I")
1326 (re-search-forward "\^M\\|\n" nil t
))
1328 (setq entry
(buffer-substring-no-properties entry-start
(point)))
1329 (while (string-match "[\^M]" entry
)
1330 (aset entry
(match-beginning 0) ?
\n )))
1331 (let ((diary-entry (diary-sexp-entry sexp entry date
))
1333 (setq entry
(if (consp diary-entry
)
1338 (subst-char-in-region line-start
(point) ?\^M ?
\n t
)
1339 (if (< 0 (length entry
))
1340 (setq temp
(diary-pull-attrs entry file-glob-attrs
)
1342 marks
(nth 1 temp
)))))
1343 (add-to-diary-list date
1346 (if entry-start
(copy-marker entry-start
)
1349 (setq entry-found
(or entry-found diary-entry
)))))
1352 (defun diary-sexp-entry (sexp entry date
)
1353 "Process a SEXP diary ENTRY for DATE."
1354 (let ((result (if calendar-debug-sexp
1355 (let ((stack-trace-on-error t
))
1356 (eval (car (read-from-string sexp
))))
1358 (eval (car (read-from-string sexp
)))
1361 (message "Bad sexp at line %d in %s: %s"
1364 (narrow-to-region 1 (point))
1365 (goto-char (point-min))
1367 (while (re-search-forward "\n\\|\^M" nil t
)
1368 (setq lines
(1+ lines
)))
1372 (cond ((stringp result
) result
)
1373 ((and (consp result
)
1374 (stringp (cdr result
))) result
)
1378 (defun diary-date (month day year
&optional mark
)
1379 "Specific date(s) diary entry.
1380 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1381 and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR
1382 can be lists of integers, the constant t, or an integer. The constant t means
1385 An optional parameter MARK specifies a face or single-character string to
1386 use when highlighting the day in the calendar."
1387 (let ((dd (if european-calendar-style
1390 (mm (if european-calendar-style
1393 (m (extract-calendar-month date
))
1394 (y (extract-calendar-year date
))
1395 (d (extract-calendar-day date
)))
1397 (or (and (listp dd
) (memq d dd
))
1400 (or (and (listp mm
) (memq m mm
))
1403 (or (and (listp year
) (memq y year
))
1406 (cons mark entry
))))
1408 (defun diary-block (m1 d1 y1 m2 d2 y2
&optional mark
)
1410 Entry applies if date is between, or on one of, two dates.
1411 The order of the parameters is
1412 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1413 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t.
1415 An optional parameter MARK specifies a face or single-character string to
1416 use when highlighting the day in the calendar."
1418 (let ((date1 (calendar-absolute-from-gregorian
1419 (if european-calendar-style
1422 (date2 (calendar-absolute-from-gregorian
1423 (if european-calendar-style
1426 (d (calendar-absolute-from-gregorian date
)))
1427 (if (and (<= date1 d
) (<= d date2
))
1428 (cons mark entry
))))
1430 (defun diary-float (month dayname n
&optional day mark
)
1431 "Floating diary entry--entry applies if date is the nth dayname of month.
1432 Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant
1433 t, or an integer. The constant t means all months. If N is negative, count
1434 backward from the end of the month.
1436 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY.
1437 Optional MARK specifies a face or single-character string to use when
1438 highlighting the day in the calendar."
1439 ;; This is messy because the diary entry may apply, but the date on which it
1440 ;; is based can be in a different month/year. For example, asking for the
1441 ;; first Monday after December 30. For large values of |n| the problem is
1443 (and (= dayname
(calendar-day-of-week date
))
1444 (let* ((m (extract-calendar-month date
))
1445 (d (extract-calendar-day date
))
1446 (y (extract-calendar-year date
))
1447 (limit; last (n>0) or first (n<0) possible base date for entry
1448 (calendar-nth-named-absday (- n
) dayname m y d
))
1449 (last-abs (if (> n
0) limit
(+ limit
6)))
1450 (first-abs (if (> n
0) (- limit
6) limit
))
1451 (last (calendar-gregorian-from-absolute last-abs
))
1452 (first (calendar-gregorian-from-absolute first-abs
))
1453 ; m1, d1 is first possible base date
1454 (m1 (extract-calendar-month first
))
1455 (d1 (extract-calendar-day first
))
1456 (y1 (extract-calendar-year first
))
1457 ; m2, d2 is last possible base date
1458 (m2 (extract-calendar-month last
))
1459 (d2 (extract-calendar-day last
))
1460 (y2 (extract-calendar-year last
)))
1461 (if (or (and (= m1 m2
) ; only possible base dates in one month
1466 (let ((d (or day
(if (> n
0)
1468 (calendar-last-day-of-month m1 y1
)))))
1469 (and (<= d1 d
) (<= d d2
))))
1470 ;; only possible base dates straddle two months
1472 (and (= y1 y2
) (< m1 m2
)))
1474 ;; m1, d1 works as a base date
1480 (<= d1
(or day
(if (> n
0)
1482 (calendar-last-day-of-month m1 y1
)))))
1483 ;; m2, d2 works as a base date
1484 (and (or (eq month t
)
1488 (<= (or day
(if (> n
0)
1490 (calendar-last-day-of-month m2 y2
)))
1492 (cons mark entry
)))))
1495 (defun diary-anniversary (month day year
&optional mark
)
1496 "Anniversary diary entry.
1497 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1498 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1499 `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
1500 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1501 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1502 `rd' or `th', as appropriate. The anniversary of February 29 is considered
1503 to be March 1 in non-leap years.
1505 An optional parameter MARK specifies a face or single-character string to
1506 use when highlighting the day in the calendar."
1507 (let* ((d (if european-calendar-style
1510 (m (if european-calendar-style
1513 (y (extract-calendar-year date
))
1515 (if (and (= m
2) (= d
29) (not (calendar-leap-year-p y
)))
1518 (if (and (> diff
0) (calendar-date-equal (list m d y
) date
))
1519 (cons mark
(format entry diff
(diary-ordinal-suffix diff
))))))
1521 (defun diary-cyclic (n month day year
&optional mark
)
1522 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1523 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1524 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1525 repetitions since the MONTH DAY, YEAR and %s will be replaced by the
1526 ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
1529 An optional parameter MARK specifies a face or single-character string to
1530 use when highlighting the day in the calendar."
1531 (let* ((d (if european-calendar-style
1534 (m (if european-calendar-style
1537 (diff (- (calendar-absolute-from-gregorian date
)
1538 (calendar-absolute-from-gregorian
1541 (if (and (>= diff
0) (zerop (% diff n
)))
1542 (cons mark
(format entry cycle
(diary-ordinal-suffix cycle
))))))
1544 (defun diary-ordinal-suffix (n)
1545 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1546 (if (or (memq (% n
100) '(11 12 13))
1549 (aref ["th" "st" "nd" "rd"] (% n
10))))
1551 (defun diary-day-of-year ()
1552 "Day of year and number of days remaining in the year of date diary entry."
1553 (calendar-day-of-year-string date
))
1555 (defcustom diary-remind-message
1557 (if (= 0 (% days
7))
1558 (concat (int-to-string (/ days
7)) (if (= 7 days
) " week" " weeks"))
1559 (concat (int-to-string days
) (if (= 1 days
) " day" " days")))
1562 "*Pseudo-pattern giving form of reminder messages in the fancy diary
1565 Used by the function `diary-remind', a pseudo-pattern is a list of
1566 expressions that can involve the keywords `days' (a number), `date' (a list of
1567 month, day, year), and `diary-entry' (a string)."
1571 (defun diary-remind (sexp days
&optional marking
)
1572 "Provide a reminder of a diary entry.
1573 SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
1574 indicating the number(s) of days before the event that the warning(s) should
1575 occur on. If the current date is (one of) DAYS before the event indicated by
1576 SEXP, then a suitable message (as specified by `diary-remind-message' is
1579 In addition to the reminders beforehand, the diary entry also appears on the
1582 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1583 entry specifies that the diary entry (not the reminder) is non-marking.
1584 Marking of reminders is independent of whether the entry itself is a marking
1585 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1586 marked on the calendar."
1587 (let ((diary-entry (eval sexp
)))
1589 ;; Diary entry applies on date
1591 (or (not marking-diary-entries
) marking-diary-entry
))
1593 ;; Diary entry may apply to `days' before date
1594 ((and (integerp days
)
1595 (not diary-entry
); Diary entry does not apply to date
1596 (or (not marking-diary-entries
) marking
))
1597 (let ((date (calendar-gregorian-from-absolute
1598 (+ (calendar-absolute-from-gregorian date
) days
))))
1599 (if (setq diary-entry
(eval sexp
))
1600 (mapconcat 'eval diary-remind-message
""))))
1601 ;; Diary entry may apply to one of a list of days before date
1602 ((and (listp days
) days
)
1603 (or (diary-remind sexp
(car days
) marking
)
1604 (diary-remind sexp
(cdr days
) marking
))))))
1606 (defun add-to-diary-list (date string specifier marker
&optional globcolor
)
1607 "Add the entry (DATE STRING SPECIFIER MARKER GLOBCOLOR) to `diary-entries-list'.
1608 Do nothing if DATE or STRING is nil."
1609 (when (and date string
)
1610 (if diary-file-name-prefix
1611 (let ((prefix (funcall diary-file-name-prefix-function
1612 (buffer-file-name))))
1613 (or (string= prefix
"")
1614 (setq string
(format "[%s] %s" prefix string
)))))
1615 (setq diary-entries-list
1616 (append diary-entries-list
1617 (list (list date string specifier marker globcolor
))))))
1619 (defun make-diary-entry (string &optional nonmarking file
)
1620 "Insert a diary entry STRING which may be NONMARKING in FILE.
1621 If omitted, NONMARKING defaults to nil and FILE defaults to `diary-file'."
1622 (let ((pop-up-frames (window-dedicated-p (selected-window))))
1623 (find-file-other-window (substitute-in-file-name (or file diary-file
))))
1625 (goto-char (point-max))
1626 (when (let ((case-fold-search t
))
1627 (search-backward "Local Variables:"
1628 (max (- (point-max) 3000) (point-min))
1635 (if nonmarking diary-nonmarking-symbol
"")
1638 (defun insert-diary-entry (arg)
1639 "Insert a diary entry for the date indicated by point.
1640 Prefix arg will make the entry nonmarking."
1642 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t t
)
1645 (defun insert-weekly-diary-entry (arg)
1646 "Insert a weekly diary entry for the day of the week indicated by point.
1647 Prefix arg will make the entry nonmarking."
1649 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t
))
1652 (defun insert-monthly-diary-entry (arg)
1653 "Insert a monthly diary entry for the day of the month indicated by point.
1654 Prefix arg will make the entry nonmarking."
1656 (let ((calendar-date-display-form
1657 (if european-calendar-style
1660 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t
)
1663 (defun insert-yearly-diary-entry (arg)
1664 "Insert an annual diary entry for the day of the year indicated by point.
1665 Prefix arg will make the entry nonmarking."
1667 (let ((calendar-date-display-form
1668 (if european-calendar-style
1669 '(day " " monthname
)
1670 '(monthname " " day
))))
1671 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t
) t
)
1674 (defun insert-anniversary-diary-entry (arg)
1675 "Insert an anniversary diary entry for the date given by point.
1676 Prefix arg will make the entry nonmarking."
1678 (let ((calendar-date-display-form
1679 (if european-calendar-style
1680 '(day " " month
" " year
)
1681 '(month " " day
" " year
))))
1683 (format "%s(diary-anniversary %s)"
1684 sexp-diary-entry-symbol
1685 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
1688 (defun insert-block-diary-entry (arg)
1689 "Insert a block diary entry for the days between the point and marked date.
1690 Prefix arg will make the entry nonmarking."
1692 (let ((calendar-date-display-form
1693 (if european-calendar-style
1694 '(day " " month
" " year
)
1695 '(month " " day
" " year
)))
1696 (cursor (calendar-cursor-to-date t
))
1697 (mark (or (car calendar-mark-ring
)
1698 (error "No mark set in this buffer")))
1700 (if (< (calendar-absolute-from-gregorian mark
)
1701 (calendar-absolute-from-gregorian cursor
))
1707 (format "%s(diary-block %s %s)"
1708 sexp-diary-entry-symbol
1709 (calendar-date-string start nil t
)
1710 (calendar-date-string end nil t
))
1713 (defun insert-cyclic-diary-entry (arg)
1714 "Insert a cyclic diary entry starting at the date given by point.
1715 Prefix arg will make the entry nonmarking."
1717 (let ((calendar-date-display-form
1718 (if european-calendar-style
1719 '(day " " month
" " year
)
1720 '(month " " day
" " year
))))
1722 (format "%s(diary-cyclic %d %s)"
1723 sexp-diary-entry-symbol
1724 (calendar-read "Repeat every how many days: "
1725 (lambda (x) (> x
0)))
1726 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
1730 (define-derived-mode diary-mode text-mode
1732 "Major mode for editing the diary file."
1733 (set (make-local-variable 'font-lock-defaults
)
1734 '(diary-font-lock-keywords t
)))
1736 (define-derived-mode fancy-diary-display-mode text-mode
1738 "Major mode used while displaying diary entries using Fancy Display."
1739 (set (make-local-variable 'font-lock-defaults
)
1740 '(fancy-diary-font-lock-keywords t
))
1741 (define-key (current-local-map) "q" 'quit-window
))
1744 (defvar fancy-diary-font-lock-keywords
1748 (let ((dayname (diary-name-pattern calendar-day-name-array nil t
))
1749 (monthname (diary-name-pattern calendar-month-name-array nil t
))
1753 (mapconcat 'eval calendar-date-display-form
""))
1754 "\\(\\(: .*\\)\\|\\(\n +.*\\)\\)*\n=+$")
1756 '("^.*anniversary.*$" . font-lock-keyword-face
)
1757 '("^.*birthday.*$" . font-lock-keyword-face
)
1758 '("^.*Yahrzeit.*$" . font-lock-reference-face
)
1759 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face
)
1760 '("^Day.*omer.*$" . font-lock-builtin-face
)
1761 '("^Parashat.*$" . font-lock-comment-face
)
1762 '("^[ \t]*[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)?\\(-[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)?\\)?"
1763 . font-lock-variable-name-face
))
1764 "Keywords to highlight in fancy diary display")
1767 (defun font-lock-diary-sexps (limit)
1768 "Recognize sexp diary entry for font-locking."
1769 (if (re-search-forward
1770 (concat "^" (regexp-quote diary-nonmarking-symbol
)
1771 "?\\(" (regexp-quote sexp-diary-entry-symbol
) "\\)")
1775 (narrow-to-region (point-min) limit
)
1776 (let ((start (point)))
1778 (store-match-data (list start
(point)))
1782 (defun font-lock-diary-date-forms (month-array &optional symbol abbrev-array
)
1783 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY.
1784 If given, optional SYMBOL must be a prefix to entries.
1785 If optional ABBREV-ARRAY is present, the abbreviations constructed
1786 from this array by the function `calendar-abbrev-construct' are
1787 matched (with or without a final `.'), in addition to the full month
1789 (let ((dayname (diary-name-pattern calendar-day-name-array
1790 calendar-day-abbrev-array t
))
1791 (monthname (format "\\(%s\\|\\*\\)"
1792 (diary-name-pattern month-array abbrev-array
)))
1793 (month "\\([0-9]+\\|\\*\\)")
1794 (day "\\([0-9]+\\|\\*\\)")
1795 (year "-?\\([0-9]+\\|\\*\\)"))
1796 (mapcar '(lambda (x)
1798 (concat "^" (regexp-quote diary-nonmarking-symbol
) "?"
1799 (if symbol
(regexp-quote symbol
) "") "\\("
1801 ;; If backup, omit first item (backup)
1802 ;; and last item (not part of date)
1803 (if (equal (car x
) 'backup
)
1804 (reverse (cdr (reverse (cdr x
))))
1807 ;; With backup, last item is not part of date
1808 (if (equal (car x
) 'backup
)
1809 (concat "\\)" (eval (car (reverse x
))))
1814 (eval-when-compile (require 'cal-hebrew
)
1815 (require 'cal-islam
))
1817 (defvar diary-font-lock-keywords
1819 (font-lock-diary-date-forms calendar-month-name-array
1820 nil calendar-month-abbrev-array
)
1821 (when (or (memq 'mark-hebrew-diary-entries
1822 nongregorian-diary-marking-hook
)
1823 (memq 'list-hebrew-diary-entries
1824 nongregorian-diary-listing-hook
))
1825 (require 'cal-hebrew
)
1826 (font-lock-diary-date-forms
1827 calendar-hebrew-month-name-array-leap-year
1828 hebrew-diary-entry-symbol
))
1829 (when (or (memq 'mark-islamic-diary-entries
1830 nongregorian-diary-marking-hook
)
1831 (memq 'list-islamic-diary-entries
1832 nongregorian-diary-listing-hook
))
1833 (require 'cal-islam
)
1834 (font-lock-diary-date-forms
1835 calendar-islamic-month-name-array
1836 islamic-diary-entry-symbol
))
1839 (concat "^" (regexp-quote diary-include-string
) ".*$")
1840 'font-lock-keyword-face
)
1842 (concat "^" (regexp-quote diary-nonmarking-symbol
)
1843 "?\\(" (regexp-quote sexp-diary-entry-symbol
) "\\)")
1844 '(1 font-lock-reference-face
))
1846 (concat "^" (regexp-quote diary-nonmarking-symbol
))
1847 'font-lock-reference-face
)
1849 (concat "^" (regexp-quote diary-nonmarking-symbol
)
1850 "?\\(" (regexp-quote hebrew-diary-entry-symbol
) "\\)")
1851 '(1 font-lock-reference-face
))
1853 (concat "^" (regexp-quote diary-nonmarking-symbol
)
1854 "?\\(" (regexp-quote islamic-diary-entry-symbol
) "\\)")
1855 '(1 font-lock-reference-face
))
1856 '(font-lock-diary-sexps . font-lock-keyword-face
)
1857 '("[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\(-[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\)?"
1858 . font-lock-function-name-face
)))
1859 "Forms to highlight in diary-mode")
1862 (provide 'diary-lib
)
1864 ;;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010
1865 ;;; diary-lib.el ends here