]> code.delx.au - gnu-emacs/blobdiff - lisp/calendar/appt.el
(rmail-current-message, rmail-inbox-list): Add defvars.
[gnu-emacs] / lisp / calendar / appt.el
index d002b6fd212908bfe222a65968b631098e042ede..06b8387244948c6149f46efc13288ce646fdf180 100644 (file)
@@ -1,9 +1,9 @@
 ;;; appt.el --- appointment notification functions
 
-;; Copyright (C) 1989, 1990, 1994, 1998, 2004 Free Software Foundation, Inc.
+;; Copyright (C) 1989, 1990, 1994, 1998, 2004  Free Software Foundation, Inc.
 
 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
-;; Maintainer: FSF
+;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
 ;; Keywords: calendar
 
 ;; This file is part of GNU Emacs.
@@ -20,8 +20,8 @@
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 
@@ -88,7 +88,7 @@ documentation of the function `appt-check'."
 
 (make-obsolete-variable 'appt-issue-message
                         "use the function `appt-activate', and the \
-variable `appt-display-format' instead." "21.4")
+variable `appt-display-format' instead." "22.1")
 
 ;;;###autoload
 (defcustom appt-message-warning-time 12
@@ -109,7 +109,7 @@ This variable is only relevant if `appt-msg-window' is nil."
   :type 'boolean
   :group 'appt)
 
