appt.el 28 KB
Newer Older
1
;;; appt.el --- appointment notification functions
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2006, 2007, 2008  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
7
;; Maintainer: Glenn Morris <rgm@gnu.org>
Eric S. Raymond's avatar
Eric S. Raymond committed
8 9
;; Keywords: calendar

Jim Blandy's avatar
Jim Blandy committed
10 11 12 13
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; 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)
Jim Blandy's avatar
Jim Blandy committed
15 16 17 18 19 20 21 22
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
26

Eric S. Raymond's avatar
Eric S. Raymond committed
27 28
;;; Commentary:

Jim Blandy's avatar
Jim Blandy committed
29 30
;;
;; appt.el - visible and/or audible notification of
31
;;           appointments from diary file.
Jim Blandy's avatar
Jim Blandy committed
32
;;
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
;;
;; Thanks to  Edward M. Reingold for much help and many suggestions,
;; And to many others for bug fixes and suggestions.
;;
;;
;; This functions in this file will alert the user of a
;; pending appointment based on his/her diary file.  This package
;; is documented in the Emacs manual.
;;
;; To activate this package, simply use (appt-activate 1).
;; A `diary-file' with appointments of the format described in the
;; documentation of the function `appt-check' is required.
;; Relevant customizable variables are also listed in the
;; documentation of that function.
;;
;; Today's appointment list is initialized from the diary when this
;; package is activated. Additionally, the appointments list is
;; recreated automatically at 12:01am for those who do not logout
;; every day or are programming late. It is also updated when the
;; `diary-file' is saved. Calling `appt-check' with an argument forces
;; a re-initialization at any time.
;;
;; In order to add or delete items from today's list, without
;; changing the diary file, use `appt-add' and `appt-delete'.
;;

;; Brief internal description - Skip this if you are not interested!
;;
;; The function `appt-make-list' creates the appointments list which
;; `appt-check' reads.
;;
;; You can change the way the appointment window is created/deleted by
;; setting the variables
;;
Glenn Morris's avatar
Glenn Morris committed
67
;;           appt-disp-window-function
68
;; and
Glenn Morris's avatar
Glenn Morris committed
69
;;           appt-delete-window-function
70 71 72 73 74
;;
;; For instance, these variables could be set to functions that display
;; appointments in pop-up frames, which are lowered or iconified after
;; `appt-display-interval' minutes.
;;
Eric S. Raymond's avatar
Eric S. Raymond committed
75 76 77

;;; Code:

Richard M. Stallman's avatar
Richard M. Stallman committed
78 79 80
;; Make sure calendar is loaded when we compile this.
(require 'calendar)

81 82 83 84 85

(defgroup appt nil
  "Appointment notification."
  :group 'calendar)

86
(defcustom appt-issue-message t
87
  "Non-nil means check for appointments in the diary buffer.
88 89 90 91 92 93 94
To be detected, the diary entry must have the format described in the
documentation of the function `appt-check'."
  :type 'boolean
  :group 'appt)

