Remove leading "*" from defcustom docs.
[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,
ae940284 4;; 2006, 2007, 2008, 2009 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
2ed66575 12;; GNU Emacs is free software: you can redistribute it and/or modify
902a0e3c 13;; it under the terms of the GNU General Public License as published by
2ed66575
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
902a0e3c
JB
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
2ed66575 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
902a0e3c 24
e5167999
ER
25;;; Commentary:
26
902a0e3c
JB
27;;
28;; appt.el - visible and/or audible notification of
8d638c1b 29;; appointments from diary file.
902a0e3c 30;;
e1422141
SM
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
12b2a018 47;; package is activated. Additionally, the appointments list is
e1422141 48;; recreated automatically at 12:01am for those who do not logout
12b2a018
GM
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.
e1422141
SM
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;;
debf91fd 65;; appt-disp-window-function
e1422141 66;; and
debf91fd 67;; appt-delete-window-function
e1422141
SM
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;;
e5167999
ER
73
74;;; Code:
75
467f174b 76(require 'diary-lib)
6afadb57 77
d589fa52
GM
78
79(defgroup appt nil
80 "Appointment notification."
467f174b 81 :prefix "appt-"
d589fa52
GM
82 :group 'calendar)
83
30e8032d 84(defcustom appt-issue-message t
40f79f5b 85 "Non-nil means check for appointments in the diary buffer.
30e8032d
GM
86To be detected, the diary entry must have the format described in the
87documentation 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 \
bf247b6e 93variable `appt-display-format' instead." "22.1")
30e8032d 94
8db540c5 95(defcustom appt-message-warning-time 12
40f79f5b 96 "Time in minutes before an appointment that the warning begins."
8db540c5
RS
97 :type 'integer
98 :group 'appt)
902a0e3c 99
8db540c5 100(defcustom appt-audible t
40f79f5b 101 "Non-nil means beep to indicate appointment."
8db540c5
RS
102 :type 'boolean
103 :group 'appt)
902a0e3c 104
8db540c5 105(defcustom appt-visible t
40f79f5b 106 "Non-nil means display appointment message in echo area.
8d638c1b 107This variable is only relevant if `appt-msg-window' is nil."
8db540c5
RS
108 :type 'boolean
109 :group 'appt)
902a0e3c 110
bf247b6e 111(make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
8d638c1b 112
8d638c1b 113(defcustom appt-msg-window t
40f79f5b 114 "Non-nil means display appointment message in another window.
8d638c1b 115If non-nil, this variable overrides `appt-visible'."
8db540c5
RS
116 :type 'boolean
117 :group 'appt)
902a0e3c 118
bf247b6e 119(make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
8d638c1b
GM
120
121;; TODO - add popup.
a19de628 122(defcustom appt-display-format 'ignore
8d638c1b
GM
123 "How appointment reminders should be displayed.
124The options are:
125 window - use a separate window
126 echo - use the echo area
127 nil - no visible reminder.
a19de628
GM
128See also `appt-audible' and `appt-display-mode-line'.
129
130The default value is 'ignore, which means to fall back on the value
131of the (obsolete) variables `appt-msg-window' and `appt-visible'."
8d638c1b
GM
132 :type '(choice
133 (const :tag "Separate window" window)
134 (const :tag "Echo-area" echo)
3c6b81d8
GM
135 (const :tag "No visible display" nil)
136 (const :tag "Backwards compatibility setting - choose another value"
137 ignore))
8d638c1b 138 :group 'appt
bf247b6e 139 :version "22.1")
8d638c1b 140
8d638c1b 141(defcustom appt-display-mode-line t
40f79f5b 142 "Non-nil means display minutes to appointment and time on the mode line.
8d638c1b 143This is in addition to any other display of appointment messages."
8db540c5
RS
144 :type 'boolean
145 :group 'appt)
902a0e3c 146
8db540c5 147(defcustom appt-display-duration 10
40f79f5b 148 "The number of seconds an appointment message is displayed.
8d638c1b 149Only relevant if reminders are to be displayed in their own window."
8db540c5
RS
150 :type 'integer
151 :group 'appt)
902a0e3c 152
8db540c5 153(defcustom appt-display-diary t
40f79f5b 154 "Non-nil displays the diary when the appointment list is first initialized.
8db540c5
RS
155This will occur at midnight when the appointment list is updated."
156 :type 'boolean
157 :group 'appt)
902a0e3c 158
8db540c5 159(defcustom appt-display-interval 3
40f79f5b 160 "Number of minutes to wait between checking the appointment list."
8db540c5
RS
161 :type 'integer
162 :group 'appt)
a1506d29 163
8d638c1b
GM
164(defcustom appt-disp-window-function 'appt-disp-window
165 "Function called to display appointment window.
ce5b3019
GM
166Only relevant if reminders are being displayed in a window.
167It should take three string arguments: the number of minutes till
168the appointment, the current time, and the text of the appointment."
8d638c1b
GM
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.
175Only 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
e1422141 183(defconst appt-buffer-name "*appt-buf*"
5b586155 184 "Name of the appointments buffer.")
a1506d29 185
8d638c1b
GM
186(defvar appt-time-msg-list nil
187 "The list of appointments for today.
188Use `appt-add' and `appt-delete' to add and delete appointments.
189The original list is generated from today's `diary-entries-list', and
190can be regenerated using the function `appt-check'.
5fac723a 191Each element of the generated list has the form (MINUTES STRING [FLAG]); where
8d638c1b 192MINUTES is the time in minutes of the appointment after midnight, and
5fac723a
RS
193STRING is the description of the appointment.
194FLAG, if non-nil, says that the element was made with `appt-add'
195so calling `appt-make-list' again should preserve it.")
a1506d29 196
0cb7f2c0 197(defconst appt-max-time (1- (* 24 60))
8d638c1b 198 "11:59pm in minutes - number of minutes in a day minus 1.")
b570e652 199
efa434d9 200(defvar appt-mode-string nil
f3e7c0dc 201 "String being displayed in the mode line saying you have an appointment.
8d638c1b
GM
202The actual string includes the amount of time till the appointment.
203Only used if `appt-display-mode-line' is non-nil.")
464e8258 204(put 'appt-mode-string 'risky-local-variable t) ; for 'face property
f3e7c0dc
KH
205
206(defvar appt-prev-comp-time nil
8d638c1b
GM
207 "Time of day (mins since midnight) at which we last checked appointments.
208A nil value forces the diary file to be (re-)checked for appointments.")
f3e7c0dc
KH
209
210(defvar appt-now-displayed nil
211 "Non-nil when we have started notifying about a appointment that is near.")
212
8d638c1b
GM
213(defvar appt-display-count nil
214 "Internal variable used to count number of consecutive reminders.")
efa434d9 215
8d638c1b
GM
216(defvar appt-timer nil
217 "Timer used for diary appointment notifications (`appt-check').
218If 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.
225The string STRING describes the appointment, due in integer MINS minutes.
226The format of the visible reminder is controlled by `appt-display-format'.
227The variable `appt-audible' controls the audible reminder."
aadbdbe2 228 ;; Let-binding for backwards compatibility. Remove when obsolete
a19de628
GM
229 ;; vars appt-msg-window and appt-visible are dropped.
230 (let ((appt-display-format
231 (if (eq appt-display-format 'ignore)
debf91fd
GM
232 (cond (appt-msg-window 'window)
233 (appt-visible 'echo))
a19de628 234 appt-display-format)))
ce5b3019 235 (if appt-audible (beep 1))
a19de628
GM
236 (cond ((eq appt-display-format 'window)
237 (funcall appt-disp-window-function
238 (number-to-string mins)
cb17eeae 239 ;; TODO - use calendar-month-abbrev-array rather than %b?
a19de628
GM
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)
ce5b3019 246 (message "%s" string)))))
8d638c1b
GM
247
248
35471668
GM
249(defvar diary-selective-display)
250
8d638c1b
GM
251(defun appt-check (&optional force)
252 "Check for an appointment and update any reminder display.
253If optional argument FORCE is non-nil, reparse the diary file for
254appointments. Otherwise the diary file is only parsed once per day,
255and when saved.
902a0e3c 256
8d638c1b
GM
257Note: the time must be the first thing in the line in the diary
258for a warning to be issued. The format of the time can be either
25924 hour or am/pm. For example:
902a0e3c 260
8d638c1b
GM
261 02/23/89
262 18:00 Dinner
a1506d29 263
902a0e3c
JB
264 Thursday
265 11:45am Lunch meeting.
266
f3e7c0dc
KH
267Appointments are checked every `appt-display-interval' minutes.
268The following variables control appointment notification:
902a0e3c 269
8d638c1b
GM
270`appt-display-format'
271 Controls the format in which reminders are displayed.
902a0e3c 272
efa434d9 273`appt-audible'
debf91fd
GM
274 Variable used to determine if reminder is audible.
275 Default is t.
902a0e3c 276
8d638c1b 277`appt-message-warning-time'
debf91fd
GM
278 Variable used to determine when appointment message
279 should first be displayed.
8d638c1b
GM
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.
902a0e3c 287
8d638c1b
GM
288`appt-display-diary'
289 Display the diary buffer when the appointment list is
290 initialized for the first time in a day.
291
292The following variables are only relevant if reminders are being
293displayed in a window:
902a0e3c 294
efa434d9 295`appt-display-duration'
debf91fd 296 The number of seconds an appointment message is displayed.
b570e652 297
f3e7c0dc 298`appt-disp-window-function'
debf91fd 299 Function called to display appointment window.
a1506d29 300
f3e7c0dc 301`appt-delete-window-function'
debf91fd 302 Function called to remove appointment window and buffer."
ce5b3019 303 (interactive "P") ; so people can force updates
f3e7c0dc 304 (let* ((min-to-app -1)
debf91fd
GM
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))
ce5b3019 316 now cur-comp-time appt-comp-time)
f3e7c0dc
KH
317 (when (or full-check mode-line-only)
318 (save-excursion
debf91fd
GM
319 ;; Convert current time to minutes after midnight (12.01am = 1).
320 (setq now (decode-time)
ce5b3019
GM
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))
0f9aa26a 333 (let* ((diary-display-function 'appt-make-list)
ce5b3019
GM
334 (d-buff (find-buffer-visiting
335 (substitute-in-file-name diary-file)))
336 (selective
337 (if d-buff ; diary buffer exists
338 (with-current-buffer d-buff
339 diary-selective-display))))
340 (diary)
341 ;; If the diary buffer existed before this command,
342 ;; restore its display state. Otherwise, kill it.
343 (if d-buff
344 ;; Displays the diary buffer.
345 (or selective (diary-show-all-entries))
346 (and (setq d-buff (find-buffer-visiting
347 (substitute-in-file-name diary-file)))
348 (kill-buffer d-buff)))))
349 (error nil)))
350 (setq appt-prev-comp-time cur-comp-time
351 appt-mode-string nil
352 appt-display-count nil)
353 ;; If there are entries in the list, and the user wants a
354 ;; message issued, get the first time off of the list and
355 ;; calculate the number of minutes until the appointment.
356 (when (and appt-issue-message appt-time-msg-list)
357 (setq appt-comp-time (caar (car appt-time-msg-list))
358 min-to-app (- appt-comp-time cur-comp-time))
359 (while (and appt-time-msg-list
360 (< appt-comp-time cur-comp-time))
361 (setq appt-time-msg-list (cdr appt-time-msg-list))
362 (if appt-time-msg-list
363 (setq appt-comp-time (caar (car appt-time-msg-list)))))
364 ;; If we have an appointment between midnight and
365 ;; `appt-message-warning-time' minutes after midnight, we
366 ;; must begin to issue a message before midnight. Midnight
367 ;; is considered 0 minutes and 11:59pm is 1439
368 ;; minutes. Therefore we must recalculate the minutes to
369 ;; appointment variable. It is equal to the number of
370 ;; minutes before midnight plus the number of minutes after
371 ;; midnight our appointment is.
372 (if (and (< appt-comp-time appt-message-warning-time)
373 (> (+ cur-comp-time appt-message-warning-time)
374 appt-max-time))
375 (setq min-to-app (+ (- (1+ appt-max-time) cur-comp-time)
376 appt-comp-time)))
377 ;; Issue warning if the appointment time is within
378 ;; appt-message-warning time.
379 (when (and (<= min-to-app appt-message-warning-time)
380 (>= min-to-app 0))
381 (setq appt-now-displayed t
382 appt-display-count (1+ prev-appt-display-count))
383 (unless mode-line-only
384 (appt-display-message (cadr (car appt-time-msg-list))
385 min-to-app))
386 (when appt-display-mode-line
387 (setq appt-mode-string
388 (concat " " (propertize
389 (format "App't in %s min." min-to-app)
390 'face 'mode-line-emphasis))))
391 ;; When an appointment is reached, delete it from the
392 ;; list. Reset the count to 0 in case we display another
393 ;; appointment on the next cycle.
394 (if (zerop min-to-app)
395 (setq appt-time-msg-list (cdr appt-time-msg-list)
396 appt-display-count nil))))
397 ;; If we have changed the mode line string, redisplay all mode lines.
398 (and appt-display-mode-line
399 (not (string-equal appt-mode-string
400 prev-appt-mode-string))
401 (progn
402 (force-mode-line-update t)
403 ;; If the string now has a notification, redisplay right now.
404 (if appt-mode-string
405 (sit-for 0))))))))
902a0e3c 406
902a0e3c 407(defun appt-disp-window (min-to-app new-time appt-msg)
754c5007
GM
408 "Display appointment due in MIN-TO-APP (a string) minutes.
409NEW-TIME is a string giving the date. Displays the appointment
410message APPT-MSG in a separate buffer."
8d638c1b 411 (let ((this-window (selected-window))
bc5777c1
MR
412 (appt-disp-buf (get-buffer-create appt-buffer-name)))
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)))
d5b22d88 418 (if (cdr (assq 'unsplittable (frame-parameters)))
debf91fd 419 ;; In an unsplittable frame, use something somewhere else.
0836e2c3
MR
420 (progn
421 (set-buffer appt-disp-buf)
422 (display-buffer appt-disp-buf))
058961dd 423 (unless (or (special-display-p (buffer-name appt-disp-buf))
debf91fd
GM
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
debf91fd
GM
453 (or (eq window (frame-root-window (window-frame window)))
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 ()
debf91fd 460 "Select the lowest window on the frame."
7c0d9b89 461 (let ((lowest-window (selected-window))
debf91fd 462 (bottom-edge (nth 3 (window-edges)))
ce5b3019 463 next-bottom-edge)
7c0d9b89 464 (walk-windows (lambda (w)
debf91fd
GM
465 (when (< bottom-edge (setq next-bottom-edge
466 (nth 3 (window-edges w))))
467 (setq bottom-edge next-bottom-edge
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)
467f174b 507;; Autoload for the old way of using this package. Can be removed sometime.
637a8ae9 508;;;###autoload
902a0e3c 509(defun appt-make-list ()
5fac723a 510 "Update the appointments list from today's diary buffer.
d073fa5b 511The time must be at the beginning of a line for it to be
8d638c1b
GM
512put in the appointments list (see examples in documentation of
513the function `appt-check'). We assume that the variables DATE and
59b79385 514NUMBER hold the arguments that `diary-list-entries' received.
5fac723a
RS
515They specify the range of dates that the diary is being processed for.
516
ce5b3019 517Any appointments made with `appt-add' are not affected by this function.
871ce753
GM
518
519For backwards compatibility, this function activates the
520appointment package (if it is not already active)."
521 ;; See comments above appt-activate defun.
522 (if (not appt-timer)
523 (appt-activate 1)
524 ;; We have something to do if the range of dates that the diary is
525 ;; considering includes the current date.
526 (if (and (not (calendar-date-compare
527 (list (calendar-current-date))
528 (list original-date)))
529 (calendar-date-compare
530 (list (calendar-current-date))
531 (list (calendar-gregorian-from-absolute
532 (+ (calendar-absolute-from-gregorian original-date)
533 number)))))
534 (save-excursion
535 ;; Clear the appointments list, then fill it in from the diary.
536 (dolist (elt appt-time-msg-list)
537 ;; Delete any entries that were not made with appt-add.
538 (unless (nth 2 elt)
539 (setq appt-time-msg-list
540 (delq elt appt-time-msg-list))))
541 (if diary-entries-list
871ce753 542 ;; Cycle through the entry-list (diary-entries-list)
12b2a018 543 ;; looking for entries beginning with a time. If the
cb17eeae
GM
544 ;; entry begins with a time, add it to the
545 ;; appt-time-msg-list. Then sort the list.
871ce753 546 (let ((entry-list diary-entries-list)
ce5b3019
GM
547 (new-time-string "")
548 time-string)
871ce753
GM
549 ;; Skip diary entries for dates before today.
550 (while (and entry-list
551 (calendar-date-compare
552 (car entry-list) (list (calendar-current-date))))
553 (setq entry-list (cdr entry-list)))
554 ;; Parse the entries for today.
555 (while (and entry-list
556 (calendar-date-equal
35471668 557 (calendar-current-date) (caar entry-list)))
ce5b3019
GM
558 (setq time-string (cadr (car entry-list)))
559 (while (string-match appt-time-regexp time-string)
560 (let* ((beg (match-beginning 0))
561 ;; Get just the time for this appointment.
562 (only-time (match-string 0 time-string))
563 ;; Find the end of this appointment
564 ;; (the start of the next).
565 (end (string-match
566 (concat "\n[ \t]*" appt-time-regexp)
567 time-string
568 (match-end 0)))
569 ;; Get the whole string for this appointment.
570 (appt-time-string
571 (substring time-string beg (if end (1- end))))
572 (appt-time (list (appt-convert-time only-time)))
573 (time-msg (list appt-time appt-time-string)))
574 ;; Add this appointment to appt-time-msg-list.
575 (setq appt-time-msg-list
576 (nconc appt-time-msg-list (list time-msg))
577 ;; Discard this appointment from the string.
578 time-string
579 (if end (substring time-string end) ""))))
871ce753
GM
580 (setq entry-list (cdr entry-list)))))
581 (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
ce5b3019
GM
582 ;; Convert current time to minutes after midnight (12:01am = 1),
583 ;; so that elements in the list that are earlier than the
584 ;; present time can be removed.
871ce753 585 (let* ((now (decode-time))
ce5b3019 586 (cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
35471668 587 (appt-comp-time (caar (car appt-time-msg-list))))
871ce753
GM
588 (while (and appt-time-msg-list (< appt-comp-time cur-comp-time))
589 (setq appt-time-msg-list (cdr appt-time-msg-list))
590 (if appt-time-msg-list
35471668 591 (setq appt-comp-time (caar (car appt-time-msg-list))))))))))
a1506d29 592
902a0e3c 593
902a0e3c 594(defun appt-sort-list (appt-list)
8d638c1b
GM
595 "Sort an appointment list, putting earlier items at the front.
596APPT-LIST is a list of the same format as `appt-time-msg-list'."
11361a8b 597 (sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
902a0e3c
JB
598
599
600(defun appt-convert-time (time2conv)
754c5007 601 "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
8d638c1b
GM
602A period (.) can be used instead of a colon (:) to separate the
603hour and minute parts."
0cb7f2c0
SM
604 ;; Formats that should be accepted:
605 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
606 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv)
607 (string-to-number (match-string 1 time2conv))
608 0))
609 (hr (if (string-match "[0-9]*[0-9]" time2conv)
610 (string-to-number (match-string 0 time2conv))
611 0)))
cb17eeae 612 ;; Convert the time appointment time into 24 hour time.
85bbde63 613 (cond ((and (string-match "pm" time2conv) (< hr 12))
debf91fd
GM
614 (setq hr (+ 12 hr)))
615 ((and (string-match "am" time2conv) (= hr 12))
85bbde63 616 (setq hr 0)))
cb17eeae 617 ;; Convert the actual time into minutes.
0cb7f2c0 618 (+ (* hr 60) min)))
902a0e3c 619
8d638c1b
GM
620(defun appt-update-list ()
621 "If the current buffer is visiting the diary, update appointments.
622This function is intended for use with `write-file-functions'."
359bff67 623 (and (string-equal buffer-file-name (expand-file-name diary-file))
8d638c1b
GM
624 appt-timer
625 (let ((appt-display-diary nil))
626 (appt-check t)))
627 nil)
628
871ce753
GM
629;; In Emacs-21.3, the manual documented the following procedure to
630;; activate this package:
631;; (display-time)
632;; (add-hook 'diary-hook 'appt-make-list)
633;; (diary 0)
634;; The display-time call was not necessary, AFAICS.
635;; What was really needed was to add the hook and load this file.
636;; Calling (diary 0) once the hook had been added was in some sense a
12b2a018 637;; roundabout way of loading this file. This file used to have code at
871ce753
GM
638;; the top-level that set up the appt-timer and global-mode-string.
639;; One way to maintain backwards compatibility would be to call
12b2a018 640;; (appt-activate 1) at top-level. However, this goes against the
871ce753 641;; convention that just loading an Emacs package should not activate
12b2a018
GM
642;; it. Instead, we make appt-make-list activate the package (after a
643;; suggestion from rms). This means that one has to call diary in
871ce753
GM
644;; order to get it to work, but that is in line with the old (weird,
645;; IMO) documented behavior for activating the package.
646;; Actually, since (diary 0) does not run diary-hook, I don't think
647;; the documented behavior in Emacs-21.3 would ever have worked.
648;; Oh well, at least with the changes to appt-make-list it will now
649;; work as well as it ever did.
650;; The new method is just to use (appt-activate 1).
651;; -- gmorris
652
8d638c1b
GM
653;;;###autoload
654(defun appt-activate (&optional arg)
debf91fd 655 "Toggle checking of appointments.
8d638c1b
GM
656With optional numeric argument ARG, turn appointment checking on if
657ARG is positive, otherwise off."
658 (interactive "P")
659 (let ((appt-active appt-timer))
660 (setq appt-active (if arg (> (prefix-numeric-value arg) 0)
661 (not appt-active)))
662 (remove-hook 'write-file-functions 'appt-update-list)
663 (or global-mode-string (setq global-mode-string '("")))
664 (delq 'appt-mode-string global-mode-string)
a19de628
GM
665 (when appt-timer
666 (cancel-timer appt-timer)
667 (setq appt-timer nil))
8d638c1b
GM
668 (when appt-active
669 (add-hook 'write-file-functions 'appt-update-list)
670 (setq appt-timer (run-at-time t 60 'appt-check)
671 global-mode-string
672 (append global-mode-string '(appt-mode-string)))
673 (appt-check t))))
674
efa434d9 675
8d638c1b 676(provide 'appt)
5b586155 677
0cb7f2c0 678;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
efa434d9 679;;; appt.el ends here