1 ;;; appt.el --- appointment notification functions
3 ;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; appt.el - visible and/or audible notification of
29 ;; appointments from diary file.
32 ;; Thanks to Edward M. Reingold for much help and many suggestions,
33 ;; And to many others for bug fixes and suggestions.
36 ;; This functions in this file will alert the user of a
37 ;; pending appointment based on his/her diary file. This package
38 ;; is documented in the Emacs manual.
40 ;; To activate this package, simply use (appt-activate 1).
41 ;; A `diary-file' with appointments of the format described in the
42 ;; documentation of the function `appt-check' is required.
43 ;; Relevant customizable variables are also listed in the
44 ;; documentation of that function.
46 ;; Today's appointment list is initialized from the diary when this
47 ;; package is activated. Additionally, the appointments list is
48 ;; recreated automatically at 12:01am for those who do not logout
49 ;; every day or are programming late. It is also updated when the
50 ;; `diary-file' is saved. Calling `appt-check' with an argument (or
51 ;; re-enabling the package) forces a re-initialization at any time.
53 ;; In order to add or delete items from today's list, without
54 ;; changing the diary file, use `appt-add' and `appt-delete'.
57 ;; Brief internal description - Skip this if you are not interested!
59 ;; The function `appt-make-list' creates the appointments list which
60 ;; `appt-check' reads.
62 ;; You can change the way the appointment window is created/deleted by
63 ;; setting the variables
65 ;; appt-disp-window-function
67 ;; appt-delete-window-function
69 ;; For instance, these variables could be set to functions that display
70 ;; appointments in pop-up frames, which are lowered or iconified after
71 ;; `appt-display-interval' minutes.
80 "Appointment notification."
84 (defcustom appt-issue-message t
85 "Non-nil means check for appointments in the diary buffer.
86 To be detected, the diary entry must have the format described in the
87 documentation of the function `appt-check'."
91 (make-obsolete-variable 'appt-issue-message
92 "use the function `appt-activate', and the \
93 variable `appt-display-format' instead." "22.1")
95 (defcustom appt-message-warning-time
12
96 "Time in minutes before an appointment that the warning begins."
100 (defcustom appt-audible t
101 "Non-nil means beep to indicate appointment."
105 (defcustom appt-visible t
106 "Non-nil means display appointment message in echo area.
107 This variable is only relevant if `appt-msg-window' is nil."
111 (make-obsolete-variable 'appt-visible
'appt-display-format
"22.1")
113 (defcustom appt-msg-window t
114 "Non-nil means display appointment message in another window.
115 If non-nil, this variable overrides `appt-visible'."
119 (make-obsolete-variable 'appt-msg-window
'appt-display-format
"22.1")
122 (defcustom appt-display-format
'ignore
123 "How appointment reminders should be displayed.
125 window - use a separate window
126 echo - use the echo area
127 nil - no visible reminder.
128 See also `appt-audible' and `appt-display-mode-line'.
130 The default value is 'ignore, which means to fall back on the value
131 of the (obsolete) variables `appt-msg-window' and `appt-visible'."
133 (const :tag
"Separate window" window
)
134 (const :tag
"Echo-area" echo
)
135 (const :tag
"No visible display" nil
)
136 (const :tag
"Backwards compatibility setting - choose another value"
141 (defcustom appt-display-mode-line t
142 "Non-nil means display minutes to appointment and time on the mode line.
143 This is in addition to any other display of appointment messages."
147 (defcustom appt-display-duration
10
148 "The number of seconds an appointment message is displayed.
149 Only relevant if reminders are to be displayed in their own window."
153 (defcustom appt-display-diary t
154 "Non-nil displays the diary when the appointment list is first initialized.
155 This will occur at midnight when the appointment list is updated."
159 (defcustom appt-display-interval
3
160 "Number of minutes to wait between checking the appointment list."
164 (defcustom appt-disp-window-function
'appt-disp-window
165 "Function called to display appointment window.
166 Only relevant if reminders are being displayed in a window.
167 It should take three string arguments: the number of minutes till
168 the appointment, the current time, and the text of the appointment."
169 :type
'(choice (const appt-disp-window
)
173 (defcustom appt-delete-window-function
'appt-delete-window
174 "Function called to remove appointment window and buffer.
175 Only relevant if reminders are being displayed in a window."
176 :type
'(choice (const appt-delete-window
)
181 ;;; Internal variables below this point.
183 (defconst appt-buffer-name
"*appt-buf*"
184 "Name of the appointments buffer.")
186 (defvar appt-time-msg-list nil
187 "The list of appointments for today.
188 Use `appt-add' and `appt-delete' to add and delete appointments.
189 The original list is generated from today's `diary-entries-list', and
190 can be regenerated using the function `appt-check'.
191 Each element of the generated list has the form (MINUTES STRING [FLAG]); where
192 MINUTES is the time in minutes of the appointment after midnight, and
193 STRING is the description of the appointment.
194 FLAG, if non-nil, says that the element was made with `appt-add'
195 so calling `appt-make-list' again should preserve it.")
197 (defconst appt-max-time
(1- (* 24 60))
198 "11:59pm in minutes - number of minutes in a day minus 1.")
200 (defvar appt-mode-string nil
201 "String being displayed in the mode line saying you have an appointment.
202 The actual string includes the amount of time till the appointment.
203 Only used if `appt-display-mode-line' is non-nil.")
204 (put 'appt-mode-string
'risky-local-variable t
) ; for 'face property
206 (defvar appt-prev-comp-time nil
207 "Time of day (mins since midnight) at which we last checked appointments.
208 A nil value forces the diary file to be (re-)checked for appointments.")
210 (defvar appt-now-displayed nil
211 "Non-nil when we have started notifying about a appointment that is near.")
213 (defvar appt-display-count nil
214 "Internal variable used to count number of consecutive reminders.")
216 (defvar appt-timer nil
217 "Timer used for diary appointment notifications (`appt-check').
218 If this is non-nil, appointment checking is active.")
223 (defun appt-display-message (string mins
)
224 "Display a reminder about an appointment.
225 The string STRING describes the appointment, due in integer MINS minutes.
226 The format of the visible reminder is controlled by `appt-display-format'.
227 The variable `appt-audible' controls the audible reminder."
228 ;; Let-binding for backwards compatibility. Remove when obsolete
229 ;; vars appt-msg-window and appt-visible are dropped.
230 (let ((appt-display-format
231 (if (eq appt-display-format
'ignore
)
232 (cond (appt-msg-window 'window
)
233 (appt-visible 'echo
))
234 appt-display-format
)))
235 (if appt-audible
(beep 1))
236 (cond ((eq appt-display-format
'window
)
237 (funcall appt-disp-window-function
238 (number-to-string mins
)
239 ;; TODO - use calendar-month-abbrev-array rather than %b?
240 (format-time-string "%a %b %e " (current-time))
242 (run-at-time (format "%d sec" appt-display-duration
)
244 appt-delete-window-function
))
245 ((eq appt-display-format
'echo
)
246 (message "%s" string
)))))
249 (defvar diary-selective-display
)
251 (defun appt-check (&optional force
)
252 "Check for an appointment and update any reminder display.
253 If optional argument FORCE is non-nil, reparse the diary file for
254 appointments. Otherwise the diary file is only parsed once per day,
257 Note: the time must be the first thing in the line in the diary
258 for a warning to be issued. The format of the time can be either
259 24 hour or am/pm. For example:
265 11:45am Lunch meeting.
267 Appointments are checked every `appt-display-interval' minutes.
268 The following variables control appointment notification:
270 `appt-display-format'
271 Controls the format in which reminders are displayed.
274 Variable used to determine if reminder is audible.
277 `appt-message-warning-time'
278 Variable used to determine when appointment message
279 should first be displayed.
281 `appt-display-mode-line'
282 If non-nil, a generic message giving the time remaining
283 is shown in the mode-line when an appointment is due.
285 `appt-display-interval'
286 Interval in minutes at which to check for pending appointments.
289 Display the diary buffer when the appointment list is
290 initialized for the first time in a day.
292 The following variables are only relevant if reminders are being
293 displayed in a window:
295 `appt-display-duration'
296 The number of seconds an appointment message is displayed.
298 `appt-disp-window-function'
299 Function called to display appointment window.
301 `appt-delete-window-function'
302 Function called to remove appointment window and buffer."
303 (interactive "P") ; so people can force updates
304 (let* ((min-to-app -
1)
305 (prev-appt-mode-string appt-mode-string
)
306 (prev-appt-display-count (or appt-display-count
0))
307 ;; Non-nil means do a full check for pending appointments and
308 ;; display in whatever ways the user has selected. When no
309 ;; appointment is being displayed, we always do a full check.
311 (or (not appt-now-displayed
)
312 ;; This is true every appt-display-interval minutes.
313 (zerop (mod prev-appt-display-count appt-display-interval
))))
314 ;; Non-nil means only update the interval displayed in the mode line.
315 (mode-line-only (unless full-check appt-now-displayed
))
316 now cur-comp-time appt-comp-time
)
317 (when (or full-check mode-line-only
)
319 ;; Convert current time to minutes after midnight (12.01am = 1).
320 (setq now
(decode-time)
321 cur-comp-time
(+ (* 60 (nth 2 now
)) (nth 1 now
)))
322 ;; At first check in any day, update appointments to today's list.
323 (if (or force
; eg initialize, diary save
324 (null appt-prev-comp-time
) ; first check
325 (< cur-comp-time appt-prev-comp-time
)) ; new day
327 (if appt-display-diary
329 (if (assoc 'appt-make-list diary-hook
)
331 (cons 'appt-make-list diary-hook
))))
333 (let* ((diary-display-function 'appt-make-list
)
334 (d-buff (find-buffer-visiting
335 (substitute-in-file-name diary-file
)))
337 (if d-buff
; diary buffer exists
338 (with-current-buffer d-buff
339 diary-selective-display
))))
341 ;; If the diary buffer existed before this command,
342 ;; restore its display state. Otherwise, kill it.
344 ;; Displays the diary buffer.
345 (or selective
(diary-show-all-entries))
346 (and (setq d-buff
(find-buffer-visiting
347 (substitute-in-file-name diary-file
)))
348 (kill-buffer d-buff
)))))
350 (setq appt-prev-comp-time cur-comp-time
352 appt-display-count nil
)
353 ;; If there are entries in the list, and the user wants a
354 ;; message issued, get the first time off of the list and
355 ;; calculate the number of minutes until the appointment.
356 (when (and appt-issue-message appt-time-msg-list
)
357 (setq appt-comp-time
(caar (car appt-time-msg-list
))
358 min-to-app
(- appt-comp-time cur-comp-time
))
359 (while (and appt-time-msg-list
360 (< appt-comp-time cur-comp-time
))
361 (setq appt-time-msg-list
(cdr appt-time-msg-list
))
362 (if appt-time-msg-list
363 (setq appt-comp-time
(caar (car appt-time-msg-list
)))))
364 ;; If we have an appointment between midnight and
365 ;; `appt-message-warning-time' minutes after midnight, we
366 ;; must begin to issue a message before midnight. Midnight
367 ;; is considered 0 minutes and 11:59pm is 1439
368 ;; minutes. Therefore we must recalculate the minutes to
369 ;; appointment variable. It is equal to the number of
370 ;; minutes before midnight plus the number of minutes after
371 ;; midnight our appointment is.
372 (if (and (< appt-comp-time appt-message-warning-time
)
373 (> (+ cur-comp-time appt-message-warning-time
)
375 (setq min-to-app
(+ (- (1+ appt-max-time
) cur-comp-time
)
377 ;; Issue warning if the appointment time is within
378 ;; appt-message-warning time.
379 (when (and (<= min-to-app appt-message-warning-time
)
381 (setq appt-now-displayed t
382 appt-display-count
(1+ prev-appt-display-count
))
383 (unless mode-line-only
384 (appt-display-message (cadr (car appt-time-msg-list
))
386 (when appt-display-mode-line
387 (setq appt-mode-string
388 (concat " " (propertize
389 (format "App't in %s min." min-to-app
)
390 'face
'mode-line-emphasis
))))
391 ;; When an appointment is reached, delete it from the
392 ;; list. Reset the count to 0 in case we display another
393 ;; appointment on the next cycle.
394 (if (zerop min-to-app
)
395 (setq appt-time-msg-list
(cdr appt-time-msg-list
)
396 appt-display-count nil
))))
397 ;; If we have changed the mode line string, redisplay all mode lines.
398 (and appt-display-mode-line
399 (not (string-equal appt-mode-string
400 prev-appt-mode-string
))
402 (force-mode-line-update t
)
403 ;; If the string now has a notification, redisplay right now.
407 (defun appt-disp-window (min-to-app new-time appt-msg
)
408 "Display appointment due in MIN-TO-APP (a string) minutes.
409 NEW-TIME is a string giving the date. Displays the appointment
410 message APPT-MSG in a separate buffer."
411 (let ((this-window (selected-window))
412 (appt-disp-buf (get-buffer-create appt-buffer-name
)))
413 ;; Make sure we're not in the minibuffer before splitting the window.
414 ;; FIXME this seems needlessly complicated?
417 (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
418 (if (cdr (assq 'unsplittable
(frame-parameters)))
419 ;; In an unsplittable frame, use something somewhere else.
421 (set-buffer appt-disp-buf
)
422 (display-buffer appt-disp-buf
))
423 (unless (or (special-display-p (buffer-name appt-disp-buf
))
424 (same-window-p (buffer-name appt-disp-buf
)))
425 ;; By default, split the bottom window and use the lower part.
426 (appt-select-lowest-window)
427 ;; Split the window, unless it's too small to do so.
428 (when (>= (window-height) (* 2 window-min-height
))
429 (select-window (split-window))))
430 (switch-to-buffer appt-disp-buf
))
431 ;; FIXME Link to diary entry?
432 (calendar-set-mode-line
433 (format " Appointment %s. %s "
434 (if (string-equal "0" min-to-app
) "now"
435 (format "in %s minute%s" min-to-app
436 (if (string-equal "1" min-to-app
) "" "s")))
438 (setq buffer-read-only nil
442 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t
))
443 (set-buffer-modified-p nil
)
444 (setq buffer-read-only t
)
445 (raise-frame (selected-frame))
446 (select-window this-window
)))
448 (defun appt-delete-window ()
449 "Function called to undisplay appointment messages.
450 Usually just deletes the appointment buffer."
451 (let ((window (get-buffer-window appt-buffer-name t
)))
453 (or (eq window
(frame-root-window (window-frame window
)))
454 (delete-window window
))))
455 (kill-buffer appt-buffer-name
)
459 (defun appt-select-lowest-window ()
460 "Select the lowest window on the frame."
461 (let ((lowest-window (selected-window))
462 (bottom-edge (nth 3 (window-edges)))
464 (walk-windows (lambda (w)
465 (when (< bottom-edge
(setq next-bottom-edge
466 (nth 3 (window-edges w
))))
467 (setq bottom-edge next-bottom-edge
468 lowest-window w
))) 'nomini
)
469 (select-window lowest-window
)))
471 (defconst appt-time-regexp
472 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
475 (defun appt-add (new-appt-time new-appt-msg
)
476 "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
477 The time should be in either 24 hour format or am/pm format."
478 (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
479 (unless (string-match appt-time-regexp new-appt-time
)
480 (error "Unacceptable time-string"))
481 (let ((time-msg (list (list (appt-convert-time new-appt-time
))
482 (concat new-appt-time
" " new-appt-msg
) t
)))
483 (unless (member time-msg appt-time-msg-list
)
484 (setq appt-time-msg-list
485 (appt-sort-list (nconc appt-time-msg-list
(list time-msg
)))))))
488 (defun appt-delete ()
489 "Delete an appointment from the list of appointments."
491 (let ((tmp-msg-list appt-time-msg-list
))
492 (dolist (element tmp-msg-list
)
493 (if (y-or-n-p (concat "Delete "
494 ;; We want to quote any doublequotes in the
495 ;; string, as well as put doublequotes around it.
497 (substring-no-properties (cadr element
) 0))
499 (setq appt-time-msg-list
(delq element appt-time-msg-list
)))))
505 (defvar original-date
)
506 (defvar diary-entries-list
)
507 ;; Autoload for the old way of using this package. Can be removed sometime.
509 (defun appt-make-list ()
510 "Update the appointments list from today's diary buffer.
511 The time must be at the beginning of a line for it to be
512 put in the appointments list (see examples in documentation of
513 the function `appt-check'). We assume that the variables DATE and
514 NUMBER hold the arguments that `diary-list-entries' received.
515 They specify the range of dates that the diary is being processed for.
517 Any appointments made with `appt-add' are not affected by this function.
519 For backwards compatibility, this function activates the
520 appointment package (if it is not already active)."
521 ;; See comments above appt-activate defun.
524 ;; We have something to do if the range of dates that the diary is
525 ;; considering includes the current date.
526 (if (and (not (calendar-date-compare
527 (list (calendar-current-date))
528 (list original-date
)))
529 (calendar-date-compare
530 (list (calendar-current-date))
531 (list (calendar-gregorian-from-absolute
532 (+ (calendar-absolute-from-gregorian original-date
)
535 ;; Clear the appointments list, then fill it in from the diary.
536 (dolist (elt appt-time-msg-list
)
537 ;; Delete any entries that were not made with appt-add.
539 (setq appt-time-msg-list
540 (delq elt appt-time-msg-list
))))
541 (if diary-entries-list
542 ;; Cycle through the entry-list (diary-entries-list)
543 ;; looking for entries beginning with a time. If the
544 ;; entry begins with a time, add it to the
545 ;; appt-time-msg-list. Then sort the list.
546 (let ((entry-list diary-entries-list
)
549 ;; Skip diary entries for dates before today.
550 (while (and entry-list
551 (calendar-date-compare
552 (car entry-list
) (list (calendar-current-date))))
553 (setq entry-list
(cdr entry-list
)))
554 ;; Parse the entries for today.
555 (while (and entry-list
557 (calendar-current-date) (caar entry-list
)))
558 (setq time-string
(cadr (car entry-list
)))
559 (while (string-match appt-time-regexp time-string
)
560 (let* ((beg (match-beginning 0))
561 ;; Get just the time for this appointment.
562 (only-time (match-string 0 time-string
))
563 ;; Find the end of this appointment
564 ;; (the start of the next).
566 (concat "\n[ \t]*" appt-time-regexp
)
569 ;; Get the whole string for this appointment.
571 (substring time-string beg end
))
572 (appt-time (list (appt-convert-time only-time
)))
573 (time-msg (list appt-time appt-time-string
)))
574 ;; Add this appointment to appt-time-msg-list.
575 (setq appt-time-msg-list
576 (nconc appt-time-msg-list
(list time-msg
))
577 ;; Discard this appointment from the string.
579 (if end
(substring time-string end
) ""))))
580 (setq entry-list
(cdr entry-list
)))))
581 (setq appt-time-msg-list
(appt-sort-list appt-time-msg-list
))
582 ;; Convert current time to minutes after midnight (12:01am = 1),
583 ;; so that elements in the list that are earlier than the
584 ;; present time can be removed.
585 (let* ((now (decode-time))
586 (cur-comp-time (+ (* 60 (nth 2 now
)) (nth 1 now
)))
587 (appt-comp-time (caar (car appt-time-msg-list
))))
588 (while (and appt-time-msg-list
(< appt-comp-time cur-comp-time
))
589 (setq appt-time-msg-list
(cdr appt-time-msg-list
))
590 (if appt-time-msg-list
591 (setq appt-comp-time
(caar (car appt-time-msg-list
))))))))))
594 (defun appt-sort-list (appt-list)
595 "Sort an appointment list, putting earlier items at the front.
596 APPT-LIST is a list of the same format as `appt-time-msg-list'."
597 (sort appt-list
(lambda (e1 e2
) (< (caar e1
) (caar e2
)))))
600 (defun appt-convert-time (time2conv)
601 "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
602 A period (.) can be used instead of a colon (:) to separate the
603 hour and minute parts."
604 ;; Formats that should be accepted:
605 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
606 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv
)
607 (string-to-number (match-string 1 time2conv
))
609 (hr (if (string-match "[0-9]*[0-9]" time2conv
)
610 (string-to-number (match-string 0 time2conv
))
612 ;; Convert the time appointment time into 24 hour time.
613 (cond ((and (string-match "pm" time2conv
) (< hr
12))
615 ((and (string-match "am" time2conv
) (= hr
12))
617 ;; Convert the actual time into minutes.
620 (defun appt-update-list ()
621 "If the current buffer is visiting the diary, update appointments.
622 This function is intended for use with `write-file-functions'."
623 (and (string-equal buffer-file-name
(expand-file-name diary-file
))
625 (let ((appt-display-diary nil
))
629 ;; In Emacs-21.3, the manual documented the following procedure to
630 ;; activate this package:
632 ;; (add-hook 'diary-hook 'appt-make-list)
634 ;; The display-time call was not necessary, AFAICS.
635 ;; What was really needed was to add the hook and load this file.
636 ;; Calling (diary 0) once the hook had been added was in some sense a
637 ;; roundabout way of loading this file. This file used to have code at
638 ;; the top-level that set up the appt-timer and global-mode-string.
639 ;; One way to maintain backwards compatibility would be to call
640 ;; (appt-activate 1) at top-level. However, this goes against the
641 ;; convention that just loading an Emacs package should not activate
642 ;; it. Instead, we make appt-make-list activate the package (after a
643 ;; suggestion from rms). This means that one has to call diary in
644 ;; order to get it to work, but that is in line with the old (weird,
645 ;; IMO) documented behavior for activating the package.
646 ;; Actually, since (diary 0) does not run diary-hook, I don't think
647 ;; the documented behavior in Emacs-21.3 would ever have worked.
648 ;; Oh well, at least with the changes to appt-make-list it will now
649 ;; work as well as it ever did.
650 ;; The new method is just to use (appt-activate 1).
654 (defun appt-activate (&optional arg
)
655 "Toggle checking of appointments.
656 With optional numeric argument ARG, turn appointment checking on if
657 ARG is positive, otherwise off."
659 (let ((appt-active appt-timer
))
660 (setq appt-active
(if arg
(> (prefix-numeric-value arg
) 0)
662 (remove-hook 'write-file-functions
'appt-update-list
)
663 (or global-mode-string
(setq global-mode-string
'("")))
664 (delq 'appt-mode-string global-mode-string
)
666 (cancel-timer appt-timer
)
667 (setq appt-timer nil
))
669 (add-hook 'write-file-functions
'appt-update-list
)
670 (setq appt-timer
(run-at-time t
60 'appt-check
)
672 (append global-mode-string
'(appt-mode-string)))
678 ;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
679 ;;; appt.el ends here