1 ;;; appt.el --- appointment notification functions
3 ;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009, 2010 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-issue-message t
87 "Non-nil means check for appointments in the diary buffer.
88 To be detected, the diary entry must have the format described in the
89 documentation of the function `appt-check'."
93 (make-obsolete-variable 'appt-issue-message
94 "use the function `appt-activate', and the \
95 variable `appt-display-format' instead." "22.1")
97 (defcustom appt-message-warning-time
12
98 "Time in minutes before an appointment that the warning begins."
102 (defcustom appt-audible t
103 "Non-nil means beep to indicate appointment."
107 (defcustom appt-visible t
108 "Non-nil means display appointment message in echo area.
109 This variable is only relevant if `appt-msg-window' is nil."
113 (make-obsolete-variable 'appt-visible
'appt-display-format
"22.1")
115 (defcustom appt-msg-window t
116 "Non-nil means display appointment message in another window.
117 If non-nil, this variable overrides `appt-visible'."
121 (make-obsolete-variable 'appt-msg-window
'appt-display-format
"22.1")
124 (defcustom appt-display-format
'ignore
125 "How appointment reminders should be displayed.
127 window - use a separate window
128 echo - use the echo area
129 nil - no visible reminder.
130 See also `appt-audible' and `appt-display-mode-line'.
132 The default value is 'ignore, which means to fall back on the value
133 of the (obsolete) variables `appt-msg-window' and `appt-visible'."
135 (const :tag
"Separate window" window
)
136 (const :tag
"Echo-area" echo
)
137 (const :tag
"No visible display" nil
)
138 (const :tag
"Backwards compatibility setting - choose another value"
143 (defcustom appt-display-mode-line t
144 "Non-nil means display minutes to appointment and time on the mode line.
145 This is in addition to any other display of appointment messages."
149 (defcustom appt-display-duration
10
150 "The number of seconds an appointment message is displayed.
151 Only relevant if reminders are to be displayed in their own window."
155 (defcustom appt-display-diary t
156 "Non-nil displays the diary when the appointment list is first initialized.
157 This will occur at midnight when the appointment list is updated."
161 (defcustom appt-display-interval
3
162 "Number of minutes to wait between checking the appointment list."
166 (defcustom appt-disp-window-function
'appt-disp-window
167 "Function called to display appointment window.
168 Only relevant if reminders are being displayed in a window.
169 It should take three string arguments: the number of minutes till
170 the appointment, the current time, and the text of the appointment."
171 :type
'(choice (const appt-disp-window
)
175 (defcustom appt-delete-window-function
'appt-delete-window
176 "Function called to remove appointment window and buffer.
177 Only relevant if reminders are being displayed in a window."
178 :type
'(choice (const appt-delete-window
)
183 ;;; Internal variables below this point.
185 (defconst appt-buffer-name
"*appt-buf*"
186 "Name of the appointments buffer.")
188 ;; TODO Turn this into an alist? It would be easier to add more
189 ;; optional elements.
190 ;; TODO There should be a way to set WARNTIME (and other properties)
191 ;; from the diary-file. Implementing that would be a good reason
192 ;; to change this to an alist.
193 (defvar appt-time-msg-list nil
194 "The list of appointments for today.
195 Use `appt-add' and `appt-delete' to add and delete appointments.
196 The original list is generated from today's `diary-entries-list', and
197 can be regenerated using the function `appt-check'.
198 Each element of the generated list has the form
199 \(MINUTES STRING [FLAG] [WARNTIME])
200 where MINUTES is the time in minutes of the appointment after midnight,
201 and STRING is the description of the appointment.
202 FLAG and WARNTIME can only be present if the element was made
203 with `appt-add'. A non-nil FLAG indicates that the element was made
204 with `appt-add', so calling `appt-make-list' again should preserve it.
205 If WARNTIME is non-nil, it is an integer to use in place
206 of `appt-message-warning-time'.")
208 (defconst appt-max-time
(1- (* 24 60))
209 "11:59pm in minutes - number of minutes in a day minus 1.")
211 (defvar appt-mode-string nil
212 "String being displayed in the mode line saying you have an appointment.
213 The actual string includes the amount of time till the appointment.
214 Only used if `appt-display-mode-line' is non-nil.")
215 (put 'appt-mode-string
'risky-local-variable t
) ; for 'face property
217 (defvar appt-prev-comp-time nil
218 "Time of day (mins since midnight) at which we last checked appointments.
219 A nil value forces the diary file to be (re-)checked for appointments.")
221 (defvar appt-now-displayed nil
222 "Non-nil when we have started notifying about a appointment that is near.")
224 (defvar appt-display-count nil
225 "Internal variable used to count number of consecutive reminders.")
227 (defvar appt-timer nil
228 "Timer used for diary appointment notifications (`appt-check').
229 If this is non-nil, appointment checking is active.")
234 (defun appt-display-message (string mins
)
235 "Display a reminder about an appointment.
236 The string STRING describes the appointment, due in integer MINS minutes.
237 The format of the visible reminder is controlled by `appt-display-format'.
238 The variable `appt-audible' controls the audible reminder."
239 ;; Let-binding for backwards compatibility. Remove when obsolete
240 ;; vars appt-msg-window and appt-visible are dropped.
241 (let ((appt-display-format
242 (if (eq appt-display-format
'ignore
)
243 (cond (appt-msg-window 'window
)
244 (appt-visible 'echo
))
245 appt-display-format
)))
246 (if appt-audible
(beep 1))
247 (cond ((eq appt-display-format
'window
)
248 (funcall appt-disp-window-function
249 (number-to-string mins
)
250 ;; TODO - use calendar-month-abbrev-array rather than %b?
251 (format-time-string "%a %b %e " (current-time))
253 (run-at-time (format "%d sec" appt-display-duration
)
255 appt-delete-window-function
))
256 ((eq appt-display-format
'echo
)
257 (message "%s" string
)))))
260 (defvar diary-selective-display
)
262 (defun appt-check (&optional force
)
263 "Check for an appointment and update any reminder display.
264 If optional argument FORCE is non-nil, reparse the diary file for
265 appointments. Otherwise the diary file is only parsed once per day,
266 or when it (or a file it includes) is saved.
268 Note: the time must be the first thing in the line in the diary
269 for a warning to be issued. The format of the time can be either
270 24 hour or am/pm. For example:
276 11:45am Lunch meeting.
278 Appointments are checked every `appt-display-interval' minutes.
279 The following variables control appointment notification:
281 `appt-display-format'
282 Controls the format in which reminders are displayed.
285 Variable used to determine if reminder is audible.
288 `appt-message-warning-time'
289 Variable used to determine when appointment message
290 should first be displayed.
292 `appt-display-mode-line'
293 If non-nil, a generic message giving the time remaining
294 is shown in the mode-line when an appointment is due.
296 `appt-display-interval'
297 Interval in minutes at which to check for pending appointments.
300 Display the diary buffer when the appointment list is
301 initialized for the first time in a day.
303 The following variables are only relevant if reminders are being
304 displayed in a window:
306 `appt-display-duration'
307 The number of seconds an appointment message is displayed.
309 `appt-disp-window-function'
310 Function called to display appointment window.
312 `appt-delete-window-function'
313 Function called to remove appointment window and buffer."
314 (interactive "P") ; so people can force updates
315 (let* ((min-to-app -
1)
316 (prev-appt-mode-string appt-mode-string
)
317 (prev-appt-display-count (or appt-display-count
0))
318 ;; Non-nil means do a full check for pending appointments and
319 ;; display in whatever ways the user has selected. When no
320 ;; appointment is being displayed, we always do a full check.
322 (or (not appt-now-displayed
)
323 ;; This is true every appt-display-interval minutes.
324 (zerop (mod prev-appt-display-count appt-display-interval
))))
325 ;; Non-nil means only update the interval displayed in the mode line.
326 (mode-line-only (unless full-check appt-now-displayed
))
327 now cur-comp-time appt-comp-time appt-warn-time
)
328 (when (or full-check mode-line-only
)
330 ;; Convert current time to minutes after midnight (12.01am = 1).
331 (setq now
(decode-time)
332 cur-comp-time
(+ (* 60 (nth 2 now
)) (nth 1 now
)))
333 ;; At first check in any day, update appointments to today's list.
334 (if (or force
; eg initialize, diary save
335 (null appt-prev-comp-time
) ; first check
336 (< cur-comp-time appt-prev-comp-time
)) ; new day
338 (if appt-display-diary
340 (if (assoc 'appt-make-list diary-hook
)
342 (cons 'appt-make-list diary-hook
))))
344 (let* ((diary-display-function 'appt-make-list
)
345 (d-buff (find-buffer-visiting diary-file
))
347 (if d-buff
; diary buffer exists
348 (with-current-buffer d-buff
349 diary-selective-display
)))
351 ;; Not displaying the diary, so we can ignore
352 ;; diary-number-of-entries. Since appt.el only
353 ;; works on a daily basis, no need for more entries.
354 ;; FIXME why not using diary-list-entries with
355 ;; non-nil LIST-ONLY?
357 ;; If the diary buffer existed before this command,
358 ;; restore its display state. Otherwise, kill it.
359 (and (setq d-buff2
(find-buffer-visiting diary-file
))
362 (with-current-buffer d-buff2
363 (if diary-selective-display
364 ;; diary-show-all-entries displays
366 (diary-unhide-everything))))
367 ;; FIXME does not kill any included diary files.
368 ;; The real issue is that (diary) should not
369 ;; have the side effect of visiting all the
370 ;; diary files. It is not really appt.el's job to
371 ;; clean up this mess...
372 (kill-buffer d-buff2
)))))))
373 (setq appt-prev-comp-time cur-comp-time
375 appt-display-count nil
)
376 ;; If there are entries in the list, and the user wants a
377 ;; message issued, get the first time off of the list and
378 ;; calculate the number of minutes until the appointment.
379 (when (and appt-issue-message appt-time-msg-list
)
380 (setq appt-comp-time
(caar (car appt-time-msg-list
))
381 appt-warn-time
(or (nth 3 (car appt-time-msg-list
))
382 appt-message-warning-time
)
383 min-to-app
(- appt-comp-time cur-comp-time
))
384 (while (and appt-time-msg-list
385 (< appt-comp-time cur-comp-time
))
386 (setq appt-time-msg-list
(cdr appt-time-msg-list
))
387 (if appt-time-msg-list
388 (setq appt-comp-time
(caar (car appt-time-msg-list
)))))
389 ;; If we have an appointment between midnight and
390 ;; `appt-warn-time' minutes after midnight, we
391 ;; must begin to issue a message before midnight. Midnight
392 ;; is considered 0 minutes and 11:59pm is 1439
393 ;; minutes. Therefore we must recalculate the minutes to
394 ;; appointment variable. It is equal to the number of
395 ;; minutes before midnight plus the number of minutes after
396 ;; midnight our appointment is.
397 (if (and (< appt-comp-time appt-warn-time
)
398 (> (+ cur-comp-time appt-warn-time
)
400 (setq min-to-app
(+ (- (1+ appt-max-time
) cur-comp-time
)
402 ;; Issue warning if the appointment time is within
403 ;; appt-message-warning time.
404 (when (and (<= min-to-app appt-warn-time
)
406 (setq appt-now-displayed t
407 appt-display-count
(1+ prev-appt-display-count
))
408 (unless mode-line-only
409 (appt-display-message (cadr (car appt-time-msg-list
))
411 (when appt-display-mode-line
412 (setq appt-mode-string
413 (concat " " (propertize
414 (format "App't in %s min." min-to-app
)
415 'face
'mode-line-emphasis
))))
416 ;; When an appointment is reached, delete it from the
417 ;; list. Reset the count to 0 in case we display another
418 ;; appointment on the next cycle.
419 (if (zerop min-to-app
)
420 (setq appt-time-msg-list
(cdr appt-time-msg-list
)
421 appt-display-count nil
))))
422 ;; If we have changed the mode line string, redisplay all mode lines.
423 (and appt-display-mode-line
424 (not (string-equal appt-mode-string
425 prev-appt-mode-string
))
427 (force-mode-line-update t
)
428 ;; If the string now has a notification, redisplay right now.
432 (defun appt-disp-window (min-to-app new-time appt-msg
)
433 "Display appointment due in MIN-TO-APP (a string) minutes.
434 NEW-TIME is a string giving the date. Displays the appointment
435 message APPT-MSG in a separate buffer."
436 (let ((this-window (selected-window))
437 (appt-disp-buf (get-buffer-create appt-buffer-name
)))
438 ;; Make sure we're not in the minibuffer before splitting the window.
439 ;; FIXME this seems needlessly complicated?
442 (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
443 (if (cdr (assq 'unsplittable
(frame-parameters)))
444 ;; In an unsplittable frame, use something somewhere else.
446 (set-buffer appt-disp-buf
)
447 (display-buffer appt-disp-buf
))
448 (unless (or (special-display-p (buffer-name appt-disp-buf
))
449 (same-window-p (buffer-name appt-disp-buf
)))
450 ;; By default, split the bottom window and use the lower part.
451 (appt-select-lowest-window)
452 ;; Split the window, unless it's too small to do so.
453 (when (>= (window-height) (* 2 window-min-height
))
454 (select-window (split-window))))
455 (switch-to-buffer appt-disp-buf
))
456 ;; FIXME Link to diary entry?
457 (calendar-set-mode-line
458 (format " Appointment %s. %s "
459 (if (string-equal "0" min-to-app
) "now"
460 (format "in %s minute%s" min-to-app
461 (if (string-equal "1" min-to-app
) "" "s")))
463 (setq buffer-read-only nil
467 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t
))
468 (set-buffer-modified-p nil
)
469 (setq buffer-read-only t
)
470 (raise-frame (selected-frame))
471 (select-window this-window
)))
473 (defun appt-delete-window ()
474 "Function called to undisplay appointment messages.
475 Usually just deletes the appointment buffer."
476 (let ((window (get-buffer-window appt-buffer-name t
)))
478 (or (eq window
(frame-root-window (window-frame window
)))
479 (delete-window window
))))
480 (kill-buffer appt-buffer-name
)
484 (defun appt-select-lowest-window ()
485 "Select the lowest window on the frame."
486 (let ((lowest-window (selected-window))
487 (bottom-edge (nth 3 (window-edges)))
489 (walk-windows (lambda (w)
490 (when (< bottom-edge
(setq next-bottom-edge
491 (nth 3 (window-edges w
))))
492 (setq bottom-edge next-bottom-edge
493 lowest-window w
))) 'nomini
)
494 (select-window lowest-window
)))
496 (defconst appt-time-regexp
497 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
500 (defun appt-add (time msg
&optional warntime
)
501 "Add an appointment for today at TIME with message MSG.
502 The time should be in either 24 hour format or am/pm format.
503 Optional argument WARNTIME is an integer (or string) giving the number
504 of minutes before the appointment at which to start warning.
505 The default is `appt-message-warning-time'."
506 (interactive "sTime (hh:mm[am/pm]): \nsMessage:
507 sMinutes before the appointment to start warning: ")
508 (unless (string-match appt-time-regexp time
)
509 (error "Unacceptable time-string"))
510 (and (stringp warntime
)
511 (setq warntime
(unless (string-equal warntime
"")
512 (string-to-number warntime
))))
514 (not (integerp warntime
))
515 (error "Argument WARNTIME must be an integer, or nil"))
516 (let ((time-msg (list (list (appt-convert-time time
))
517 (concat time
" " msg
) t
)))
518 ;; It is presently non-sensical to have multiple warnings about
519 ;; the same appointment with just different delays, but it might
520 ;; not always be so. TODO
521 (if warntime
(setq time-msg
(append time-msg
(list warntime
))))
522 (unless (member time-msg appt-time-msg-list
)
523 (setq appt-time-msg-list
524 (appt-sort-list (nconc appt-time-msg-list
(list time-msg
)))))))
527 (defun appt-delete ()
528 "Delete an appointment from the list of appointments."
530 (let ((tmp-msg-list appt-time-msg-list
))
531 (dolist (element tmp-msg-list
)
532 (if (y-or-n-p (concat "Delete "
533 ;; We want to quote any doublequotes in the
534 ;; string, as well as put doublequotes around it.
536 (substring-no-properties (cadr element
) 0))
538 (setq appt-time-msg-list
(delq element appt-time-msg-list
)))))
544 (defvar original-date
)
545 (defvar diary-entries-list
)
546 ;; Autoload for the old way of using this package. Can be removed sometime.
548 (defun appt-make-list ()
549 "Update the appointments list from today's diary buffer.
550 The time must be at the beginning of a line for it to be
551 put in the appointments list (see examples in documentation of
552 the function `appt-check'). We assume that the variables DATE and
553 NUMBER hold the arguments that `diary-list-entries' received.
554 They specify the range of dates that the diary is being processed for.
556 Any appointments made with `appt-add' are not affected by this function.
558 For backwards compatibility, this function activates the
559 appointment package (if it is not already active)."
560 ;; See comments above appt-activate defun.
563 ;; We have something to do if the range of dates that the diary is
564 ;; considering includes the current date.
565 (if (and (not (calendar-date-compare
566 (list (calendar-current-date))
567 (list original-date
)))
568 (calendar-date-compare
569 (list (calendar-current-date))
570 (list (calendar-gregorian-from-absolute
571 (+ (calendar-absolute-from-gregorian original-date
)
574 ;; Clear the appointments list, then fill it in from the diary.
575 (dolist (elt appt-time-msg-list
)
576 ;; Delete any entries that were not made with appt-add.
578 (setq appt-time-msg-list
579 (delq elt appt-time-msg-list
))))
580 (if diary-entries-list
581 ;; Cycle through the entry-list (diary-entries-list)
582 ;; looking for entries beginning with a time. If the
583 ;; entry begins with a time, add it to the
584 ;; appt-time-msg-list. Then sort the list.
585 (let ((entry-list diary-entries-list
)
588 ;; Below, we assume diary-entries-list was in date
589 ;; order. It is, unless something on
590 ;; diary-list-entries-hook has changed it, eg
591 ;; diary-include-other-files (bug#7019). It must be
592 ;; in date order if number = 1.
593 (and diary-list-entries-hook
595 (not (eq diary-number-of-entries
1))
596 (not (memq (car (last diary-list-entries-hook
))
597 '(diary-sort-entries sort-diary-entries
)))
598 (setq entry-list
(sort entry-list
'diary-entry-compare
)))
599 ;; Skip diary entries for dates before today.
600 (while (and entry-list
601 (calendar-date-compare
602 (car entry-list
) (list (calendar-current-date))))
603 (setq entry-list
(cdr entry-list
)))
604 ;; Parse the entries for today.
605 (while (and entry-list
607 (calendar-current-date) (caar entry-list
)))
608 (setq time-string
(cadr (car entry-list
)))
609 (while (string-match appt-time-regexp time-string
)
610 (let* ((beg (match-beginning 0))
611 ;; Get just the time for this appointment.
612 (only-time (match-string 0 time-string
))
613 ;; Find the end of this appointment
614 ;; (the start of the next).
616 (concat "\n[ \t]*" appt-time-regexp
)
619 ;; Get the whole string for this appointment.
621 (substring time-string beg end
))
622 (appt-time (list (appt-convert-time only-time
)))
623 (time-msg (list appt-time appt-time-string
)))
624 ;; Add this appointment to appt-time-msg-list.
625 (setq appt-time-msg-list
626 (nconc appt-time-msg-list
(list time-msg
))
627 ;; Discard this appointment from the string.
629 (if end
(substring time-string end
) ""))))
630 (setq entry-list
(cdr entry-list
)))))
631 (setq appt-time-msg-list
(appt-sort-list appt-time-msg-list
))
632 ;; Convert current time to minutes after midnight (12:01am = 1),
633 ;; so that elements in the list that are earlier than the
634 ;; present time can be removed.
635 (let* ((now (decode-time))
636 (cur-comp-time (+ (* 60 (nth 2 now
)) (nth 1 now
)))
637 (appt-comp-time (caar (car appt-time-msg-list
))))
638 (while (and appt-time-msg-list
(< appt-comp-time cur-comp-time
))
639 (setq appt-time-msg-list
(cdr appt-time-msg-list
))
640 (if appt-time-msg-list
641 (setq appt-comp-time
(caar (car appt-time-msg-list
))))))))))
644 (defun appt-sort-list (appt-list)
645 "Sort an appointment list, putting earlier items at the front.
646 APPT-LIST is a list of the same format as `appt-time-msg-list'."
647 (sort appt-list
(lambda (e1 e2
) (< (caar e1
) (caar e2
)))))
650 (defun appt-convert-time (time2conv)
651 "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
652 A period (.) can be used instead of a colon (:) to separate the
653 hour and minute parts."
654 ;; Formats that should be accepted:
655 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
656 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv
)
657 (string-to-number (match-string 1 time2conv
))
659 (hr (if (string-match "[0-9]*[0-9]" time2conv
)
660 (string-to-number (match-string 0 time2conv
))
662 ;; Convert the time appointment time into 24 hour time.
663 (cond ((and (string-match "pm" time2conv
) (< hr
12))
665 ((and (string-match "am" time2conv
) (= hr
12))
667 ;; Convert the actual time into minutes.
670 (defun appt-update-list ()
671 "If the current buffer is visiting the diary, update appointments.
672 This function also acts on any file listed in `diary-included-files'.
673 It is intended for use with `write-file-functions'."
674 (and (member buffer-file-name
(append diary-included-files
675 (list (expand-file-name diary-file
))))
677 (let ((appt-display-diary nil
))
681 ;; In Emacs-21.3, the manual documented the following procedure to
682 ;; activate this package:
684 ;; (add-hook 'diary-hook 'appt-make-list)
686 ;; The display-time call was not necessary, AFAICS.
687 ;; What was really needed was to add the hook and load this file.
688 ;; Calling (diary 0) once the hook had been added was in some sense a
689 ;; roundabout way of loading this file. This file used to have code at
690 ;; the top-level that set up the appt-timer and global-mode-string.
691 ;; One way to maintain backwards compatibility would be to call
692 ;; (appt-activate 1) at top-level. However, this goes against the
693 ;; convention that just loading an Emacs package should not activate
694 ;; it. Instead, we make appt-make-list activate the package (after a
695 ;; suggestion from rms). This means that one has to call diary in
696 ;; order to get it to work, but that is in line with the old (weird,
697 ;; IMO) documented behavior for activating the package.
698 ;; Actually, since (diary 0) does not run diary-hook, I don't think
699 ;; the documented behavior in Emacs-21.3 would ever have worked.
700 ;; Oh well, at least with the changes to appt-make-list it will now
701 ;; work as well as it ever did.
702 ;; The new method is just to use (appt-activate 1).
706 (defun appt-activate (&optional arg
)
707 "Toggle checking of appointments.
708 With optional numeric argument ARG, turn appointment checking on if
709 ARG is positive, otherwise off."
711 (let ((appt-active appt-timer
))
712 (setq appt-active
(if arg
(> (prefix-numeric-value arg
) 0)
714 (remove-hook 'write-file-functions
'appt-update-list
)
715 (or global-mode-string
(setq global-mode-string
'("")))
716 (delq 'appt-mode-string global-mode-string
)
718 (cancel-timer appt-timer
)
719 (setq appt-timer nil
))
721 (add-hook 'write-file-functions
'appt-update-list
)
722 (setq appt-timer
(run-at-time t
60 'appt-check
)
724 (append global-mode-string
'(appt-mode-string)))
730 ;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
731 ;;; appt.el ends here