Unquote lambda functions.
[emacs.git] / lisp / calendar / appt.el
bloba43b46e13e59cb7fda59c2124eebeab1d2592302
1 ;;; appt.el --- appointment notification functions
3 ;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
8 ;; Keywords: calendar
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, or (at your option)
15 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
30 ;; appt.el - visible and/or audible notification of
31 ;; appointments from diary file.
33 ;;;
34 ;;; Thanks to Edward M. Reingold for much help and many suggestions,
35 ;;; And to many others for bug fixes and suggestions.
36 ;;;
37 ;;;
38 ;;; This functions in this file will alert the user of a
39 ;;; pending appointment based on his/her diary file. This package
40 ;;; is documented in the Emacs manual.
41 ;;;
42 ;;; To activate this package, simply use (appt-activate 1).
43 ;;; A `diary-file' with appointments of the format described in the
44 ;;; documentation of the function `appt-check' is required.
45 ;;; Relevant customizable variables are also listed in the
46 ;;; documentation of that function.
47 ;;;
48 ;;; Today's appointment list is initialized from the diary when this
49 ;;; package is activated. Additionally, the appointments list is
50 ;;; recreated automatically at 12:01am for those who do not logout
51 ;;; every day or are programming late. It is also updated when the
52 ;;; `diary-file' is saved. Calling `appt-check' with an argument forces
53 ;;; a re-initialization at any time.
54 ;;;
55 ;;; In order to add or delete items from today's list, without
56 ;;; changing the diary file, use `appt-add' and `appt-delete'.
57 ;;;
59 ;;; Brief internal description - Skip this if you are not interested!
60 ;;;
61 ;;; The function `appt-make-list' creates the appointments list which
62 ;;; `appt-check' reads.
63 ;;;
64 ;;; You can change the way the appointment window is created/deleted by
65 ;;; setting the variables
66 ;;;
67 ;;; appt-disp-window-function
68 ;;; and
69 ;;; appt-delete-window-function
70 ;;;
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.
74 ;;;
76 ;;; Code:
78 ;; Make sure calendar is loaded when we compile this.
79 (require 'calendar)
81 (defvar diary-selective-display)
84 (defgroup appt nil
85 "Appointment notification."
86 :group 'calendar)
88 (defcustom appt-issue-message t
89 "Non-nil means check for appointments in the diary buffer.
90 To be detected, the diary entry must have the format described in the
91 documentation of the function `appt-check'."
92 :type 'boolean
93 :group 'appt)
95 (make-obsolete-variable 'appt-issue-message
96 "use the function `appt-activate', and the \
97 variable `appt-display-format' instead." "22.1")
99 (defcustom appt-message-warning-time 12
100 "Time in minutes before an appointment that the warning begins."
101 :type 'integer
102 :group 'appt)
104 (defcustom appt-audible t
105 "Non-nil means beep to indicate appointment."
106 :type 'boolean
107 :group 'appt)
109 (defcustom appt-visible t
110 "Non-nil means display appointment message in echo area.
111 This variable is only relevant if `appt-msg-window' is nil."
112 :type 'boolean
113 :group 'appt)
115 (make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
117 (defcustom appt-msg-window t
118 "Non-nil means display appointment message in another window.
119 If non-nil, this variable overrides `appt-visible'."
120 :type 'boolean
121 :group 'appt)
123 (make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
125 ;; TODO - add popup.
126 (defcustom appt-display-format 'ignore
127 "How appointment reminders should be displayed.
128 The options are:
129 window - use a separate window
130 echo - use the echo area
131 nil - no visible reminder.
132 See also `appt-audible' and `appt-display-mode-line'.
134 The default value is 'ignore, which means to fall back on the value
135 of the (obsolete) variables `appt-msg-window' and `appt-visible'."
136 :type '(choice
137 (const :tag "Separate window" window)
138 (const :tag "Echo-area" echo)
139 (const :tag "No visible display" nil)
140 (const :tag "Backwards compatibility setting - choose another value"
141 ignore))
142 :group 'appt
143 :version "22.1")
145 (defcustom appt-display-mode-line t
146 "Non-nil means display minutes to appointment and time on the mode line.
147 This is in addition to any other display of appointment messages."
148 :type 'boolean
149 :group 'appt)
151 (defcustom appt-display-duration 10
152 "The number of seconds an appointment message is displayed.
153 Only relevant if reminders are to be displayed in their own window."
154 :type 'integer
155 :group 'appt)
157 (defcustom appt-display-diary t
158 "Non-nil displays the diary when the appointment list is first initialized.
159 This will occur at midnight when the appointment list is updated."
160 :type 'boolean
161 :group 'appt)
163 (defcustom appt-display-interval 3
164 "Number of minutes to wait between checking the appointment list."
165 :type 'integer
166 :group 'appt)
168 (defcustom appt-disp-window-function 'appt-disp-window
169 "Function called to display appointment window.
170 Only relevant if reminders are being displayed in a window."
171 :type '(choice (const appt-disp-window)
172 function)
173 :group 'appt)
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)
179 function)
180 :group 'appt)
183 ;;; Internal variables below this point.
185 (defconst appt-buffer-name " *appt-buf*"
186 "Name of the appointments buffer.")
188 (defvar appt-time-msg-list nil
189 "The list of appointments for today.
190 Use `appt-add' and `appt-delete' to add and delete appointments.
191 The original list is generated from today's `diary-entries-list', and
192 can be regenerated using the function `appt-check'.
193 Each element of the generated list has the form (MINUTES STRING [FLAG]); where
194 MINUTES is the time in minutes of the appointment after midnight, and
195 STRING is the description of the appointment.
196 FLAG, if non-nil, says that the element was made with `appt-add'
197 so calling `appt-make-list' again should preserve it.")
199 (defconst appt-max-time (1- (* 24 60))
200 "11:59pm in minutes - number of minutes in a day minus 1.")
202 (defvar appt-mode-string nil
203 "String being displayed in the mode line saying you have an appointment.
204 The actual string includes the amount of time till the appointment.
205 Only used if `appt-display-mode-line' is non-nil.")
207 (defvar appt-prev-comp-time nil
208 "Time of day (mins since midnight) at which we last checked appointments.
209 A nil value forces the diary file to be (re-)checked for appointments.")
211 (defvar appt-now-displayed nil
212 "Non-nil when we have started notifying about a appointment that is near.")
214 (defvar appt-display-count nil
215 "Internal variable used to count number of consecutive reminders.")
217 (defvar appt-timer nil
218 "Timer used for diary appointment notifications (`appt-check').
219 If this is non-nil, appointment checking is active.")
222 ;;; Functions.
224 (defun appt-display-message (string mins)
225 "Display a reminder about an appointment.
226 The string STRING describes the appointment, due in integer MINS minutes.
227 The format of the visible reminder is controlled by `appt-display-format'.
228 The variable `appt-audible' controls the audible reminder."
229 ;; let binding for backwards compatability. Remove when obsolete
230 ;; vars appt-msg-window and appt-visible are dropped.
231 (let ((appt-display-format
232 (if (eq appt-display-format 'ignore)
233 (cond (appt-msg-window 'window)
234 (appt-visible 'echo))
235 appt-display-format)))
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
240 ;; than %b?
241 (format-time-string "%a %b %e " (current-time))
242 string)
243 (run-at-time (format "%d sec" appt-display-duration)
245 appt-delete-window-function))
246 ((eq appt-display-format 'echo)
247 (message "%s" string)))
248 (if appt-audible (beep 1))))
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.
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:
261 02/23/89
262 18:00 Dinner
264 Thursday
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.
273 `appt-audible'
274 Variable used to determine if reminder is audible.
275 Default is t.
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.
288 `appt-display-diary'
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."
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
308 ;; and display in whatever ways the user has selected.
309 ;; When no appointment is being displayed,
310 ;; we always do a full check.
311 (full-check
312 (or (not appt-now-displayed)
313 ;; This is true every appt-display-interval minutes.
314 (zerop (mod prev-appt-display-count appt-display-interval))))
315 ;; Non-nil means only update the interval displayed in the mode line.
316 (mode-line-only
317 (and (not full-check) appt-now-displayed)))
319 (when (or full-check mode-line-only)
320 (save-excursion
322 ;; Get the current time and convert it to minutes
323 ;; from midnight. ie. 12:01am = 1, midnight = 0.
325 (let* ((now (decode-time))
326 (cur-hour (nth 2 now))
327 (cur-min (nth 1 now))
328 (cur-comp-time (+ (* cur-hour 60) cur-min)))
330 ;; At the first check in any given day, update our
331 ;; appointments to today's list.
333 (if (or force ; eg initialize, diary save
334 (null appt-prev-comp-time) ; first check
335 (< cur-comp-time appt-prev-comp-time)) ; new day
336 (condition-case nil
337 (if appt-display-diary
338 (let ((diary-hook
339 (if (assoc 'appt-make-list diary-hook)
340 diary-hook
341 (cons 'appt-make-list diary-hook))))
342 (diary))
343 (let* ((diary-display-hook 'appt-make-list)
344 (d-buff (find-buffer-visiting
345 (substitute-in-file-name diary-file)))
346 (selective
347 (if d-buff ; Diary buffer exists.
348 (with-current-buffer d-buff
349 diary-selective-display))))
350 (diary)
351 ;; If the diary buffer existed before this command,
352 ;; restore its display state. Otherwise, kill it.
353 (if d-buff
354 ;; Displays the diary buffer.
355 (or selective (diary-show-all-entries))
356 (and
357 (setq d-buff (find-buffer-visiting
358 (substitute-in-file-name diary-file)))
359 (kill-buffer d-buff)))))
360 (error nil)))
362 (setq appt-prev-comp-time cur-comp-time
363 appt-mode-string nil
364 appt-display-count nil)
366 ;; If there are entries in the list, and the
367 ;; user wants a message issued,
368 ;; get the first time off of the list
369 ;; and calculate the number of minutes until the appointment.
371 (if (and appt-issue-message appt-time-msg-list)
372 (let ((appt-comp-time (car (car (car appt-time-msg-list)))))
373 (setq min-to-app (- appt-comp-time cur-comp-time))
375 (while (and appt-time-msg-list
376 (< appt-comp-time cur-comp-time))
377 (setq appt-time-msg-list (cdr appt-time-msg-list))
378 (if appt-time-msg-list
379 (setq appt-comp-time
380 (car (car (car appt-time-msg-list))))))
382 ;; If we have an appointment between midnight and
383 ;; 'appt-message-warning-time' minutes after midnight,
384 ;; we must begin to issue a message before midnight.
385 ;; Midnight is considered 0 minutes and 11:59pm is
386 ;; 1439 minutes. Therefore we must recalculate the minutes
387 ;; to appointment variable. It is equal to the number of
388 ;; minutes before midnight plus the number of
389 ;; minutes after midnight our appointment is.
391 (if (and (< appt-comp-time appt-message-warning-time)
392 (> (+ cur-comp-time appt-message-warning-time)
393 appt-max-time))
394 (setq min-to-app (+ (- (1+ appt-max-time) cur-comp-time)
395 appt-comp-time)))
397 ;; issue warning if the appointment time is
398 ;; within appt-message-warning time
400 (when (and (<= min-to-app appt-message-warning-time)
401 (>= min-to-app 0))
402 (setq appt-now-displayed t
403 appt-display-count (1+ prev-appt-display-count))
404 (unless mode-line-only
405 (appt-display-message (cadr (car appt-time-msg-list))
406 min-to-app))
407 (when appt-display-mode-line
408 (setq appt-mode-string
409 (format " App't in %s min." min-to-app)))
411 ;; When an appointment is reached,
412 ;; delete it from the list.
413 ;; Reset the count to 0 in case we display another
414 ;; appointment on the next cycle.
415 (if (zerop min-to-app)
416 (setq appt-time-msg-list (cdr appt-time-msg-list)
417 appt-display-count nil)))))
419 ;; If we have changed the mode line string,
420 ;; redisplay all mode lines.
421 (and appt-display-mode-line
422 (not (equal appt-mode-string
423 prev-appt-mode-string))
424 (progn
425 (force-mode-line-update t)
426 ;; If the string now has a notification,
427 ;; redisplay right now.
428 (if appt-mode-string
429 (sit-for 0)))))))))
432 (defun appt-disp-window (min-to-app new-time appt-msg)
433 "Display appointment message APPT-MSG in a separate buffer.
434 The appointment is due in MIN-TO-APP (a string) minutes.
435 NEW-TIME is a string giving the date."
436 ;; Make sure we're not in the minibuffer before splitting the window.
437 ;; FIXME this seems needlessly complicated?
438 (when (minibufferp)
439 (other-window 1)
440 (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
441 (let ((this-window (selected-window))
442 (appt-disp-buf (set-buffer (get-buffer-create appt-buffer-name))))
443 (if (cdr (assq 'unsplittable (frame-parameters)))
444 ;; In an unsplittable frame, use something somewhere else.
445 (display-buffer appt-disp-buf)
446 (unless (or (special-display-p (buffer-name appt-disp-buf))
447 (same-window-p (buffer-name appt-disp-buf)))
448 ;; By default, split the bottom window and use the lower part.
449 (appt-select-lowest-window)
450 ;; Split the window, unless it's too small to do so.
451 (when (>= (window-height) (* 2 window-min-height))
452 (select-window (split-window))))
453 (switch-to-buffer appt-disp-buf))
454 (calendar-set-mode-line
455 (format " Appointment in %s minutes. %s " min-to-app new-time))
456 (erase-buffer)
457 (insert appt-msg)
458 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
459 (set-buffer-modified-p nil)
460 (raise-frame (selected-frame))
461 (select-window this-window)))
463 (defun appt-delete-window ()
464 "Function called to undisplay appointment messages.
465 Usually just deletes the appointment buffer."
466 (let ((window (get-buffer-window appt-buffer-name t)))
467 (and window
468 (or (eq window (frame-root-window (window-frame window)))
469 (delete-window window))))
470 (kill-buffer appt-buffer-name)
471 (if appt-audible
472 (beep 1)))
474 (defun appt-select-lowest-window ()
475 "Select the lowest window on the frame."
476 (let ((lowest-window (selected-window))
477 (bottom-edge (nth 3 (window-edges))))
478 (walk-windows (lambda (w)
479 (let ((next-bottom-edge (nth 3 (window-edges w))))
480 (when (< bottom-edge next-bottom-edge)
481 (setq bottom-edge next-bottom-edge
482 lowest-window w)))) 'nomini)
483 (select-window lowest-window)))
485 (defconst appt-time-regexp
486 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
488 ;;;###autoload
489 (defun appt-add (new-appt-time new-appt-msg)
490 "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
491 The time should be in either 24 hour format or am/pm format."
492 (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
493 (unless (string-match appt-time-regexp new-appt-time)
494 (error "Unacceptable time-string"))
495 (let ((time-msg (list (list (appt-convert-time new-appt-time))
496 (concat new-appt-time " " new-appt-msg) t)))
497 (unless (member time-msg appt-time-msg-list)
498 (setq appt-time-msg-list
499 (appt-sort-list (nconc appt-time-msg-list (list time-msg)))))))
501 ;;;###autoload
502 (defun appt-delete ()
503 "Delete an appointment from the list of appointments."
504 (interactive)
505 (let ((tmp-msg-list appt-time-msg-list))
506 (while tmp-msg-list
507 (let* ((element (car tmp-msg-list))
508 (prompt-string (concat "Delete "
509 ;; We want to quote any doublequotes
510 ;; in the string, as well as put
511 ;; doublequotes around it.
512 (prin1-to-string
513 (substring-no-properties
514 (car (cdr element)) 0))
515 " from list? "))
516 (test-input (y-or-n-p prompt-string)))
517 (setq tmp-msg-list (cdr tmp-msg-list))
518 (if test-input
519 (setq appt-time-msg-list (delq element appt-time-msg-list)))))
520 (appt-check)
521 (message "")))
524 (defvar number)
525 (defvar original-date)
526 (defvar diary-entries-list)
527 ;;;###autoload
528 (defun appt-make-list ()
529 "Update the appointments list from today's diary buffer.
530 The time must be at the beginning of a line for it to be
531 put in the appointments list (see examples in documentation of
532 the function `appt-check'). We assume that the variables DATE and
533 NUMBER hold the arguments that `diary-list-entries' received.
534 They specify the range of dates that the diary is being processed for.
536 Any appointments made with `appt-add' are not affected by this
537 function.
539 For backwards compatibility, this function activates the
540 appointment package (if it is not already active)."
541 ;; See comments above appt-activate defun.
542 (if (not appt-timer)
543 (appt-activate 1)
544 ;; We have something to do if the range of dates that the diary is
545 ;; considering includes the current date.
546 (if (and (not (calendar-date-compare
547 (list (calendar-current-date))
548 (list original-date)))
549 (calendar-date-compare
550 (list (calendar-current-date))
551 (list (calendar-gregorian-from-absolute
552 (+ (calendar-absolute-from-gregorian original-date)
553 number)))))
554 (save-excursion
555 ;; Clear the appointments list, then fill it in from the diary.
556 (dolist (elt appt-time-msg-list)
557 ;; Delete any entries that were not made with appt-add.
558 (unless (nth 2 elt)
559 (setq appt-time-msg-list
560 (delq elt appt-time-msg-list))))
561 (if diary-entries-list
563 ;; Cycle through the entry-list (diary-entries-list)
564 ;; looking for entries beginning with a time. If
565 ;; the entry begins with a time, add it to the
566 ;; appt-time-msg-list. Then sort the list.
568 (let ((entry-list diary-entries-list)
569 (new-time-string ""))
570 ;; Skip diary entries for dates before today.
571 (while (and entry-list
572 (calendar-date-compare
573 (car entry-list) (list (calendar-current-date))))
574 (setq entry-list (cdr entry-list)))
575 ;; Parse the entries for today.
576 (while (and entry-list
577 (calendar-date-equal
578 (calendar-current-date) (car (car entry-list))))
579 (let ((time-string (cadr (car entry-list))))
580 (while (string-match appt-time-regexp time-string)
581 (let* ((beg (match-beginning 0))
582 ;; Get just the time for this appointment.
583 (only-time (match-string 0 time-string))
584 ;; Find the end of this appointment
585 ;; (the start of the next).
586 (end (string-match
587 (concat "\n[ \t]*" appt-time-regexp)
588 time-string
589 (match-end 0)))
590 ;; Get the whole string for this appointment.
591 (appt-time-string
592 (substring time-string beg (if end (1- end)))))
594 ;; Add this appointment to appt-time-msg-list.
595 (let* ((appt-time (list (appt-convert-time only-time)))
596 (time-msg (list appt-time appt-time-string)))
597 (setq appt-time-msg-list
598 (nconc appt-time-msg-list (list time-msg))))
600 ;; Discard this appointment from the string.
601 (setq time-string
602 (if end (substring time-string end) "")))))
603 (setq entry-list (cdr entry-list)))))
604 (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
606 ;; Get the current time and convert it to minutes
607 ;; from midnight. ie. 12:01am = 1, midnight = 0,
608 ;; so that the elements in the list
609 ;; that are earlier than the present time can
610 ;; be removed.
612 (let* ((now (decode-time))
613 (cur-hour (nth 2 now))
614 (cur-min (nth 1 now))
615 (cur-comp-time (+ (* cur-hour 60) cur-min))
616 (appt-comp-time (car (caar appt-time-msg-list))))
618 (while (and appt-time-msg-list (< appt-comp-time cur-comp-time))
619 (setq appt-time-msg-list (cdr appt-time-msg-list))
620 (if appt-time-msg-list
621 (setq appt-comp-time (car (caar appt-time-msg-list))))))))))
624 (defun appt-sort-list (appt-list)
625 "Sort an appointment list, putting earlier items at the front.
626 APPT-LIST is a list of the same format as `appt-time-msg-list'."
627 (sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
630 (defun appt-convert-time (time2conv)
631 "Convert hour:min[am/pm] format to minutes from midnight.
632 A period (.) can be used instead of a colon (:) to separate the
633 hour and minute parts."
634 ;; Formats that should be accepted:
635 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
636 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv)
637 (string-to-number (match-string 1 time2conv))
639 (hr (if (string-match "[0-9]*[0-9]" time2conv)
640 (string-to-number (match-string 0 time2conv))
641 0)))
643 ;; convert the time appointment time into 24 hour time
644 (cond ((and (string-match "pm" time2conv) (< hr 12))
645 (setq hr (+ 12 hr)))
646 ((and (string-match "am" time2conv) (= hr 12))
647 (setq hr 0)))
649 ;; convert the actual time into minutes.
650 (+ (* hr 60) min)))
653 (defun appt-update-list ()
654 "If the current buffer is visiting the diary, update appointments.
655 This function is intended for use with `write-file-functions'."
656 (and (string-equal buffer-file-name (expand-file-name diary-file))
657 appt-timer
658 (let ((appt-display-diary nil))
659 (appt-check t)))
660 nil)
663 ;; In Emacs-21.3, the manual documented the following procedure to
664 ;; activate this package:
665 ;; (display-time)
666 ;; (add-hook 'diary-hook 'appt-make-list)
667 ;; (diary 0)
668 ;; The display-time call was not necessary, AFAICS.
669 ;; What was really needed was to add the hook and load this file.
670 ;; Calling (diary 0) once the hook had been added was in some sense a
671 ;; roundabout way of loading this file. This file used to have code at
672 ;; the top-level that set up the appt-timer and global-mode-string.
673 ;; One way to maintain backwards compatibility would be to call
674 ;; (appt-activate 1) at top-level. However, this goes against the
675 ;; convention that just loading an Emacs package should not activate
676 ;; it. Instead, we make appt-make-list activate the package (after a
677 ;; suggestion from rms). This means that one has to call diary in
678 ;; order to get it to work, but that is in line with the old (weird,
679 ;; IMO) documented behavior for activating the package.
680 ;; Actually, since (diary 0) does not run diary-hook, I don't think
681 ;; the documented behavior in Emacs-21.3 would ever have worked.
682 ;; Oh well, at least with the changes to appt-make-list it will now
683 ;; work as well as it ever did.
684 ;; The new method is just to use (appt-activate 1).
685 ;; -- gmorris
687 ;;;###autoload
688 (defun appt-activate (&optional arg)
689 "Toggle checking of appointments.
690 With optional numeric argument ARG, turn appointment checking on if
691 ARG is positive, otherwise off."
692 (interactive "P")
693 (let ((appt-active appt-timer))
694 (setq appt-active (if arg (> (prefix-numeric-value arg) 0)
695 (not appt-active)))
696 (remove-hook 'write-file-functions 'appt-update-list)
697 (or global-mode-string (setq global-mode-string '("")))
698 (delq 'appt-mode-string global-mode-string)
699 (when appt-timer
700 (cancel-timer appt-timer)
701 (setq appt-timer nil))
702 (when appt-active
703 (add-hook 'write-file-functions 'appt-update-list)
704 (setq appt-timer (run-at-time t 60 'appt-check)
705 global-mode-string
706 (append global-mode-string '(appt-mode-string)))
707 (appt-check t))))
710 (provide 'appt)
712 ;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
713 ;;; appt.el ends here