]> code.delx.au - gnu-emacs/blob - lisp/calendar/appt.el
36934783b9395f5c75fbfcf01eabfb8150d5c5b0
[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 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 2, or (at your option)
15 ;; 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; 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.
26
27 ;;; Commentary:
28
29 ;;
30 ;; appt.el - visible and/or audible notification of
31 ;; appointments from diary file.
32 ;;
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 ;;;
58
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 ;;;
75
76 ;;; Code:
77
78 ;; Make sure calendar is loaded when we compile this.
79 (require 'calendar)
80
81 (defvar diary-selective-display)
82
83 ;;;###autoload
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 ;;;###autoload
96 (defcustom appt-message-warning-time 12
97 "*Time in minutes before an appointment that the warning begins."
98 :type 'integer
99 :group 'appt)
100
101 ;;;###autoload
102 (defcustom appt-audible t
103 "*Non-nil means beep to indicate appointment."
104 :type 'boolean
105 :group 'appt)
106
107 ;;;###autoload
108 (defcustom appt-visible t
109 "*Non-nil means display appointment message in echo area.
110 This variable is only relevant if `appt-msg-window' is nil."
111 :type 'boolean
112 :group 'appt)
113
114 (make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
115
116 ;;;###autoload
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)
122
123 (make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
124
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'.
133
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 :group 'appt
141 :version "22.1")
142
143 ;;;###autoload
144 (defcustom appt-display-mode-line t
145 "*Non-nil means display minutes to appointment and time on the mode line.
146 This is in addition to any other display of appointment messages."
147 :type 'boolean
148 :group 'appt)
149
150 ;;;###autoload
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)
156
157 ;;;###autoload
158 (defcustom appt-display-diary t
159 "*Non-nil displays the diary when the appointment list is first initialized.
160 This will occur at midnight when the appointment list is updated."
161 :type 'boolean
162 :group 'appt)
163
164 (defcustom appt-display-interval 3
165 "*Number of minutes to wait between checking the appointment list."
166 :type 'integer
167 :group 'appt)
168
169 (defcustom appt-disp-window-function 'appt-disp-window
170 "Function called to display appointment window.
171 Only relevant if reminders are being displayed in a window."
172 :type '(choice (const appt-disp-window)
173 function)
174 :group 'appt)
175
176 (defcustom appt-delete-window-function 'appt-delete-window
177 "Function called to remove appointment window and buffer.
178 Only relevant if reminders are being displayed in a window."
179 :type '(choice (const appt-delete-window)
180 function)
181 :group 'appt)
182
183
184 ;;; Internal variables below this point.
185
186 (defconst appt-buffer-name " *appt-buf*"
187 "Name of the appointments buffer.")
188
189 (defvar appt-time-msg-list nil
190 "The list of appointments for today.
191 Use `appt-add' and `appt-delete' to add and delete appointments.
192 The original list is generated from today's `diary-entries-list', and
193 can be regenerated using the function `appt-check'.
194 Each element of the generated list has the form (MINUTES STRING [FLAG]); where
195 MINUTES is the time in minutes of the appointment after midnight, and
196 STRING is the description of the appointment.
197 FLAG, if non-nil, says that the element was made with `appt-add'
198 so calling `appt-make-list' again should preserve it.")
199
200 (defconst appt-max-time (1- (* 24 60))
201 "11:59pm in minutes - number of minutes in a day minus 1.")
202
203 (defvar appt-mode-string nil
204 "String being displayed in the mode line saying you have an appointment.
205 The actual string includes the amount of time till the appointment.
206 Only used if `appt-display-mode-line' is non-nil.")
207
208 (defvar appt-prev-comp-time nil
209 "Time of day (mins since midnight) at which we last checked appointments.
210 A nil value forces the diary file to be (re-)checked for appointments.")
211
212 (defvar appt-now-displayed nil
213 "Non-nil when we have started notifying about a appointment that is near.")
214
215 (defvar appt-display-count nil
216 "Internal variable used to count number of consecutive reminders.")
217
218 (defvar appt-timer nil
219 "Timer used for diary appointment notifications (`appt-check').
220 If this is non-nil, appointment checking is active.")
221
222
223 ;;; Functions.
224
225 (defun appt-display-message (string mins)
226 "Display a reminder about an appointment.
227 The string STRING describes the appointment, due in integer MINS minutes.
228 The format of the visible reminder is controlled by `appt-display-format'.
229 The variable `appt-audible' controls the audible reminder."
230 ;; let binding for backwards compatability. Remove when obsolete
231 ;; vars appt-msg-window and appt-visible are dropped.
232 (let ((appt-display-format
233 (if (eq appt-display-format 'ignore)
234 (cond (appt-msg-window 'window)
235 (appt-visible 'echo))
236 appt-display-format)))
237 (cond ((eq appt-display-format 'window)
238 (funcall appt-disp-window-function
239 (number-to-string mins)
240 ;; TODO - use calendar-month-abbrev-array rather
241 ;; than %b?
242 (format-time-string "%a %b %e " (current-time))
243 string)
244 (run-at-time (format "%d sec" appt-display-duration)
245 nil
246 appt-delete-window-function))
247 ((eq appt-display-format 'echo)
248 (message "%s" string)))
249 (if appt-audible (beep 1))))
250
251
252 (defun appt-check (&optional force)
253 "Check for an appointment and update any reminder display.
254 If optional argument FORCE is non-nil, reparse the diary file for
255 appointments. Otherwise the diary file is only parsed once per day,
256 and when saved.
257
258 Note: the time must be the first thing in the line in the diary
259 for a warning to be issued. The format of the time can be either
260 24 hour or am/pm. For example:
261
262 02/23/89
263 18:00 Dinner
264
265 Thursday
266 11:45am Lunch meeting.
267
268 Appointments are checked every `appt-display-interval' minutes.
269 The following variables control appointment notification:
270
271 `appt-display-format'
272 Controls the format in which reminders are displayed.
273
274 `appt-audible'
275 Variable used to determine if reminder is audible.
276 Default is t.
277
278 `appt-message-warning-time'
279 Variable used to determine when appointment message
280 should first be displayed.
281
282 `appt-display-mode-line'
283 If non-nil, a generic message giving the time remaining
284 is shown in the mode-line when an appointment is due.
285
286 `appt-display-interval'
287 Interval in minutes at which to check for pending appointments.
288
289 `appt-display-diary'
290 Display the diary buffer when the appointment list is
291 initialized for the first time in a day.
292
293 The following variables are only relevant if reminders are being
294 displayed in a window:
295
296 `appt-display-duration'
297 The number of seconds an appointment message is displayed.
298
299 `appt-disp-window-function'
300 Function called to display appointment window.
301
302 `appt-delete-window-function'
303 Function called to remove appointment window and buffer."
304
305 (let* ((min-to-app -1)
306 (prev-appt-mode-string appt-mode-string)
307 (prev-appt-display-count (or appt-display-count 0))
308 ;; Non-nil means do a full check for pending appointments
309 ;; and display in whatever ways the user has selected.
310 ;; When no appointment is being displayed,
311 ;; we always do a full check.
312 (full-check
313 (or (not appt-now-displayed)
314 ;; This is true every appt-display-interval minutes.
315 (zerop (mod prev-appt-display-count appt-display-interval))))
316 ;; Non-nil means only update the interval displayed in the mode line.
317 (mode-line-only
318 (and (not full-check) appt-now-displayed)))
319
320 (when (or full-check mode-line-only)
321 (save-excursion
322
323 ;; Get the current time and convert it to minutes
324 ;; from midnight. ie. 12:01am = 1, midnight = 0.
325
326 (let* ((now (decode-time))
327 (cur-hour (nth 2 now))
328 (cur-min (nth 1 now))
329 (cur-comp-time (+ (* cur-hour 60) cur-min)))
330
331 ;; At the first check in any given day, update our
332 ;; appointments to today's list.
333
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
337 (condition-case nil
338 (if appt-display-diary
339 (let ((diary-hook
340 (if (assoc 'appt-make-list diary-hook)
341 diary-hook
342 (cons 'appt-make-list diary-hook))))
343 (diary))
344 (let* ((diary-display-hook 'appt-make-list)
345 (d-buff (find-buffer-visiting
346 (substitute-in-file-name diary-file)))
347 (selective
348 (if d-buff ; Diary buffer exists.
349 (with-current-buffer d-buff
350 diary-selective-display))))
351 (diary)
352 ;; If the diary buffer existed before this command,
353 ;; restore its display state. Otherwise, kill it.
354 (if d-buff
355 ;; Displays the diary buffer.
356 (or selective (show-all-diary-entries))
357 (and
358 (setq d-buff (find-buffer-visiting
359 (substitute-in-file-name diary-file)))
360 (kill-buffer d-buff)))))
361 (error nil)))
362
363 (setq appt-prev-comp-time cur-comp-time
364 appt-mode-string nil
365 appt-display-count nil)
366
367 ;; If there are entries in the list, and the
368 ;; user wants a message issued,
369 ;; get the first time off of the list
370 ;; and calculate the number of minutes until the appointment.
371
372 (if (and appt-issue-message appt-time-msg-list)
373 (let ((appt-comp-time (car (car (car appt-time-msg-list)))))
374 (setq min-to-app (- appt-comp-time cur-comp-time))
375
376 (while (and appt-time-msg-list
377 (< appt-comp-time cur-comp-time))
378 (setq appt-time-msg-list (cdr appt-time-msg-list))
379 (if appt-time-msg-list
380 (setq appt-comp-time
381 (car (car (car appt-time-msg-list))))))
382
383 ;; If we have an appointment between midnight and
384 ;; 'appt-message-warning-time' minutes after midnight,
385 ;; we must begin to issue a message before midnight.
386 ;; Midnight is considered 0 minutes and 11:59pm is
387 ;; 1439 minutes. Therefore we must recalculate the minutes
388 ;; to appointment variable. It is equal to the number of
389 ;; minutes before midnight plus the number of
390 ;; minutes after midnight our appointment is.
391
392 (if (and (< appt-comp-time appt-message-warning-time)
393 (> (+ cur-comp-time appt-message-warning-time)
394 appt-max-time))
395 (setq min-to-app (+ (- (1+ appt-max-time) cur-comp-time))
396 appt-comp-time))
397
398 ;; issue warning if the appointment time is
399 ;; within appt-message-warning time
400
401 (when (and (<= min-to-app appt-message-warning-time)
402 (>= min-to-app 0))
403 (setq appt-now-displayed t
404 appt-display-count (1+ prev-appt-display-count))
405 (unless mode-line-only
406 (appt-display-message (cadr (car appt-time-msg-list))
407 min-to-app))
408 (when appt-display-mode-line
409 (setq appt-mode-string
410 (format " App't in %s min." min-to-app)))
411
412 ;; When an appointment is reached,
413 ;; delete it from the list.
414 ;; Reset the count to 0 in case we display another
415 ;; appointment on the next cycle.
416 (if (zerop min-to-app)
417 (setq appt-time-msg-list (cdr appt-time-msg-list)
418 appt-display-count nil)))))
419
420 ;; If we have changed the mode line string,
421 ;; redisplay all mode lines.
422 (and appt-display-mode-line
423 (not (equal appt-mode-string
424 prev-appt-mode-string))
425 (progn
426 (force-mode-line-update t)
427 ;; If the string now has a notification,
428 ;; redisplay right now.
429 (if appt-mode-string
430 (sit-for 0)))))))))
431
432
433 (defun appt-disp-window (min-to-app new-time appt-msg)
434 "Display appointment message APPT-MSG in a separate buffer.
435 The appointment is due in MIN-TO-APP (a string) minutes.
436 NEW-TIME is a string giving the date."
437 (require 'electric)
438
439 ;; Make sure we're not in the minibuffer
440 ;; before splitting the window.
441
442 (if (equal (selected-window) (minibuffer-window))
443 (if (other-window 1)
444 (select-window (other-window 1))
445 (if (display-multi-frame-p)
446 (select-frame (other-frame 1)))))
447
448 (let ((this-window (selected-window))
449 (appt-disp-buf (set-buffer (get-buffer-create appt-buffer-name))))
450
451 (if (cdr (assq 'unsplittable (frame-parameters)))
452 ;; In an unsplittable frame, use something somewhere else.
453 (display-buffer appt-disp-buf)
454 (unless (or (special-display-p (buffer-name appt-disp-buf))
455 (same-window-p (buffer-name appt-disp-buf)))
456 ;; By default, split the bottom window and use the lower part.
457 (appt-select-lowest-window)
458 (select-window (split-window)))
459 (switch-to-buffer appt-disp-buf))
460 (calendar-set-mode-line
461 (format " Appointment in %s minutes. %s " min-to-app new-time))
462 (erase-buffer)
463 (insert appt-msg)
464 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
465 (set-buffer-modified-p nil)
466 (raise-frame (selected-frame))
467 (select-window this-window)))
468
469 (defun appt-delete-window ()
470 "Function called to undisplay appointment messages.
471 Usually just deletes the appointment buffer."
472 (let ((window (get-buffer-window appt-buffer-name t)))
473 (and window
474 (or (eq window (frame-root-window (window-frame window)))
475 (delete-window window))))
476 (kill-buffer appt-buffer-name)
477 (if appt-audible
478 (beep 1)))
479
480 (defun appt-select-lowest-window ()
481 "Select the lowest window on the frame."
482 (let ((lowest-window (selected-window))
483 (bottom-edge (nth 3 (window-edges))))
484 (walk-windows (lambda (w)
485 (let ((next-bottom-edge (nth 3 (window-edges w))))
486 (when (< bottom-edge next-bottom-edge)
487 (setq bottom-edge next-bottom-edge
488 lowest-window w)))))
489 (select-window lowest-window)))
490
491 (defconst appt-time-regexp
492 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
493
494 ;;;###autoload
495 (defun appt-add (new-appt-time new-appt-msg)
496 "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
497 The time should be in either 24 hour format or am/pm format."
498 (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
499 (unless (string-match appt-time-regexp new-appt-time)
500 (error "Unacceptable time-string"))
501 (let ((time-msg (list (list (appt-convert-time new-appt-time))
502 (concat new-appt-time " " new-appt-msg) t)))
503 (unless (member time-msg appt-time-msg-list)
504 (setq appt-time-msg-list
505 (appt-sort-list (nconc appt-time-msg-list (list time-msg)))))))
506
507 ;;;###autoload
508 (defun appt-delete ()
509 "Delete an appointment from the list of appointments."
510 (interactive)
511 (let ((tmp-msg-list appt-time-msg-list))
512 (while tmp-msg-list
513 (let* ((element (car tmp-msg-list))
514 (prompt-string (concat "Delete "
515 ;; We want to quote any doublequotes
516 ;; in the string, as well as put
517 ;; doublequotes around it.
518 (prin1-to-string
519 (substring-no-properties
520 (car (cdr element)) 0))
521 " from list? "))
522 (test-input (y-or-n-p prompt-string)))
523 (setq tmp-msg-list (cdr tmp-msg-list))
524 (if test-input
525 (setq appt-time-msg-list (delq element appt-time-msg-list)))))
526 (appt-check)
527 (message "")))
528
529
530 (eval-when-compile (defvar number)
531 (defvar original-date)
532 (defvar diary-entries-list))
533 ;;;###autoload
534 (defun appt-make-list ()
535 "Update the appointments list from today's diary buffer.
536 The time must be at the beginning of a line for it to be
537 put in the appointments list (see examples in documentation of
538 the function `appt-check'). We assume that the variables DATE and
539 NUMBER hold the arguments that `list-diary-entries' received.
540 They specify the range of dates that the diary is being processed for.
541
542 Any appointments made with `appt-add' are not affected by this
543 function.
544
545 For backwards compatibility, this function activates the
546 appointment package (if it is not already active)."
547 ;; See comments above appt-activate defun.
548 (if (not appt-timer)
549 (appt-activate 1)
550 ;; We have something to do if the range of dates that the diary is
551 ;; considering includes the current date.
552 (if (and (not (calendar-date-compare
553 (list (calendar-current-date))
554 (list original-date)))
555 (calendar-date-compare
556 (list (calendar-current-date))
557 (list (calendar-gregorian-from-absolute
558 (+ (calendar-absolute-from-gregorian original-date)
559 number)))))
560 (save-excursion
561 ;; Clear the appointments list, then fill it in from the diary.
562 (dolist (elt appt-time-msg-list)
563 ;; Delete any entries that were not made with appt-add.
564 (unless (nth 2 elt)
565 (setq appt-time-msg-list
566 (delq elt appt-time-msg-list))))
567 (if diary-entries-list
568
569 ;; Cycle through the entry-list (diary-entries-list)
570 ;; looking for entries beginning with a time. If
571 ;; the entry begins with a time, add it to the
572 ;; appt-time-msg-list. Then sort the list.
573
574 (let ((entry-list diary-entries-list)
575 (new-time-string ""))
576 ;; Skip diary entries for dates before today.
577 (while (and entry-list
578 (calendar-date-compare
579 (car entry-list) (list (calendar-current-date))))
580 (setq entry-list (cdr entry-list)))
581 ;; Parse the entries for today.
582 (while (and entry-list
583 (calendar-date-equal
584 (calendar-current-date) (car (car entry-list))))
585 (let ((time-string (cadr (car entry-list))))
586 (while (string-match appt-time-regexp time-string)
587 (let* ((beg (match-beginning 0))
588 ;; Get just the time for this appointment.
589 (only-time (match-string 0 time-string))
590 ;; Find the end of this appointment
591 ;; (the start of the next).
592 (end (string-match
593 (concat "\n[ \t]*" appt-time-regexp)
594 time-string
595 (match-end 0)))
596 ;; Get the whole string for this appointment.
597 (appt-time-string
598 (substring time-string beg (if end (1- end)))))
599
600 ;; Add this appointment to appt-time-msg-list.
601 (let* ((appt-time (list (appt-convert-time only-time)))
602 (time-msg (list appt-time appt-time-string)))
603 (setq appt-time-msg-list
604 (nconc appt-time-msg-list (list time-msg))))
605
606 ;; Discard this appointment from the string.
607 (setq time-string
608 (if end (substring time-string end) "")))))
609 (setq entry-list (cdr entry-list)))))
610 (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
611
612 ;; Get the current time and convert it to minutes
613 ;; from midnight. ie. 12:01am = 1, midnight = 0,
614 ;; so that the elements in the list
615 ;; that are earlier than the present time can
616 ;; be removed.
617
618 (let* ((now (decode-time))
619 (cur-hour (nth 2 now))
620 (cur-min (nth 1 now))
621 (cur-comp-time (+ (* cur-hour 60) cur-min))
622 (appt-comp-time (car (caar appt-time-msg-list))))
623
624 (while (and appt-time-msg-list (< appt-comp-time cur-comp-time))
625 (setq appt-time-msg-list (cdr appt-time-msg-list))
626 (if appt-time-msg-list
627 (setq appt-comp-time (car (caar appt-time-msg-list))))))))))
628
629
630 (defun appt-sort-list (appt-list)
631 "Sort an appointment list, putting earlier items at the front.
632 APPT-LIST is a list of the same format as `appt-time-msg-list'."
633 (sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
634
635
636 (defun appt-convert-time (time2conv)
637 "Convert hour:min[am/pm] format to minutes from midnight.
638 A period (.) can be used instead of a colon (:) to separate the
639 hour and minute parts."
640 ;; Formats that should be accepted:
641 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
642 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv)
643 (string-to-number (match-string 1 time2conv))
644 0))
645 (hr (if (string-match "[0-9]*[0-9]" time2conv)
646 (string-to-number (match-string 0 time2conv))
647 0)))
648
649 ;; convert the time appointment time into 24 hour time
650 (cond ((and (string-match "pm" time2conv) (< hr 12))
651 (setq hr (+ 12 hr)))
652 ((and (string-match "am" time2conv) (= hr 12))
653 (setq hr 0)))
654
655 ;; convert the actual time into minutes.
656 (+ (* hr 60) min)))
657
658
659 (defun appt-update-list ()
660 "If the current buffer is visiting the diary, update appointments.
661 This function is intended for use with `write-file-functions'."
662 (and (string-equal buffer-file-name (expand-file-name diary-file))
663 appt-timer
664 (let ((appt-display-diary nil))
665 (appt-check t)))
666 nil)
667
668
669 ;; In Emacs-21.3, the manual documented the following procedure to
670 ;; activate this package:
671 ;; (display-time)
672 ;; (add-hook 'diary-hook 'appt-make-list)
673 ;; (diary 0)
674 ;; The display-time call was not necessary, AFAICS.
675 ;; What was really needed was to add the hook and load this file.
676 ;; Calling (diary 0) once the hook had been added was in some sense a
677 ;; roundabout way of loading this file. This file used to have code at
678 ;; the top-level that set up the appt-timer and global-mode-string.
679 ;; One way to maintain backwards compatibility would be to call
680 ;; (appt-activate 1) at top-level. However, this goes against the
681 ;; convention that just loading an Emacs package should not activate
682 ;; it. Instead, we make appt-make-list activate the package (after a
683 ;; suggestion from rms). This means that one has to call diary in
684 ;; order to get it to work, but that is in line with the old (weird,
685 ;; IMO) documented behavior for activating the package.
686 ;; Actually, since (diary 0) does not run diary-hook, I don't think
687 ;; the documented behavior in Emacs-21.3 would ever have worked.
688 ;; Oh well, at least with the changes to appt-make-list it will now
689 ;; work as well as it ever did.
690 ;; The new method is just to use (appt-activate 1).
691 ;; -- gmorris
692
693 ;;;###autoload
694 (defun appt-activate (&optional arg)
695 "Toggle checking of appointments.
696 With optional numeric argument ARG, turn appointment checking on if
697 ARG is positive, otherwise off."
698 (interactive "P")
699 (let ((appt-active appt-timer))
700 (setq appt-active (if arg (> (prefix-numeric-value arg) 0)
701 (not appt-active)))
702 (remove-hook 'write-file-functions 'appt-update-list)
703 (or global-mode-string (setq global-mode-string '("")))
704 (delq 'appt-mode-string global-mode-string)
705 (when appt-timer
706 (cancel-timer appt-timer)
707 (setq appt-timer nil))
708 (when appt-active
709 (add-hook 'write-file-functions 'appt-update-list)
710 (setq appt-timer (run-at-time t 60 'appt-check)
711 global-mode-string
712 (append global-mode-string '(appt-mode-string)))
713 (appt-check t))))
714
715
716 (provide 'appt)
717
718 ;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
719 ;;; appt.el ends here