(make-obsolete-variable 'appt-issue-message
                        "use the function `appt-activate', and the \
95
variable `appt-display-format' instead." "22.1")
96

97
(defcustom appt-message-warning-time 12
98
  "Time in minutes before an appointment that the warning begins."
99 100
  :type 'integer
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
101

102
(defcustom appt-audible t
103
  "Non-nil means beep to indicate appointment."
104 105
  :type 'boolean
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
106

107
(defcustom appt-visible t
108
  "Non-nil means display appointment message in echo area.
109
This variable is only relevant if `appt-msg-window' is nil."
110 111
  :type 'boolean
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
112

113
(make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
114 115

(defcustom appt-msg-window t
116
  "Non-nil means display appointment message in another window.
117
If non-nil, this variable overrides `appt-visible'."
118 119
  :type 'boolean
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
120

121
(make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
122 123

;; TODO - add popup.
124
(defcustom appt-display-format 'ignore
125 126 127 128 129
  "How appointment reminders should be displayed.
The options are:
   window - use a separate window
   echo   - use the echo area
   nil    - no visible reminder.
130 131 132 133
See also `appt-audible' and `appt-display-mode-line'.

The default value is 'ignore, which means to fall back on the value
of the (obsolete) variables `appt-msg-window' and `appt-visible'."
134 135 136
  :type '(choice
          (const :tag "Separate window" window)
          (const :tag "Echo-area" echo)
137 138 139
          (const :tag "No visible display" nil)
          (const :tag "Backwards compatibility setting - choose another value"
                 ignore))
140
  :group 'appt
141
  :version "22.1")
142 143

(defcustom appt-display-mode-line t
144
  "Non-nil means display minutes to appointment and time on the mode line.
145
This is in addition to any other display of appointment messages."
146 147
  :type 'boolean
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
148

149
(defcustom appt-display-duration 10
150
  "The number of seconds an appointment message is displayed.
151
Only relevant if reminders are to be displayed in their own window."
152 153
  :type 'integer
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
154

155
(defcustom appt-display-diary t
156
  "Non-nil displays the diary when the appointment list is first initialized.
157 158 159
This will occur at midnight when the appointment list is updated."
  :type 'boolean
  :group 'appt)
Jim Blandy's avatar
Jim Blandy committed
160

161
(defcustom appt-display-interval 3
162
  "Number of minutes to wait between checking the appointment list."
163 164
  :type 'integer
  :group 'appt)
165

166 167
(defcustom appt-disp-window-function 'appt-disp-window
  "Function called to display appointment window.
168 169 170
Only relevant if reminders are being displayed in a window.
It should take three string arguments: the number of minutes till
the appointment, the current time, and the text of the appointment."
171 172 173 174 175 176 177 178 179 180 181 182 183 184
  :type '(choice (const appt-disp-window)
                 function)
  :group 'appt)

(defcustom appt-delete-window-function 'appt-delete-window
  "Function called to remove appointment window and buffer.
Only relevant if reminders are being displayed in a window."
  :type '(choice (const appt-delete-window)
                 function)
  :group 'appt)


;;; Internal variables below this point.

185
(defconst appt-buffer-name "*appt-buf*"
186
  "Name of the appointments buffer.")
187

188 189 190 191 192
(defvar appt-time-msg-list nil
  "The list of appointments for today.
Use `appt-add' and `appt-delete' to add and delete appointments.
The original list is generated from today's `diary-entries-list', and
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 196 197
STRING is the description of the appointment.
FLAG, if non-nil, says that the element was made with `appt-add'
so calling `appt-make-list' again should preserve it.")
198

Stefan Monnier's avatar
Stefan Monnier committed
199
(defconst appt-max-time (1- (* 24 60))
200
  "11:59pm in minutes - number of minutes in a day minus 1.")
201

202
(defvar appt-mode-string nil
203
  "String being displayed in the mode line saying you have an appointment.
204 205
The actual string includes the amount of time till the appointment.
Only used if `appt-display-mode-line' is non-nil.")
206
(put 'appt-mode-string 'risky-local-variable t) ; for 'face property
207 208

(defvar appt-prev-comp-time nil
209 210
  "Time of day (mins since midnight) at which we last checked appointments.
A nil value forces the diary file to be (re-)checked for appointments.")
211 212 213 214

(defvar appt-now-displayed nil
  "Non-nil when we have started notifying about a appointment that is near.")

215 216
(defvar appt-display-count nil
  "Internal variable used to count number of consecutive reminders.")
217

218 219 220 221 222 223 224 225 226 227 228 229
(defvar appt-timer nil
  "Timer used for diary appointment notifications (`appt-check').
If this is non-nil, appointment checking is active.")


;;; Functions.

(defun appt-display-message (string mins)
  "Display a reminder about an appointment.
The string STRING describes the appointment, due in integer MINS minutes.
The format of the visible reminder is controlled by `appt-display-format'.
The variable `appt-audible' controls the audible reminder."
Glenn Morris's avatar
Glenn Morris committed
230
  ;; Let-binding for backwards compatability.  Remove when obsolete
231 232 233
  ;; vars appt-msg-window and appt-visible are dropped.
  (let ((appt-display-format
         (if (eq appt-display-format 'ignore)
Glenn Morris's avatar
Glenn Morris committed
234 235
             (cond (appt-msg-window 'window)
                   (appt-visible 'echo))
236
           appt-display-format)))
237
    (if appt-audible (beep 1))
238 239 240
    (cond ((eq appt-display-format 'window)
           (funcall appt-disp-window-function
                    (number-to-string mins)
Glenn Morris's avatar
Glenn Morris committed
241
                    ;; TODO - use calendar-month-abbrev-array rather than %b?
242 243 244 245 246 247
                    (format-time-string "%a %b %e " (current-time))
                    string)
           (run-at-time (format "%d sec" appt-display-duration)
                        nil
                        appt-delete-window-function))
          ((eq appt-display-format 'echo)
248
           (message "%s" string)))))
249 250


251 252
(defvar diary-selective-display)

253 254 255 256 257
(defun appt-check (&optional force)
  "Check for an appointment and update any reminder display.
If optional argument FORCE is non-nil, reparse the diary file for
appointments.  Otherwise the diary file is only parsed once per day,
and when saved.
Jim Blandy's avatar
Jim Blandy committed
258

259 260 261
Note: the time must be the first thing in the line in the diary
for a warning to be issued.  The format of the time can be either
24 hour or am/pm.  For example:
Jim Blandy's avatar
Jim Blandy committed
262

263 264
              02/23/89
                18:00 Dinner
265

Jim Blandy's avatar
Jim Blandy committed
266 267 268
              Thursday
                11:45am Lunch meeting.

269 270
Appointments are checked every `appt-display-interval' minutes.
The following variables control appointment notification:
Jim Blandy's avatar
Jim Blandy committed
271

272 273
`appt-display-format'
        Controls the format in which reminders are displayed.
Jim Blandy's avatar
Jim Blandy committed
274

275
`appt-audible'
Glenn Morris's avatar
Glenn Morris committed
276 277
        Variable used to determine if reminder is audible.
        Default is t.
Jim Blandy's avatar
Jim Blandy committed
278

279
`appt-message-warning-time'
Glenn Morris's avatar
Glenn Morris committed
280 281
        Variable used to determine when appointment message
        should first be displayed.
282 283 284 285 286 287 288

`appt-display-mode-line'
        If non-nil, a generic message giving the time remaining
        is shown in the mode-line when an appointment is due.

`appt-display-interval'
        Interval in minutes at which to check for pending appointments.
Jim Blandy's avatar
Jim Blandy committed
289

290 291 292 293 294 295
`appt-display-diary'
        Display the diary buffer when the appointment list is
        initialized for the first time in a day.

The following variables are only relevant if reminders are being
displayed in a window:
Jim Blandy's avatar
Jim Blandy committed
296

297
`appt-display-duration'
Glenn Morris's avatar
Glenn Morris committed
298
        The number of seconds an appointment message is displayed.
299

300
`appt-disp-window-function'
Glenn Morris's avatar
Glenn Morris committed
301
        Function called to display appointment window.
302

303
`appt-delete-window-function'
Glenn Morris's avatar
Glenn Morris committed
304
        Function called to remove appointment window and buffer."
305
  (interactive "P")                     ; so people can force updates
306
  (let* ((min-to-app -1)
Glenn Morris's avatar
Glenn Morris committed
307 308 309 310 311 312 313 314 315 316 317
         (prev-appt-mode-string appt-mode-string)
         (prev-appt-display-count (or appt-display-count 0))
         ;; Non-nil means do a full check for pending appointments and
         ;; display in whatever ways the user has selected.  When no
         ;; appointment is being displayed, we always do a full check.
         (full-check
          (or (not appt-now-displayed)
              ;; This is true every appt-display-interval minutes.
              (zerop (mod prev-appt-display-count appt-display-interval))))
         ;; Non-nil means only update the interval displayed in the mode line.
         (mode-line-only (unless full-check appt-now-displayed))
318
         now cur-comp-time appt-comp-time)
319 320
    (when (or full-check mode-line-only)
      (save-excursion
Glenn Morris's avatar
Glenn Morris committed
321 322
        ;; Convert current time to minutes after midnight (12.01am = 1).
        (setq now (decode-time)
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
              cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
        ;; At first check in any day, update appointments to today's list.
        (if (or force                      ; eg initialize, diary save
                (null appt-prev-comp-time) ; first check
                (< cur-comp-time appt-prev-comp-time)) ; new day
            (condition-case nil
                (if appt-display-diary
                    (let ((diary-hook
                           (if (assoc 'appt-make-list diary-hook)
                               diary-hook
                             (cons 'appt-make-list diary-hook))))
                      (diary))
                  (let* ((diary-display-hook 'appt-make-list)
                         (d-buff (find-buffer-visiting
                                  (substitute-in-file-name diary-file)))
                         (selective
                          (if d-buff    ; diary buffer exists
                              (with-current-buffer d-buff
                                diary-selective-display))))
                    (diary)
                    ;; If the diary buffer existed before this command,
                    ;; restore its display state.  Otherwise, kill it.
                    (if d-buff
                        ;; Displays the diary buffer.
                        (or selective (diary-show-all-entries))
                      (and (setq d-buff (find-buffer-visiting
                                         (substitute-in-file-name diary-file)))
                           (kill-buffer d-buff)))))
              (error nil)))
        (setq appt-prev-comp-time cur-comp-time
              appt-mode-string nil
              appt-display-count nil)
        ;; If there are entries in the list, and the user wants a
        ;; message issued, get the first time off of the list and
        ;; calculate the number of minutes until the appointment.
        (when (and appt-issue-message appt-time-msg-list)
          (setq appt-comp-time (caar (car appt-time-msg-list))
                min-to-app (- appt-comp-time cur-comp-time))
          (while (and appt-time-msg-list
                      (< appt-comp-time cur-comp-time))
            (setq appt-time-msg-list (cdr appt-time-msg-list))
            (if appt-time-msg-list
                (setq appt-comp-time (caar (car appt-time-msg-list)))))
          ;; If we have an appointment between midnight and
          ;; `appt-message-warning-time' minutes after midnight, we
          ;; must begin to issue a message before midnight.  Midnight
          ;; is considered 0 minutes and 11:59pm is 1439
          ;; minutes.  Therefore we must recalculate the minutes to
          ;; appointment variable.  It is equal to the number of
          ;; minutes before midnight plus the number of minutes after
          ;; midnight our appointment is.
          (if (and (< appt-comp-time appt-message-warning-time)
                   (> (+ cur-comp-time appt-message-warning-time)
                      appt-max-time))
              (setq min-to-app (+ (- (1+ appt-max-time) cur-comp-time)
                                  appt-comp-time)))
          ;; Issue warning if the appointment time is within
          ;; appt-message-warning time.
          (when (and (<= min-to-app appt-message-warning-time)
                     (>= min-to-app 0))
            (setq appt-now-displayed t
                  appt-display-count (1+ prev-appt-display-count))
            (unless mode-line-only
              (appt-display-message (cadr (car appt-time-msg-list))
                                    min-to-app))
            (when appt-display-mode-line
              (setq appt-mode-string
                    (concat " " (propertize
                                 (format "App't in %s min." min-to-app)
                                 'face 'mode-line-emphasis))))
            ;; When an appointment is reached, delete it from the
            ;; list.  Reset the count to 0 in case we display another
            ;; appointment on the next cycle.
            (if (zerop min-to-app)
                (setq appt-time-msg-list (cdr appt-time-msg-list)
                      appt-display-count nil))))
        ;; If we have changed the mode line string, redisplay all mode lines.
        (and appt-display-mode-line
             (not (string-equal appt-mode-string
                                prev-appt-mode-string))
             (progn
               (force-mode-line-update t)
               ;; If the string now has a notification, redisplay right now.
               (if appt-mode-string
                   (sit-for 0))))))))
Jim Blandy's avatar
Jim Blandy committed
408 409

(defun appt-disp-window (min-to-app new-time appt-msg)
410 411 412
  "Display appointment due in MIN-TO-APP (a string) minutes.
NEW-TIME is a string giving the date.  Displays the appointment
message APPT-MSG in a separate buffer."
413 414 415 416 417
  ;; Make sure we're not in the minibuffer before splitting the window.
  ;; FIXME this seems needlessly complicated?
  (when (minibufferp)
    (other-window 1)
    (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
418 419
  (let ((this-window (selected-window))
        (appt-disp-buf (set-buffer (get-buffer-create appt-buffer-name))))
420
    (if (cdr (assq 'unsplittable (frame-parameters)))
Glenn Morris's avatar
Glenn Morris committed
421 422
        ;; In an unsplittable frame, use something somewhere else.
        (display-buffer appt-disp-buf)
423
      (unless (or (special-display-p (buffer-name appt-disp-buf))
Glenn Morris's avatar
Glenn Morris committed
424 425 426
                  (same-window-p (buffer-name appt-disp-buf)))
        ;; By default, split the bottom window and use the lower part.
        (appt-select-lowest-window)
427 428 429
        ;; Split the window, unless it's too small to do so.
        (when (>= (window-height) (* 2 window-min-height))
          (select-window (split-window))))
430
      (switch-to-buffer appt-disp-buf))
431
    ;; FIXME Link to diary entry?
432
    (calendar-set-mode-line
433 434 435 436 437 438 439
     (format " Appointment %s. %s "
             (if (string-equal "0" min-to-app) "now"
               (format "in %s minute%s" min-to-app
                       (if (string-equal "1" min-to-app) "" "s")))
             new-time))
    (setq buffer-read-only nil
          buffer-undo-list t)
440
    (erase-buffer)
441
    (insert appt-msg)
442
    (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
443
    (set-buffer-modified-p nil)
444
    (setq buffer-read-only t)
445
    (raise-frame (selected-frame))
446
    (select-window this-window)))
447

448 449 450
(defun appt-delete-window ()
  "Function called to undisplay appointment messages.
Usually just deletes the appointment buffer."
451 452
  (let ((window (get-buffer-window appt-buffer-name t)))
    (and window
Glenn Morris's avatar
Glenn Morris committed
453 454
         (or (eq window (frame-root-window (window-frame window)))
             (delete-window window))))
455 456 457
  (kill-buffer appt-buffer-name)
  (if appt-audible
      (beep 1)))
Jim Blandy's avatar
Jim Blandy committed
458 459

(defun appt-select-lowest-window ()
Glenn Morris's avatar
Glenn Morris committed
460
  "Select the lowest window on the frame."
461
  (let ((lowest-window (selected-window))
Glenn Morris's avatar
Glenn Morris committed
462
        (bottom-edge (nth 3 (window-edges)))
463
        next-bottom-edge)
464
    (walk-windows (lambda (w)
Glenn Morris's avatar
Glenn Morris committed
465 466 467 468
                    (when (< bottom-edge (setq next-bottom-edge
                                               (nth 3 (window-edges w))))
                      (setq bottom-edge next-bottom-edge
                            lowest-window w))) 'nomini)
469
    (select-window lowest-window)))
Jim Blandy's avatar
Jim Blandy committed
470

Stefan Monnier's avatar
Stefan Monnier committed
471 472 473
(defconst appt-time-regexp
  "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")

474
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
475
(defun appt-add (new-appt-time new-appt-msg)
Glenn Morris's avatar
Glenn Morris committed
476
  "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
Jim Blandy's avatar
Jim Blandy committed
477 478
The time should be in either 24 hour format or am/pm format."
  (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
Stefan Monnier's avatar
Stefan Monnier committed
479
  (unless (string-match appt-time-regexp new-appt-time)
Jim Blandy's avatar
Jim Blandy committed
480
    (error "Unacceptable time-string"))
481 482 483 484 485
  (let ((time-msg (list (list (appt-convert-time new-appt-time))
                        (concat new-appt-time " " new-appt-msg) t)))
    (unless (member time-msg appt-time-msg-list)
      (setq appt-time-msg-list
            (appt-sort-list (nconc appt-time-msg-list (list time-msg)))))))
Jim Blandy's avatar
Jim Blandy committed
486

487
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
488 489 490
(defun appt-delete ()
  "Delete an appointment from the list of appointments."
  (interactive)
491
  (let ((tmp-msg-list appt-time-msg-list))
492 493 494 495 496 497 498 499 500 501
    (dolist (element tmp-msg-list)
      (if (y-or-n-p (concat "Delete "
                            ;; We want to quote any doublequotes in the
                            ;; string, as well as put doublequotes around it.
                            (prin1-to-string
                             (substring-no-properties (cadr element) 0))
                            " from list? "))
          (setq appt-time-msg-list (delq element appt-time-msg-list)))))
  (appt-check)
  (message ""))
502

Jim Blandy's avatar
Jim Blandy committed
503

504 505 506
(defvar number)
(defvar original-date)
(defvar diary-entries-list)
Jim Blandy's avatar
Jim Blandy committed
507
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
508
(defun appt-make-list ()
509
  "Update the appointments list from today's diary buffer.
Dave Love's avatar
Dave Love committed
510
The time must be at the beginning of a line for it to be
511 512
put in the appointments list (see examples in documentation of
the function `appt-check').  We assume that the variables DATE and
513
NUMBER hold the arguments that `diary-list-entries' received.
514 515
They specify the range of dates that the diary is being processed for.

516
Any appointments made with `appt-add' are not affected by this function.
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541

For backwards compatibility, this function activates the
appointment package (if it is not already active)."
  ;; See comments above appt-activate defun.
  (if (not appt-timer)
      (appt-activate 1)
    ;; We have something to do if the range of dates that the diary is
    ;; considering includes the current date.
    (if (and (not (calendar-date-compare
                   (list (calendar-current-date))
                   (list original-date)))
             (calendar-date-compare
              (list (calendar-current-date))
              (list (calendar-gregorian-from-absolute
                     (+ (calendar-absolute-from-gregorian original-date)
                        number)))))
        (save-excursion
          ;; Clear the appointments list, then fill it in from the diary.
          (dolist (elt appt-time-msg-list)
            ;; Delete any entries that were not made with appt-add.
            (unless (nth 2 elt)
              (setq appt-time-msg-list
                    (delq elt appt-time-msg-list))))
          (if diary-entries-list
              ;; Cycle through the entry-list (diary-entries-list)
Glenn Morris's avatar
Glenn Morris committed
542 543 544
              ;; looking for entries beginning with a time. If the
              ;; entry begins with a time, add it to the
              ;; appt-time-msg-list.  Then sort the list.
545
              (let ((entry-list diary-entries-list)
546 547
                    (new-time-string "")
                    time-string)
548 549 550 551 552 553 554 555
                ;; Skip diary entries for dates before today.
                (while (and entry-list
                            (calendar-date-compare
                             (car entry-list) (list (calendar-current-date))))
                  (setq entry-list (cdr entry-list)))
                ;; Parse the entries for today.
                (while (and entry-list
                            (calendar-date-equal
556
                             (calendar-current-date) (caar entry-list)))
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
                  (setq time-string (cadr (car entry-list)))
                  (while (string-match appt-time-regexp time-string)
                    (let* ((beg (match-beginning 0))
                           ;; Get just the time for this appointment.
                           (only-time (match-string 0 time-string))
                           ;; Find the end of this appointment
                           ;; (the start of the next).
                           (end (string-match
                                 (concat "\n[ \t]*" appt-time-regexp)
                                 time-string
                                 (match-end 0)))
                           ;; Get the whole string for this appointment.
                           (appt-time-string
                            (substring time-string beg (if end (1- end))))
                           (appt-time (list (appt-convert-time only-time)))
                           (time-msg (list appt-time appt-time-string)))
                      ;; Add this appointment to appt-time-msg-list.
                      (setq appt-time-msg-list
                            (nconc appt-time-msg-list (list time-msg))
                            ;; Discard this appointment from the string.
                            time-string
                            (if end (substring time-string end) ""))))
579 580
                  (setq entry-list (cdr entry-list)))))
          (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
581 582 583
          ;; Convert current time to minutes after midnight (12:01am = 1),
          ;; so that elements in the list that are earlier than the
          ;; present time can be removed.
584
          (let* ((now (decode-time))
585
                 (cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
586
                 (appt-comp-time (caar (car appt-time-msg-list))))
587 588 589
            (while (and appt-time-msg-list (< appt-comp-time cur-comp-time))
              (setq appt-time-msg-list (cdr appt-time-msg-list))
              (if appt-time-msg-list
590
                  (setq appt-comp-time (caar (car appt-time-msg-list))))))))))
591

Jim Blandy's avatar
Jim Blandy committed
592 593

(defun appt-sort-list (appt-list)
594 595
  "Sort an appointment list, putting earlier items at the front.
APPT-LIST is a list of the same format as `appt-time-msg-list'."
596
  (sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
Jim Blandy's avatar
Jim Blandy committed
597 598 599


(defun appt-convert-time (time2conv)
600
  "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
601 602
A period (.) can be used instead of a colon (:) to separate the
hour and minute parts."
Stefan Monnier's avatar
Stefan Monnier committed
603 604 605 606 607 608 609 610
  ;; Formats that should be accepted:
  ;;   10:00 10.00 10h00 10h 10am 10:00am 10.00am
  (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv)
                 (string-to-number (match-string 1 time2conv))
               0))
        (hr (if (string-match "[0-9]*[0-9]" time2conv)
                (string-to-number (match-string 0 time2conv))
              0)))
Glenn Morris's avatar
Glenn Morris committed
611
    ;; Convert the time appointment time into 24 hour time.
612
    (cond ((and (string-match "pm" time2conv) (< hr 12))
Glenn Morris's avatar
Glenn Morris committed
613 614
           (setq hr (+ 12 hr)))
          ((and (string-match "am" time2conv) (= hr 12))
615
           (setq hr 0)))
Glenn Morris's avatar
Glenn Morris committed
616
    ;; Convert the actual time into minutes.
Stefan Monnier's avatar
Stefan Monnier committed
617
    (+ (* hr 60) min)))
Jim Blandy's avatar
Jim Blandy committed
618

619 620 621
(defun appt-update-list ()
  "If the current buffer is visiting the diary, update appointments.
This function is intended for use with `write-file-functions'."
622
  (and (string-equal buffer-file-name (expand-file-name diary-file))
623 624 625 626 627
       appt-timer
       (let ((appt-display-diary nil))
         (appt-check t)))
  nil)

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
;; In Emacs-21.3, the manual documented the following procedure to
;; activate this package:
;;     (display-time)
;;     (add-hook 'diary-hook 'appt-make-list)
;;     (diary 0)
;; The display-time call was not necessary, AFAICS.
;; What was really needed was to add the hook and load this file.
;; Calling (diary 0) once the hook had been added was in some sense a
;; roundabout way of loading this file. This file used to have code at
;; the top-level that set up the appt-timer and global-mode-string.
;; One way to maintain backwards compatibility would be to call
;; (appt-activate 1) at top-level. However, this goes against the
;; convention that just loading an Emacs package should not activate
;; it. Instead, we make appt-make-list activate the package (after a
;; suggestion from rms). This means that one has to call diary in
;; order to get it to work, but that is in line with the old (weird,
;; IMO) documented behavior for activating the package.
;; Actually, since (diary 0) does not run diary-hook, I don't think
;; the documented behavior in Emacs-21.3 would ever have worked.
;; Oh well, at least with the changes to appt-make-list it will now
;; work as well as it ever did.
;; The new method is just to use (appt-activate 1).
;; -- gmorris

652 653
;;;###autoload
(defun appt-activate (&optional arg)
Glenn Morris's avatar
Glenn Morris committed
654
  "Toggle checking of appointments.
655 656 657 658 659 660 661 662 663
With optional numeric argument ARG, turn appointment checking on if
ARG is positive, otherwise off."
  (interactive "P")
  (let ((appt-active appt-timer))
    (setq appt-active (if arg (> (prefix-numeric-value arg) 0)
                        (not appt-active)))
    (remove-hook 'write-file-functions 'appt-update-list)
    (or global-mode-string (setq global-mode-string '("")))
    (delq 'appt-mode-string global-mode-string)
664 665 666
    (when appt-timer
      (cancel-timer appt-timer)
      (setq appt-timer nil))
667 668 669 670 671 672 673
    (when appt-active
      (add-hook 'write-file-functions 'appt-update-list)
      (setq appt-timer (run-at-time t 60 'appt-check)
            global-mode-string
            (append global-mode-string '(appt-mode-string)))
      (appt-check t))))

674

675
(provide 'appt)
676

Stefan Monnier's avatar
Stefan Monnier committed
677
;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
678
;;; appt.el ends here