-(make-obsolete-variable 'appt-visible 'appt-display-format "21.4")
+(make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
 
 ;;;###autoload
 (defcustom appt-msg-window t
@@ -118,7 +118,7 @@ If non-nil, this variable overrides `appt-visible'."
   :type 'boolean
   :group 'appt)
 
-(make-obsolete-variable 'appt-msg-window 'appt-display-format "21.4")
+(make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
 
 ;; TODO - add popup.
 (defcustom appt-display-format 'ignore
@@ -136,7 +136,7 @@ of the (obsolete) variables `appt-msg-window' and `appt-visible'."
           (const :tag "Echo-area" echo)
           (const :tag "No visible display" nil))
   :group 'appt
-  :version "21.4")
+  :version "22.1")
 
 ;;;###autoload
 (defcustom appt-display-mode-line t
@@ -181,7 +181,7 @@ Only relevant if reminders are being displayed in a window."
 
 ;;; Internal variables below this point.
 
-(defvar appt-buffer-name " *appt-buf*"
+(defconst appt-buffer-name " *appt-buf*"
   "Name of the appointments buffer.")
 
 (defvar appt-time-msg-list nil
@@ -189,9 +189,11 @@ Only relevant if reminders are being displayed in a window."
 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'.
-Each element of the generated list has the form (MINUTES) STRING; where
+Each element of the generated list has the form (MINUTES STRING [FLAG]); where
 MINUTES is the time in minutes of the appointment after midnight, and
-STRING is the description of the appointment.")
+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.")
 
 (defconst appt-max-time 1439
   "11:59pm in minutes - number of minutes in a day minus 1.")
@@ -325,19 +327,33 @@ displayed in a window:
          ;; At the first check in any given day, update our
          ;; appointments to today's list.
 
-         (if (or force
+         (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
-                 (progn
-                   (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))
-                       (diary))))
+                  (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
+                            (setq selective 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 (show-all-diary-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
@@ -435,11 +451,10 @@ NEW-TIME is a string giving the date."
                  (same-window-p (buffer-name appt-disp-buf)))
        ;; By default, split the bottom window and use the lower part.
        (appt-select-lowest-window)
-       (split-window))
-      (pop-to-buffer appt-disp-buf))
-    (setq mode-line-format
-         (concat "-------------------- Appointment in "
-                 min-to-app " minutes. " new-time " %-"))
+        (select-window (split-window)))
+      (switch-to-buffer appt-disp-buf))
+    (calendar-set-mode-line
+     (format " Appointment in %s minutes. %s " min-to-app new-time))
     (erase-buffer)
     (insert appt-msg)
     (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
@@ -471,16 +486,15 @@ Usually just deletes the appointment buffer."
 
 ;;;###autoload
 (defun appt-add (new-appt-time new-appt-msg)
-  "Add an appointment for the day at NEW-APPT-TIME and issue message NEW-APPT-MSG.
+  "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
 The time should be in either 24 hour format or am/pm format."
-
   (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
   (unless (string-match "[0-9]?[0-9][:.][0-9][0-9]\\(am\\|pm\\)?"
                    new-appt-time)
     (error "Unacceptable time-string"))
   (let* ((appt-time-string (concat new-appt-time " " new-appt-msg))
          (appt-time (list (appt-convert-time new-appt-time)))
-         (time-msg (cons appt-time (list appt-time-string))))
+         (time-msg (list appt-time appt-time-string t)))
     (setq appt-time-msg-list (nconc appt-time-msg-list (list time-msg)))
     (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))))
 
@@ -512,89 +526,101 @@ The time should be in either 24 hour format or am/pm format."
                   (defvar diary-entries-list))
 ;;;###autoload
 (defun appt-make-list ()
-  "Create the appointments list from today's diary buffer.
+  "Update the appointments list from today's diary buffer.
 The time must be at the beginning of a line for it to be
 put in the appointments list (see examples in documentation of
 the function `appt-check').  We assume that the variables DATE and
 NUMBER hold the arguments that `list-diary-entries' received.
-They specify the range of dates that the diary is being processed for."
-
-  ;; 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.
-       (setq appt-time-msg-list nil)
-       (if diary-entries-list
-
-           ;; Cycle through the entry-list (diary-entries-list)
-           ;; 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.
-
-           (let ((entry-list diary-entries-list)
-                 (new-time-string ""))
-             ;; 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
-                          (calendar-current-date) (car (car entry-list))))
-               (let ((time-string (cadr (car entry-list))))
-                 (while (string-match
-                         "\\([0-9]?[0-9][:.][0-9][0-9]\\(am\\|pm\\)?\\).*"
-                         time-string)
-                   (let* ((beg (match-beginning 0))
-                          ;; Get just the time for this appointment.
-                          (only-time (match-string 1 time-string))
-                          ;; Find the end of this appointment
-                          ;; (the start of the next).
-                          (end (string-match
-                                "^[ \t]*[0-9]?[0-9][:.][0-9][0-9]\\(am\\|pm\\)?"
-                                time-string
-                                (match-end 0)))
-                          ;; Get the whole string for this appointment.
-                          (appt-time-string
-                           (substring time-string beg (if end (1- end)))))
-
-                     ;; Add this appointment to appt-time-msg-list.
-                     (let* ((appt-time (list (appt-convert-time only-time)))
-                            (time-msg (list appt-time appt-time-string)))
-                       (setq appt-time-msg-list
-                             (nconc appt-time-msg-list (list time-msg))))
-
-                     ;; Discard this appointment from the string.
-                     (setq time-string
-                           (if end (substring time-string end) "")))))
-               (setq entry-list (cdr entry-list)))))
-       (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
-
-       ;; Get the current time and convert it to minutes
-       ;; from midnight. ie. 12:01am = 1, midnight = 0,
-       ;; so that the elements in the list
-       ;; that are earlier than the present time can
-       ;; be removed.
-
-       (let* ((now (decode-time))
-              (cur-hour (nth 2 now))
-              (cur-min (nth 1 now))
-              (cur-comp-time (+ (* cur-hour 60) cur-min))
-              (appt-comp-time (car (caar appt-time-msg-list))))
-
-         (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 (car (caar appt-time-msg-list)))))))))
+They specify the range of dates that the diary is being processed for.
+
+Any appointments made with `appt-add' are not affected by this
+function.
+
+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)
+              ;; 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.
+
+              (let ((entry-list diary-entries-list)
+                    (new-time-string ""))
+                ;; 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
+                             (calendar-current-date) (car (car entry-list))))
+                  (let ((time-string (cadr (car entry-list))))
+                    (while (string-match
+                            "\\([0-9]?[0-9][:.][0-9][0-9]\\(am\\|pm\\)?\\).*"
+                            time-string)
+                      (let* ((beg (match-beginning 0))
+                             ;; Get just the time for this appointment.
+                             (only-time (match-string 1 time-string))
+                             ;; Find the end of this appointment
+                             ;; (the start of the next).
+                             (end (string-match
+                                   "^[ \t]*[0-9]?[0-9][:.][0-9][0-9]\\(am\\|pm\\)?"
+                                   time-string
+                                   (match-end 0)))
+                             ;; Get the whole string for this appointment.
+                             (appt-time-string
+                              (substring time-string beg (if end (1- end)))))
+
+                        ;; Add this appointment to appt-time-msg-list.
+                        (let* ((appt-time (list (appt-convert-time only-time)))
+                               (time-msg (list appt-time appt-time-string)))
+                          (setq appt-time-msg-list
+                                (nconc appt-time-msg-list (list time-msg))))
+
+                        ;; Discard this appointment from the string.
+                        (setq time-string
+                              (if end (substring time-string end) "")))))
+                  (setq entry-list (cdr entry-list)))))
+          (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
+
+          ;; Get the current time and convert it to minutes
+          ;; from midnight. ie. 12:01am = 1, midnight = 0,
+          ;; so that the elements in the list
+          ;; that are earlier than the present time can
+          ;; be removed.
+
+          (let* ((now (decode-time))
+                 (cur-hour (nth 2 now))
+                 (cur-min (nth 1 now))
+                 (cur-comp-time (+ (* cur-hour 60) cur-min))
+                 (appt-comp-time (car (caar appt-time-msg-list))))
+
+            (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 (car (caar appt-time-msg-list))))))))))
 
 
 (defun appt-sort-list (appt-list)
@@ -612,11 +638,11 @@ hour and minute parts."
         (min 0))
 
     (string-match "[:.]\\([0-9][0-9]\\)" time2conv)
-    (setq min (string-to-int
+    (setq min (string-to-number
                (match-string 1 time2conv)))
 
     (string-match "[0-9]?[0-9][:.]" time2conv)
-    (setq hr (string-to-int
+    (setq hr (string-to-number
               (match-string 0 time2conv)))
 
     ;; convert the time appointment time into 24 hour time
@@ -637,13 +663,37 @@ hour and minute parts."
 (defun appt-update-list ()
   "If the current buffer is visiting the diary, update appointments.
 This function is intended for use with `write-file-functions'."
-  (and (equal buffer-file-name (expand-file-name diary-file))
+  (and (string-equal buffer-file-name (expand-file-name diary-file))
        appt-timer
        (let ((appt-display-diary nil))
          (appt-check t)))
   nil)
 
 
+;; 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
+
 ;;;###autoload
 (defun appt-activate (&optional arg)
 "Toggle checking of appointments.
@@ -667,10 +717,6 @@ ARG is positive, otherwise off."
       (appt-check t))))
 
 
-;; This is needed for backwards compatibility. Feh.
-(appt-activate 1)
-
-
 (provide 'appt)
 
 ;;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347