1 ;;; appt.el --- appointment notification functions
3 ;; Copyright (C) 1989-1990, 1994, 1998, 2001-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; appt.el - visible and/or audible notification of
30 ;; appointments from diary file.
33 ;; Thanks to Edward M. Reingold for much help and many suggestions,
34 ;; And to many others for bug fixes and suggestions.
37 ;; This functions in this file will alert the user of a
38 ;; pending appointment based on his/her diary file. This package
39 ;; is documented in the Emacs manual.
41 ;; To activate this package, simply use (appt-activate 1).
42 ;; A `diary-file' with appointments of the format described in the
43 ;; documentation of the function `appt-check' is required.
44 ;; Relevant customizable variables are also listed in the
45 ;; documentation of that function.
47 ;; Today's appointment list is initialized from the diary when this
48 ;; package is activated. Additionally, the appointments list is
49 ;; recreated automatically at 12:01am for those who do not logout
50 ;; every day or are programming late. It is also updated when the
51 ;; `diary-file' (or a file it includes) is saved. Calling
52 ;; `appt-check' with an argument (or re-enabling the package) forces a
53 ;; re-initialization at any time.
55 ;; In order to add or delete items from today's list, without
56 ;; changing the diary file, use `appt-add' and `appt-delete'.
59 ;; Brief internal description - Skip this if you are not interested!
61 ;; The function `appt-make-list' creates the appointments list which
62 ;; `appt-check' reads.
64 ;; You can change the way the appointment window is created/deleted by
65 ;; setting the variables
67 ;; appt-disp-window-function
69 ;; appt-delete-window-function
71 ;; For instance, these variables could be set to functions that display
72 ;; appointments in pop-up frames, which are lowered or iconified after
73 ;; `appt-display-interval' minutes.
82 "Appointment notification."
86 (defcustom appt-message-warning-time
12
87 "Default time in minutes before an appointment that the warning begins."
91 (defcustom appt-warning-time-regexp
"warntime \\([0-9]+\\)"
92 "Regexp matching a string giving the warning time for an appointment.
93 The first subexpression matches the time in minutes (an integer).
94 This overrides the default `appt-message-warning-time'.
95 You may want to put this inside a diary comment (see `diary-comment-start').
96 For example, to be warned 30 minutes in advance of an appointment:
97 2011/06/01 12:00 Do something ## warntime 30
103 (defcustom appt-audible t
104 "Non-nil means beep to indicate appointment."
109 (defcustom appt-display-format
'window
110 "How appointment reminders should be displayed.
112 window - use a separate window
113 echo - use the echo area
114 nil - no visible reminder.
115 See also `appt-audible' and `appt-display-mode-line'."
117 (const :tag
"Separate window" window
)
118 (const :tag
"Echo-area" echo
)
119 (const :tag
"No visible display" nil
))
121 :version
"24.1") ; no longer inherit from deleted obsolete variables
123 (defcustom appt-display-mode-line t
124 "Non-nil means display minutes to appointment and time on the mode line.
125 This is in addition to any other display of appointment messages."
129 (defcustom appt-display-duration
10
130 "The number of seconds an appointment message is displayed.
131 Only relevant if reminders are to be displayed in their own window."
135 (defcustom appt-display-diary t
136 "Non-nil displays the diary when the appointment list is first initialized.
137 This will occur at midnight when the appointment list is updated."
141 (defcustom appt-display-interval
3
142 "Number of minutes to wait between checking the appointment list."
146 (defcustom appt-disp-window-function
'appt-disp-window
147 "Function called to display appointment window.
148 Only relevant if reminders are being displayed in a window.
149 It should take three string arguments: the number of minutes till
150 the appointment, the current time, and the text of the appointment."
151 :type
'(choice (const appt-disp-window
)
155 (defcustom appt-delete-window-function
'appt-delete-window
156 "Function called to remove appointment window and buffer.
157 Only relevant if reminders are being displayed in a window."
158 :type
'(choice (const appt-delete-window
)
163 ;;; Internal variables below this point.
165 (defconst appt-buffer-name
"*appt-buf*"
166 "Name of the appointments buffer.")
168 ;; TODO Turn this into an alist? It would be easier to add more
169 ;; optional elements.
170 ;; Why is the first element (MINUTES) rather than just MINUTES?
171 ;; It may just inherit from diary-entries-list, where we have
172 ;; ((MONTH DAY YEAR) ENTRY)
173 (defvar appt-time-msg-list nil
174 "The list of appointments for today.
175 Use `appt-add' and `appt-delete' to add and delete appointments.
176 The original list is generated from today's `diary-entries-list', and
177 can be regenerated using the function `appt-check'.
178 Each element of the generated list has the form
179 \((MINUTES) STRING [FLAG] [WARNTIME])
180 where MINUTES is the time in minutes of the appointment after midnight,
181 and STRING is the description of the appointment.
182 FLAG and WARNTIME are not always present. A non-nil FLAG
183 indicates that the element was made with `appt-add', so calling
184 `appt-make-list' again should preserve it. If WARNTIME is non-nil,
185 it is an integer to use in place of `appt-message-warning-time'.")
187 (defconst appt-max-time
(1- (* 24 60))
188 "11:59pm in minutes - number of minutes in a day minus 1.")
190 (defvar appt-mode-string nil
191 "String being displayed in the mode line saying you have an appointment.
192 The actual string includes the amount of time till the appointment.
193 Only used if `appt-display-mode-line' is non-nil.")
194 (put 'appt-mode-string
'risky-local-variable t
) ; for 'face property
196 (defvar appt-prev-comp-time nil
197 "Time of day (mins since midnight) at which we last checked appointments.
198 A nil value forces the diary file to be (re-)checked for appointments.")
200 (defvar appt-display-count nil
201 "Internal variable used to count number of consecutive reminders.")
203 (defvar appt-timer nil
204 "Timer used for diary appointment notifications (`appt-check').
205 If this is non-nil, appointment checking is active.")
210 (defun appt-display-message (string mins
)
211 "Display a reminder about an appointment.
212 The string STRING describes the appointment, due in integer MINS minutes.
213 The format of the visible reminder is controlled by `appt-display-format'.
214 The variable `appt-audible' controls the audible reminder."
215 (if appt-audible
(beep 1))
216 (cond ((eq appt-display-format
'window
)
217 (funcall appt-disp-window-function
218 (number-to-string mins
)
219 ;; TODO - use calendar-month-abbrev-array rather than %b?
220 (format-time-string "%a %b %e " (current-time))
222 (run-at-time (format "%d sec" appt-display-duration
)
224 appt-delete-window-function
))
225 ((eq appt-display-format
'echo
)
226 (message "%s" string
))))
229 (defun appt-check (&optional force
)
230 "Check for an appointment and update any reminder display.
231 If optional argument FORCE is non-nil, reparse the diary file for
232 appointments. Otherwise the diary file is only parsed once per day,
233 or when it (or a file it includes) is saved.
235 Note: the time must be the first thing in the line in the diary
236 for a warning to be issued. The format of the time can be either
237 24 hour or am/pm. For example:
243 11:45am Lunch meeting.
245 Appointments are checked every `appt-display-interval' minutes.
246 The following variables control appointment notification:
248 `appt-display-format'
249 Controls the format in which reminders are displayed.
252 Variable used to determine if reminder is audible.
255 `appt-message-warning-time'
256 Variable used to determine when appointment message
257 should first be displayed.
259 `appt-display-mode-line'
260 If non-nil, a generic message giving the time remaining
261 is shown in the mode-line when an appointment is due.
263 `appt-display-interval'
264 Interval in minutes at which to check for pending appointments.
267 Display the diary buffer when the appointment list is
268 initialized for the first time in a day.
270 The following variables are only relevant if reminders are being
271 displayed in a window:
273 `appt-display-duration'
274 The number of seconds an appointment message is displayed.
276 `appt-disp-window-function'
277 Function called to display appointment window.
279 `appt-delete-window-function'
280 Function called to remove appointment window and buffer."
281 (interactive "P") ; so people can force updates
282 (let* ((min-to-app -
1)
283 (prev-appt-mode-string appt-mode-string
)
284 (prev-appt-display-count (or appt-display-count
0))
285 now now-mins appt-mins appt-warn-time
)
286 (save-excursion ; FIXME ?
287 ;; Convert current time to minutes after midnight (12.01am = 1).
288 (setq now
(decode-time)
289 now-mins
(+ (* 60 (nth 2 now
)) (nth 1 now
)))
290 ;; At first check in any day, update appointments to today's list.
291 (if (or force
; eg initialize, diary save
292 (null appt-prev-comp-time
) ; first check
293 (< now-mins appt-prev-comp-time
)) ; new day
295 (let ((diary-hook (if (assoc 'appt-make-list diary-hook
)
297 (cons 'appt-make-list diary-hook
))))
298 (if appt-display-diary
300 ;; Not displaying the diary, so we can ignore
301 ;; diary-number-of-entries. Since appt.el only
302 ;; works on a daily basis, no need for more entries.
303 (diary-list-entries (calendar-current-date) 1 t
)))))
304 (setq appt-prev-comp-time now-mins
306 appt-display-count nil
)
307 ;; Remove any entries that are in the past.
308 ;; FIXME how can there be any such entries, given that this
309 ;; function removes entries when they hit zero minutes,
310 ;; and appt-make-list doesn't add any in the past in the first place?
311 (while (and appt-time-msg-list
312 (< (setq appt-mins
(caar (car appt-time-msg-list
)))
314 (setq appt-time-msg-list
(cdr appt-time-msg-list
)))
315 ;; If there are entries in the list, and the user wants a
316 ;; message issued, get the first time off of the list and
317 ;; calculate the number of minutes until the appointment.
318 (when appt-time-msg-list
319 (setq appt-warn-time
(or (nth 3 (car appt-time-msg-list
))
320 appt-message-warning-time
)
321 min-to-app
(- appt-mins now-mins
))
322 ;; If we have an appointment between midnight and
323 ;; `appt-warn-time' minutes after midnight, we
324 ;; must begin to issue a message before midnight. Midnight
325 ;; is considered 0 minutes and 11:59pm is 1439
326 ;; minutes. Therefore we must recalculate the minutes to
327 ;; appointment variable. It is equal to the number of
328 ;; minutes before midnight plus the number of minutes after
329 ;; midnight our appointment is.
330 ;; FIXME but appt-make-list constructs appt-time-msg-list to only
331 ;; contain entries with today's date, so this cannot work?
332 ;; Also above we just removed anything with appt-mins < now-mins.
333 (if (and (< appt-mins appt-warn-time
)
334 (> (+ now-mins appt-warn-time
) appt-max-time
))
335 (setq min-to-app
(+ (- (1+ appt-max-time
) now-mins
)
337 ;; Issue warning if the appointment time is within
338 ;; appt-message-warning time.
339 (when (and (<= min-to-app appt-warn-time
)
341 ;; This is true every appt-display-interval minutes.
342 (and (zerop (mod prev-appt-display-count appt-display-interval
))
343 (appt-display-message (cadr (car appt-time-msg-list
))
345 (when appt-display-mode-line
346 (setq appt-mode-string
347 (concat " " (propertize
349 (if (zerop min-to-app
) "NOW"
350 (format "in %s min." min-to-app
)))
351 'face
'mode-line-emphasis
))))
352 ;; When an appointment is reached, delete it from the
353 ;; list. Reset the count to 0 in case we display another
354 ;; appointment on the next cycle.
355 (if (zerop min-to-app
)
356 (setq appt-time-msg-list
(cdr appt-time-msg-list
)
357 appt-display-count nil
)
358 (setq appt-display-count
(1+ prev-appt-display-count
)))))
359 ;; If we have changed the mode line string, redisplay all mode lines.
360 (and appt-display-mode-line
361 (not (string-equal appt-mode-string prev-appt-mode-string
))
363 (force-mode-line-update t
)
364 ;; If the string now has a notification, redisplay right now.
368 (defun appt-disp-window (min-to-app new-time appt-msg
)
369 "Display appointment due in MIN-TO-APP (a string) minutes.
370 NEW-TIME is a string giving the date. Displays the appointment
371 message APPT-MSG in a separate buffer."
372 (let ((this-window (selected-window))
373 (appt-disp-buf (get-buffer-create appt-buffer-name
)))
374 ;; Make sure we're not in the minibuffer before splitting the window.
375 ;; FIXME this seems needlessly complicated?
378 (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
379 (if (cdr (assq 'unsplittable
(frame-parameters)))
380 ;; In an unsplittable frame, use something somewhere else.
382 (set-buffer appt-disp-buf
)
383 (display-buffer appt-disp-buf
))
384 (unless (or (special-display-p (buffer-name appt-disp-buf
))
385 (same-window-p (buffer-name appt-disp-buf
)))
386 ;; By default, split the bottom window and use the lower part.
387 (appt-select-lowest-window)
388 ;; Split the window, unless it's too small to do so.
389 (when (>= (window-height) (* 2 window-min-height
))
390 (select-window (split-window))))
391 (switch-to-buffer appt-disp-buf
))
392 ;; FIXME Link to diary entry?
393 (calendar-set-mode-line
394 (format " Appointment %s. %s "
395 (if (string-equal "0" min-to-app
) "now"
396 (format "in %s minute%s" min-to-app
397 (if (string-equal "1" min-to-app
) "" "s")))
399 (setq buffer-read-only nil
403 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t
))
404 (set-buffer-modified-p nil
)
405 (setq buffer-read-only t
)
406 (raise-frame (selected-frame))
407 (select-window this-window
)))
409 (defun appt-delete-window ()
410 "Function called to undisplay appointment messages.
411 Usually just deletes the appointment buffer."
412 (let ((window (get-buffer-window appt-buffer-name t
)))
414 (or (eq window
(frame-root-window (window-frame window
)))
415 (delete-window window
))))
416 (kill-buffer appt-buffer-name
)
420 (defun appt-select-lowest-window ()
421 "Select the lowest window on the frame."
422 (let ((lowest-window (selected-window))
423 (bottom-edge (nth 3 (window-edges)))
425 (walk-windows (lambda (w)
426 (when (< bottom-edge
(setq next-bottom-edge
427 (nth 3 (window-edges w
))))
428 (setq bottom-edge next-bottom-edge
429 lowest-window w
))) 'nomini
)
430 (select-window lowest-window
)))
432 (defconst appt-time-regexp
433 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
436 (defun appt-add (time msg
&optional warntime
)
437 "Add an appointment for today at TIME with message MSG.
438 The time should be in either 24 hour format or am/pm format.
439 Optional argument WARNTIME is an integer (or string) giving the number
440 of minutes before the appointment at which to start warning.
441 The default is `appt-message-warning-time'."
442 (interactive "sTime (hh:mm[am/pm]): \nsMessage:
443 sMinutes before the appointment to start warning: ")
444 (unless (string-match appt-time-regexp time
)
445 (error "Unacceptable time-string"))
446 (and (stringp warntime
)
447 (setq warntime
(unless (string-equal warntime
"")
448 (string-to-number warntime
))))
450 (not (integerp warntime
))
451 (error "Argument WARNTIME must be an integer, or nil"))
452 (or appt-timer
(appt-activate))
453 (let ((time-msg (list (list (appt-convert-time time
))
454 (concat time
" " msg
) t
)))
455 ;; It is presently non-sensical to have multiple warnings about
456 ;; the same appointment with just different delays, but it might
457 ;; not always be so. TODO
458 (if warntime
(setq time-msg
(append time-msg
(list warntime
))))
459 (unless (member time-msg appt-time-msg-list
)
460 (setq appt-time-msg-list
461 (appt-sort-list (nconc appt-time-msg-list
(list time-msg
)))))))
463 (defun appt-delete ()
464 "Delete an appointment from the list of appointments."
466 (let ((tmp-msg-list appt-time-msg-list
))
467 (dolist (element tmp-msg-list
)
468 (if (y-or-n-p (concat "Delete "
469 ;; We want to quote any doublequotes in the
470 ;; string, as well as put doublequotes around it.
472 (substring-no-properties (cadr element
) 0))
474 (setq appt-time-msg-list
(delq element appt-time-msg-list
)))))
480 (defvar original-date
)
481 (defvar diary-entries-list
)
483 (defun appt-make-list ()
484 "Update the appointments list from today's diary buffer.
485 The time must be at the beginning of a line for it to be
486 put in the appointments list (see examples in documentation of
487 the function `appt-check'). We assume that the variables DATE and
488 NUMBER hold the arguments that `diary-list-entries' received.
489 They specify the range of dates that the diary is being processed for.
491 Any appointments made with `appt-add' are not affected by this function."
492 ;; We have something to do if the range of dates that the diary is
493 ;; considering includes the current date.
494 (if (and (not (calendar-date-compare
495 (list (calendar-current-date))
496 (list original-date
)))
497 (calendar-date-compare
498 (list (calendar-current-date))
499 (list (calendar-gregorian-from-absolute
500 (+ (calendar-absolute-from-gregorian original-date
)
503 ;; Clear the appointments list, then fill it in from the diary.
504 (dolist (elt appt-time-msg-list
)
505 ;; Delete any entries that were not made with appt-add.
507 (setq appt-time-msg-list
508 (delq elt appt-time-msg-list
))))
509 (if diary-entries-list
510 ;; Cycle through the entry-list (diary-entries-list)
511 ;; looking for entries beginning with a time. If the
512 ;; entry begins with a time, add it to the
513 ;; appt-time-msg-list. Then sort the list.
514 (let ((entry-list diary-entries-list
)
516 ;; Below, we assume diary-entries-list was in date
517 ;; order. It is, unless something on
518 ;; diary-list-entries-hook has changed it, eg
519 ;; diary-include-other-files (bug#7019). It must be
520 ;; in date order if number = 1.
521 (and diary-list-entries-hook
523 (not (eq diary-number-of-entries
1))
524 (not (memq (car (last diary-list-entries-hook
))
525 '(diary-sort-entries sort-diary-entries
)))
526 (setq entry-list
(sort entry-list
'diary-entry-compare
)))
527 ;; Skip diary entries for dates before today.
528 (while (and entry-list
529 (calendar-date-compare
530 (car entry-list
) (list (calendar-current-date))))
531 (setq entry-list
(cdr entry-list
)))
532 ;; Parse the entries for today.
533 (while (and entry-list
535 (calendar-current-date) (caar entry-list
)))
536 (setq time-string
(cadr (car entry-list
))
537 ;; Including any comments.
538 literal
(or (nth 2 (nth 3 (car entry-list
)))
540 (while (string-match appt-time-regexp time-string
)
541 (let* ((beg (match-beginning 0))
542 ;; Get just the time for this appointment.
543 (only-time (match-string 0 time-string
))
544 ;; Find the end of this appointment
545 ;; (the start of the next).
547 (concat "\n[ \t]*" appt-time-regexp
)
551 (if (string-match appt-warning-time-regexp literal
)
552 (string-to-number (match-string 1 literal
))))
553 ;; Get the whole string for this appointment.
555 (substring time-string beg end
))
556 ;; FIXME why the list? It makes the first
557 ;; element (MINUTES) rather than MINUTES.
558 (appt-time (list (appt-convert-time only-time
)))
560 (list appt-time appt-time-string
)
561 (if warntime
(list nil warntime
)))))
562 ;; Add this appointment to appt-time-msg-list.
563 (setq appt-time-msg-list
564 (nconc appt-time-msg-list
(list time-msg
))
565 ;; Discard this appointment from the string.
566 ;; (This allows for multiple appts per entry.)
568 (if end
(substring time-string end
) ""))
569 ;; Similarly, discard the start of literal.
570 (and (> (length time-string
) 0)
571 (string-match appt-time-regexp literal
)
572 (setq end
(string-match
573 (concat "\n[ \t]*" appt-time-regexp
)
574 literal
(match-end 0)))
575 (setq literal
(substring literal end
)))))
576 (setq entry-list
(cdr entry-list
)))))
577 (setq appt-time-msg-list
(appt-sort-list appt-time-msg-list
))
578 ;; Convert current time to minutes after midnight (12:01am = 1),
579 ;; and remove elements in the list that are in the past.
580 (let* ((now (decode-time))
581 (now-mins (+ (* 60 (nth 2 now
)) (nth 1 now
))))
582 (while (and appt-time-msg-list
583 (< (caar (car appt-time-msg-list
)) now-mins
))
584 (setq appt-time-msg-list
(cdr appt-time-msg-list
)))))))
587 (defun appt-sort-list (appt-list)
588 "Sort an appointment list, putting earlier items at the front.
589 APPT-LIST is a list of the same format as `appt-time-msg-list'."
590 (sort appt-list
(lambda (e1 e2
) (< (caar e1
) (caar e2
)))))
593 (defun appt-convert-time (time2conv)
594 "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
595 A period (.) can be used instead of a colon (:) to separate the
596 hour and minute parts."
597 ;; Formats that should be accepted:
598 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
599 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv
)
600 (string-to-number (match-string 1 time2conv
))
602 (hr (if (string-match "[0-9]*[0-9]" time2conv
)
603 (string-to-number (match-string 0 time2conv
))
605 ;; Convert the time appointment time into 24 hour time.
606 (cond ((and (string-match "pm" time2conv
) (< hr
12))
608 ((and (string-match "am" time2conv
) (= hr
12))
610 ;; Convert the actual time into minutes.
613 (defun appt-update-list ()
614 "If the current buffer is visiting the diary, update appointments.
615 This function also acts on any file listed in `diary-included-files'.
616 It is intended for use with `write-file-functions'."
617 (and (member buffer-file-name
(append diary-included-files
618 (list (expand-file-name diary-file
))))
620 (let ((appt-display-diary nil
))
625 (defun appt-activate (&optional arg
)
626 "Toggle checking of appointments.
627 With optional numeric argument ARG, turn appointment checking on if
628 ARG is positive, otherwise off."
630 (let ((appt-active appt-timer
))
631 (setq appt-active
(if arg
(> (prefix-numeric-value arg
) 0)
633 (remove-hook 'write-file-functions
'appt-update-list
)
634 (or global-mode-string
(setq global-mode-string
'("")))
635 (delq 'appt-mode-string global-mode-string
)
637 (cancel-timer appt-timer
)
638 (setq appt-timer nil
))
641 (add-hook 'write-file-functions
'appt-update-list
)
642 (setq appt-timer
(run-at-time t
60 'appt-check
)
644 (append global-mode-string
'(appt-mode-string)))
646 (message "Appointment reminders enabled%s"
647 ;; Someone might want to use appt-add without a diary.
648 (if (ignore-errors (diary-check-diary-file))
650 " (no diary file found)")))
651 (message "Appointment reminders disabled"))))
656 ;;; appt.el ends here