]> code.delx.au - gnu-emacs/blob - lisp/calendar/appt.el
86856f2c1245c92056bb032dff136d3b5cfdd990
[gnu-emacs] / lisp / calendar / appt.el
1 ;;; appt.el --- appointment notification functions
2
3 ;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
5
6 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
8 ;; Keywords: calendar
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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/>.
24
25 ;;; Commentary:
26
27 ;;
28 ;; appt.el - visible and/or audible notification of
29 ;; appointments from diary file.
30 ;;
31 ;;
32 ;; Thanks to Edward M. Reingold for much help and many suggestions,
33 ;; And to many others for bug fixes and suggestions.
34 ;;
35 ;;
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.
39 ;;
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.
45 ;;
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.
52 ;;
53 ;; In order to add or delete items from today's list, without
54 ;; changing the diary file, use `appt-add' and `appt-delete'.
55 ;;
56
57 ;; Brief internal description - Skip this if you are not interested!
58 ;;
59 ;; The function `appt-make-list' creates the appointments list which
60 ;; `appt-check' reads.
61 ;;
62 ;; You can change the way the appointment window is created/deleted by
63 ;; setting the variables
64 ;;
65 ;; appt-disp-window-function
66 ;; and
67 ;; appt-delete-window-function
68 ;;
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.
72 ;;
73
74 ;;; Code:
75
76 (require 'diary-lib)
77
78
79 (defgroup appt nil
80 "Appointment notification."
81 :prefix "appt-"
82 :group 'calendar)
83
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'."
88 :type 'boolean
89 :group 'appt)
90
91 (make-obsolete-variable 'appt-issue-message
92 "use the function `appt-activate', and the \
93 variable `appt-display-format' instead." "22.1")
94
95 (defcustom appt-message-warning-time 12
96 "Time in minutes before an appointment that the warning begins."
97 :type 'integer
98 :group 'appt)
99
100 (defcustom appt-audible t
101 "Non-nil means beep to indicate appointment."
102 :type 'boolean
103 :group 'appt)
104
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."
108 :type 'boolean
109 :group 'appt)
110
111 (make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
112
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'."
116 :type 'boolean
117 :group 'appt)
118
119 (make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
120
121 ;; TODO - add popup.
122 (defcustom appt-display-format 'ignore
123 "How appointment reminders should be displayed.
124 The options are:
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'.
129
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'."
132 :type '(choice
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"
137 ignore))
138 :group 'appt
139 :version "22.1")
140
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."
144 :type 'boolean
145 :group 'appt)
146
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."
150 :type 'integer
151 :group 'appt)
152
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."
156 :type 'boolean
157 :group 'appt)
158
159 (defcustom appt-display-interval 3
160 "Number of minutes to wait between checking the appointment list."
161 :type 'integer
162 :group 'appt)
163
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)
170 function)
171 :group 'appt)
172
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)
177 function)
178 :group 'appt)
179
180
181 ;;; Internal variables below this point.
182
183 (defconst appt-buffer-name "*appt-buf*"
184 "Name of the appointments buffer.")
185
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.")
196
197 (defconst appt-max-time (1- (* 24 60))
198 "11:59pm in minutes - number of minutes in a day minus 1.")
199
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
205
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.")
209
210 (defvar appt-now-displayed nil
211 "Non-nil when we have started notifying about a appointment that is near.")
212
213 (defvar appt-display-count nil
214 "Internal variable used to count number of consecutive reminders.")
215
216 (defvar appt-timer nil
217 "Timer used for diary appointment notifications (`appt-check').
218 If this is non-nil, appointment checking is active.")
219
220
221 ;;; Functions.
222
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))
241 string)
242 (run-at-time (format "%d sec" appt-display-duration)
243 nil
244 appt-delete-window-function))
245 ((eq appt-display-format 'echo)
246 (message "%s" string)))))
247
248
249 (defvar diary-selective-display)
250
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,
255 and when saved.
256
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:
260
261 02/23/89
262 18:00 Dinner
263
264 Thursday
265 11:45am Lunch meeting.
266
267 Appointments are checked every `appt-display-interval' minutes.
268 The following variables control appointment notification:
269
270 `appt-display-format'
271 Controls the format in which reminders are displayed.
272
273 `appt-audible'
274 Variable used to determine if reminder is audible.
275 Default is t.
276
277 `appt-message-warning-time'
278 Variable used to determine when appointment message
279 should first be displayed.
280
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.
284
285 `appt-display-interval'
286 Interval in minutes at which to check for pending appointments.
287
288 `appt-display-diary'
289 Display the diary buffer when the appointment list is
290 initialized for the first time in a day.
291
292 The following variables are only relevant if reminders are being
293 displayed in a window:
294
295 `appt-display-duration'
296 The number of seconds an appointment message is displayed.
297
298 `appt-disp-window-function'
299 Function called to display appointment window.
300
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.
310 (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)
318 (save-excursion
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
326 (condition-case nil
327 (if appt-display-diary
328 (let ((diary-hook
329 (if (assoc 'appt-make-list diary-hook)
330 diary-hook
331 (cons 'appt-make-list diary-hook))))
332 (diary))
333 (let* ((diary-display-function 'appt-make-list)
334 (d-buff (find-buffer-visiting diary-file))
335 (selective
336 (if d-buff ; diary buffer exists
337 (with-current-buffer d-buff
338 diary-selective-display))))
339 (diary)
340 ;; If the diary buffer existed before this command,
341 ;; restore its display state. Otherwise, kill it.
342 (if d-buff
343 ;; Displays the diary buffer.
344 (or selective (diary-show-all-entries))
345 (and (setq d-buff (find-buffer-visiting diary-file))
346 (kill-buffer d-buff)))))
347 (error nil)))
348 (setq appt-prev-comp-time cur-comp-time
349 appt-mode-string nil
350 appt-display-count nil)
351 ;; If there are entries in the list, and the user wants a
352 ;; message issued, get the first time off of the list and
353 ;; calculate the number of minutes until the appointment.
354 (when (and appt-issue-message appt-time-msg-list)
355 (setq appt-comp-time (caar (car appt-time-msg-list))
356 min-to-app (- appt-comp-time cur-comp-time))
357 (while (and appt-time-msg-list
358 (< appt-comp-time cur-comp-time))
359 (setq appt-time-msg-list (cdr appt-time-msg-list))
360 (if appt-time-msg-list
361 (setq appt-comp-time (caar (car appt-time-msg-list)))))
362 ;; If we have an appointment between midnight and
363 ;; `appt-message-warning-time' minutes after midnight, we
364 ;; must begin to issue a message before midnight. Midnight
365 ;; is considered 0 minutes and 11:59pm is 1439
366 ;; minutes. Therefore we must recalculate the minutes to
367 ;; appointment variable. It is equal to the number of
368 ;; minutes before midnight plus the number of minutes after
369 ;; midnight our appointment is.
370 (if (and (< appt-comp-time appt-message-warning-time)
371 (> (+ cur-comp-time appt-message-warning-time)
372 appt-max-time))
373 (setq min-to-app (+ (- (1+ appt-max-time) cur-comp-time)
374 appt-comp-time)))
375 ;; Issue warning if the appointment time is within
376 ;; appt-message-warning time.
377 (when (and (<= min-to-app appt-message-warning-time)
378 (>= min-to-app 0))
379 (setq appt-now-displayed t
380 appt-display-count (1+ prev-appt-display-count))
381 (unless mode-line-only
382 (appt-display-message (cadr (car appt-time-msg-list))
383 min-to-app))
384 (when appt-display-mode-line
385 (setq appt-mode-string
386 (concat " " (propertize
387 (format "App't in %s min." min-to-app)
388 'face 'mode-line-emphasis))))
389 ;; When an appointment is reached, delete it from the
390 ;; list. Reset the count to 0 in case we display another
391 ;; appointment on the next cycle.
392 (if (zerop min-to-app)
393 (setq appt-time-msg-list (cdr appt-time-msg-list)
394 appt-display-count nil))))
395 ;; If we have changed the mode line string, redisplay all mode lines.
396 (and appt-display-mode-line
397 (not (string-equal appt-mode-string
398 prev-appt-mode-string))
399 (progn
400 (force-mode-line-update t)
401 ;; If the string now has a notification, redisplay right now.
402 (if appt-mode-string
403 (sit-for 0))))))))
404
405 (defun appt-disp-window (min-to-app new-time appt-msg)
406 "Display appointment due in MIN-TO-APP (a string) minutes.
407 NEW-TIME is a string giving the date. Displays the appointment
408 message APPT-MSG in a separate buffer."
409 (let ((this-window (selected-window))
410 (appt-disp-buf (get-buffer-create appt-buffer-name)))
411 ;; Make sure we're not in the minibuffer before splitting the window.
412 ;; FIXME this seems needlessly complicated?
413 (when (minibufferp)
414 (other-window 1)
415 (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
416 (if (cdr (assq 'unsplittable (frame-parameters)))
417 ;; In an unsplittable frame, use something somewhere else.
418 (progn
419 (set-buffer appt-disp-buf)
420 (display-buffer appt-disp-buf))
421 (unless (or (special-display-p (buffer-name appt-disp-buf))
422 (same-window-p (buffer-name appt-disp-buf)))
423 ;; By default, split the bottom window and use the lower part.
424 (appt-select-lowest-window)
425 ;; Split the window, unless it's too small to do so.
426 (when (>= (window-height) (* 2 window-min-height))
427 (select-window (split-window))))
428 (switch-to-buffer appt-disp-buf))
429 ;; FIXME Link to diary entry?
430 (calendar-set-mode-line
431 (format " Appointment %s. %s "
432 (if (string-equal "0" min-to-app) "now"
433 (format "in %s minute%s" min-to-app
434 (if (string-equal "1" min-to-app) "" "s")))
435 new-time))
436 (setq buffer-read-only nil
437 buffer-undo-list t)
438 (erase-buffer)
439 (insert appt-msg)
440 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
441 (set-buffer-modified-p nil)
442 (setq buffer-read-only t)
443 (raise-frame (selected-frame))
444 (select-window this-window)))
445
446 (defun appt-delete-window ()
447 "Function called to undisplay appointment messages.
448 Usually just deletes the appointment buffer."
449 (let ((window (get-buffer-window appt-buffer-name t)))
450 (and window
451 (or (eq window (frame-root-window (window-frame window)))
452 (delete-window window))))
453 (kill-buffer appt-buffer-name)
454 (if appt-audible
455 (beep 1)))
456
457 (defun appt-select-lowest-window ()
458 "Select the lowest window on the frame."
459 (let ((lowest-window (selected-window))
460 (bottom-edge (nth 3 (window-edges)))
461 next-bottom-edge)
462 (walk-windows (lambda (w)
463 (when (< bottom-edge (setq next-bottom-edge
464 (nth 3 (window-edges w))))
465 (setq bottom-edge next-bottom-edge
466 lowest-window w))) 'nomini)
467 (select-window lowest-window)))
468
469 (defconst appt-time-regexp
470 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
471
472 ;;;###autoload
473 (defun appt-add (new-appt-time new-appt-msg)
474 "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
475 The time should be in either 24 hour format or am/pm format."
476 (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
477 (unless (string-match appt-time-regexp new-appt-time)
478 (error "Unacceptable time-string"))
479 (let ((time-msg (list (list (appt-convert-time new-appt-time))
480 (concat new-appt-time " " new-appt-msg) t)))
481 (unless (member time-msg appt-time-msg-list)
482 (setq appt-time-msg-list
483 (appt-sort-list (nconc appt-time-msg-list (list time-msg)))))))
484
485 ;;;###autoload
486 (defun appt-delete ()
487 "Delete an appointment from the list of appointments."
488 (interactive)
489 (let ((tmp-msg-list appt-time-msg-list))
490 (dolist (element tmp-msg-list)
491 (if (y-or-n-p (concat "Delete "
492 ;; We want to quote any doublequotes in the
493 ;; string, as well as put doublequotes around it.
494 (prin1-to-string
495 (substring-no-properties (cadr element) 0))
496 " from list? "))
497 (setq appt-time-msg-list (delq element appt-time-msg-list)))))
498 (appt-check)
499 (message ""))
500
501
502 (defvar number)
503 (defvar original-date)
504 (defvar diary-entries-list)
505 ;; Autoload for the old way of using this package. Can be removed sometime.
506 ;;;###autoload
507 (defun appt-make-list ()
508 "Update the appointments list from today's diary buffer.
509 The time must be at the beginning of a line for it to be
510 put in the appointments list (see examples in documentation of
511 the function `appt-check'). We assume that the variables DATE and
512 NUMBER hold the arguments that `diary-list-entries' received.
513 They specify the range of dates that the diary is being processed for.
514
515 Any appointments made with `appt-add' are not affected by this function.
516
517 For backwards compatibility, this function activates the
518 appointment package (if it is not already active)."
519 ;; See comments above appt-activate defun.
520 (if (not appt-timer)
521 (appt-activate 1)
522 ;; We have something to do if the range of dates that the diary is
523 ;; considering includes the current date.
524 (if (and (not (calendar-date-compare
525 (list (calendar-current-date))
526 (list original-date)))
527 (calendar-date-compare
528 (list (calendar-current-date))
529 (list (calendar-gregorian-from-absolute
530 (+ (calendar-absolute-from-gregorian original-date)
531 number)))))
532 (save-excursion
533 ;; Clear the appointments list, then fill it in from the diary.
534 (dolist (elt appt-time-msg-list)
535 ;; Delete any entries that were not made with appt-add.
536 (unless (nth 2 elt)
537 (setq appt-time-msg-list
538 (delq elt appt-time-msg-list))))
539 (if diary-entries-list
540 ;; Cycle through the entry-list (diary-entries-list)
541 ;; looking for entries beginning with a time. If the
542 ;; entry begins with a time, add it to the
543 ;; appt-time-msg-list. Then sort the list.
544 (let ((entry-list diary-entries-list)
545 (new-time-string "")
546 time-string)
547 ;; Skip diary entries for dates before today.
548 (while (and entry-list
549 (calendar-date-compare
550 (car entry-list) (list (calendar-current-date))))
551 (setq entry-list (cdr entry-list)))
552 ;; Parse the entries for today.
553 (while (and entry-list
554 (calendar-date-equal
555 (calendar-current-date) (caar entry-list)))
556 (setq time-string (cadr (car entry-list)))
557 (while (string-match appt-time-regexp time-string)
558 (let* ((beg (match-beginning 0))
559 ;; Get just the time for this appointment.
560 (only-time (match-string 0 time-string))
561 ;; Find the end of this appointment
562 ;; (the start of the next).
563 (end (string-match
564 (concat "\n[ \t]*" appt-time-regexp)
565 time-string
566 (match-end 0)))
567 ;; Get the whole string for this appointment.
568 (appt-time-string
569 (substring time-string beg end))
570 (appt-time (list (appt-convert-time only-time)))
571 (time-msg (list appt-time appt-time-string)))
572 ;; Add this appointment to appt-time-msg-list.
573 (setq appt-time-msg-list
574 (nconc appt-time-msg-list (list time-msg))
575 ;; Discard this appointment from the string.
576 time-string
577 (if end (substring time-string end) ""))))
578 (setq entry-list (cdr entry-list)))))
579 (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
580 ;; Convert current time to minutes after midnight (12:01am = 1),
581 ;; so that elements in the list that are earlier than the
582 ;; present time can be removed.
583 (let* ((now (decode-time))
584 (cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
585 (appt-comp-time (caar (car appt-time-msg-list))))
586 (while (and appt-time-msg-list (< appt-comp-time cur-comp-time))
587 (setq appt-time-msg-list (cdr appt-time-msg-list))
588 (if appt-time-msg-list
589 (setq appt-comp-time (caar (car appt-time-msg-list))))))))))
590
591
592 (defun appt-sort-list (appt-list)
593 "Sort an appointment list, putting earlier items at the front.
594 APPT-LIST is a list of the same format as `appt-time-msg-list'."
595 (sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
596
597
598 (defun appt-convert-time (time2conv)
599 "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
600 A period (.) can be used instead of a colon (:) to separate the
601 hour and minute parts."
602 ;; Formats that should be accepted:
603 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
604 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv)
605 (string-to-number (match-string 1 time2conv))
606 0))
607 (hr (if (string-match "[0-9]*[0-9]" time2conv)
608 (string-to-number (match-string 0 time2conv))
609 0)))
610 ;; Convert the time appointment time into 24 hour time.
611 (cond ((and (string-match "pm" time2conv) (< hr 12))
612 (setq hr (+ 12 hr)))
613 ((and (string-match "am" time2conv) (= hr 12))
614 (setq hr 0)))
615 ;; Convert the actual time into minutes.
616 (+ (* hr 60) min)))
617
618 (defun appt-update-list ()
619 "If the current buffer is visiting the diary, update appointments.
620 This function is intended for use with `write-file-functions'."
621 (and (string-equal buffer-file-name (expand-file-name diary-file))
622 appt-timer
623 (let ((appt-display-diary nil))
624 (appt-check t)))
625 nil)
626
627 ;; In Emacs-21.3, the manual documented the following procedure to
628 ;; activate this package:
629 ;; (display-time)
630 ;; (add-hook 'diary-hook 'appt-make-list)
631 ;; (diary 0)
632 ;; The display-time call was not necessary, AFAICS.
633 ;; What was really needed was to add the hook and load this file.
634 ;; Calling (diary 0) once the hook had been added was in some sense a
635 ;; roundabout way of loading this file. This file used to have code at
636 ;; the top-level that set up the appt-timer and global-mode-string.
637 ;; One way to maintain backwards compatibility would be to call
638 ;; (appt-activate 1) at top-level. However, this goes against the
639 ;; convention that just loading an Emacs package should not activate
640 ;; it. Instead, we make appt-make-list activate the package (after a
641 ;; suggestion from rms). This means that one has to call diary in
642 ;; order to get it to work, but that is in line with the old (weird,
643 ;; IMO) documented behavior for activating the package.
644 ;; Actually, since (diary 0) does not run diary-hook, I don't think
645 ;; the documented behavior in Emacs-21.3 would ever have worked.
646 ;; Oh well, at least with the changes to appt-make-list it will now
647 ;; work as well as it ever did.
648 ;; The new method is just to use (appt-activate 1).
649 ;; -- gmorris
650
651 ;;;###autoload
652 (defun appt-activate (&optional arg)
653 "Toggle checking of appointments.
654 With optional numeric argument ARG, turn appointment checking on if
655 ARG is positive, otherwise off."
656 (interactive "P")
657 (let ((appt-active appt-timer))
658 (setq appt-active (if arg (> (prefix-numeric-value arg) 0)
659 (not appt-active)))
660 (remove-hook 'write-file-functions 'appt-update-list)
661 (or global-mode-string (setq global-mode-string '("")))
662 (delq 'appt-mode-string global-mode-string)
663 (when appt-timer
664 (cancel-timer appt-timer)
665 (setq appt-timer nil))
666 (when appt-active
667 (add-hook 'write-file-functions 'appt-update-list)
668 (setq appt-timer (run-at-time t 60 'appt-check)
669 global-mode-string
670 (append global-mode-string '(appt-mode-string)))
671 (appt-check t))))
672
673
674 (provide 'appt)
675
676 ;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
677 ;;; appt.el ends here