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