2001-07-15 16:15:35 +00:00
|
|
|
;;; appt.el --- appointment notification functions
|
1992-05-30 23:54:21 +00:00
|
|
|
|
2006-02-08 07:54:11 +00:00
|
|
|
;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
|
2010-01-13 08:35:10 +00:00
|
|
|
;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
|
1992-07-22 04:22:42 +00:00
|
|
|
|
1992-07-16 21:47:34 +00:00
|
|
|
;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
|
2005-10-08 04:49:48 +00:00
|
|
|
;; Maintainer: Glenn Morris <rgm@gnu.org>
|
1992-07-16 21:47:34 +00:00
|
|
|
;; Keywords: calendar
|
|
|
|
|
1991-01-30 21:30:11 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
2008-05-06 03:07:58 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
1991-01-30 21:30:11 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2008-05-06 03:07:58 +00:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
1991-01-30 21:30:11 +00:00
|
|
|
|
|
|
|
;; 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
|
2008-05-06 03:07:58 +00:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1992-07-16 21:47:34 +00:00
|
|
|
;;; Commentary:
|
|
|
|
|
1991-01-30 21:30:11 +00:00
|
|
|
;;
|
|
|
|
;; appt.el - visible and/or audible notification of
|
2004-01-11 22:24:57 +00:00
|
|
|
;; appointments from diary file.
|
1991-01-30 21:30:11 +00:00
|
|
|
;;
|
2008-03-26 03:42:57 +00:00
|
|
|
;;
|
|
|
|
;; 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
|
2008-08-26 03:03:21 +00:00
|
|
|
;; package is activated. Additionally, the appointments list is
|
2008-03-26 03:42:57 +00:00
|
|
|
;; recreated automatically at 12:01am for those who do not logout
|
2008-08-26 03:03:21 +00:00
|
|
|
;; every day or are programming late. It is also updated when the
|
|
|
|
;; `diary-file' is saved. Calling `appt-check' with an argument (or
|
|
|
|
;; re-enabling the package) forces a re-initialization at any time.
|
2008-03-26 03:42:57 +00:00
|
|
|
;;
|
|
|
|
;; 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
|
|
|
|
;;
|
2008-04-02 03:52:36 +00:00
|
|
|
;; appt-disp-window-function
|
2008-03-26 03:42:57 +00:00
|
|
|
;; and
|
2008-04-02 03:52:36 +00:00
|
|
|
;; appt-delete-window-function
|
2008-03-26 03:42:57 +00:00
|
|
|
;;
|
|
|
|
;; 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.
|
|
|
|
;;
|
1992-07-16 21:47:34 +00:00
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
2008-04-10 03:43:52 +00:00
|
|
|
(require 'diary-lib)
|
1994-08-09 23:26:27 +00:00
|
|
|
|
2008-03-08 03:38:14 +00:00
|
|
|
|
|
|
|
(defgroup appt nil
|
|
|
|
"Appointment notification."
|
2008-04-10 03:43:52 +00:00
|
|
|
:prefix "appt-"
|
2008-03-08 03:38:14 +00:00
|
|
|
:group 'calendar)
|
|
|
|
|
2004-01-12 00:57:00 +00:00
|
|
|
(defcustom appt-issue-message t
|
2007-11-24 21:40:02 +00:00
|
|
|
"Non-nil means check for appointments in the diary buffer.
|
2004-01-12 00:57:00 +00:00
|
|
|
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 \
|
2005-02-09 15:50:47 +00:00
|
|
|
variable `appt-display-format' instead." "22.1")
|
2004-01-12 00:57:00 +00:00
|
|
|
|
1997-05-03 04:53:02 +00:00
|
|
|
(defcustom appt-message-warning-time 12
|
2007-11-24 21:40:02 +00:00
|
|
|
"Time in minutes before an appointment that the warning begins."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'integer
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1997-05-03 04:53:02 +00:00
|
|
|
(defcustom appt-audible t
|
2007-11-24 21:40:02 +00:00
|
|
|
"Non-nil means beep to indicate appointment."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1997-05-03 04:53:02 +00:00
|
|
|
(defcustom appt-visible t
|
2007-11-24 21:40:02 +00:00
|
|
|
"Non-nil means display appointment message in echo area.
|
2004-01-11 22:24:57 +00:00
|
|
|
This variable is only relevant if `appt-msg-window' is nil."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2005-02-09 15:50:47 +00:00
|
|
|
(make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
|
2004-01-11 22:24:57 +00:00
|
|
|
|
|
|
|
(defcustom appt-msg-window t
|
2007-11-24 21:40:02 +00:00
|
|
|
"Non-nil means display appointment message in another window.
|
2004-01-11 22:24:57 +00:00
|
|
|
If non-nil, this variable overrides `appt-visible'."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2005-02-09 15:50:47 +00:00
|
|
|
(make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
|
2004-01-11 22:24:57 +00:00
|
|
|
|
|
|
|
;; TODO - add popup.
|
2004-02-19 01:12:21 +00:00
|
|
|
(defcustom appt-display-format 'ignore
|
2004-01-11 22:24:57 +00:00
|
|
|
"How appointment reminders should be displayed.
|
|
|
|
The options are:
|
|
|
|
window - use a separate window
|
|
|
|
echo - use the echo area
|
|
|
|
nil - no visible reminder.
|
2004-02-19 01:12:21 +00:00
|
|
|
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'."
|
2004-01-11 22:24:57 +00:00
|
|
|
:type '(choice
|
|
|
|
(const :tag "Separate window" window)
|
|
|
|
(const :tag "Echo-area" echo)
|
2006-06-20 19:30:36 +00:00
|
|
|
(const :tag "No visible display" nil)
|
|
|
|
(const :tag "Backwards compatibility setting - choose another value"
|
|
|
|
ignore))
|
2004-01-11 22:24:57 +00:00
|
|
|
:group 'appt
|
2005-02-09 15:50:47 +00:00
|
|
|
:version "22.1")
|
2004-01-11 22:24:57 +00:00
|
|
|
|
|
|
|
(defcustom appt-display-mode-line t
|
2007-11-24 21:40:02 +00:00
|
|
|
"Non-nil means display minutes to appointment and time on the mode line.
|
2004-01-11 22:24:57 +00:00
|
|
|
This is in addition to any other display of appointment messages."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'boolean
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1997-05-03 04:53:02 +00:00
|
|
|
(defcustom appt-display-duration 10
|
2007-11-24 21:40:02 +00:00
|
|
|
"The number of seconds an appointment message is displayed.
|
2004-01-11 22:24:57 +00:00
|
|
|
Only relevant if reminders are to be displayed in their own window."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'integer
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1997-05-03 04:53:02 +00:00
|
|
|
(defcustom appt-display-diary t
|
2007-11-24 21:40:02 +00:00
|
|
|
"Non-nil displays the diary when the appointment list is first initialized.
|
1997-05-03 04:53:02 +00:00
|
|
|
This will occur at midnight when the appointment list is updated."
|
|
|
|
:type 'boolean
|
|
|
|
:group 'appt)
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1997-05-03 04:53:02 +00:00
|
|
|
(defcustom appt-display-interval 3
|
2007-11-24 21:40:02 +00:00
|
|
|
"Number of minutes to wait between checking the appointment list."
|
1997-05-03 04:53:02 +00:00
|
|
|
:type 'integer
|
|
|
|
:group 'appt)
|
2003-02-04 13:24:35 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(defcustom appt-disp-window-function 'appt-disp-window
|
|
|
|
"Function called to display appointment window.
|
2008-04-02 03:50:34 +00:00
|
|
|
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."
|
2004-01-11 22:24:57 +00:00
|
|
|
: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.
|
|
|
|
|
2008-03-26 03:42:57 +00:00
|
|
|
(defconst appt-buffer-name "*appt-buf*"
|
1994-01-21 21:21:20 +00:00
|
|
|
"Name of the appointments buffer.")
|
2003-02-04 13:24:35 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(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'.
|
2005-02-23 21:05:51 +00:00
|
|
|
Each element of the generated list has the form (MINUTES STRING [FLAG]); where
|
2004-01-11 22:24:57 +00:00
|
|
|
MINUTES is the time in minutes of the appointment after midnight, and
|
2005-02-23 21:05:51 +00:00
|
|
|
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.")
|
2003-02-04 13:24:35 +00:00
|
|
|
|
2005-10-04 20:51:16 +00:00
|
|
|
(defconst appt-max-time (1- (* 24 60))
|
2004-01-11 22:24:57 +00:00
|
|
|
"11:59pm in minutes - number of minutes in a day minus 1.")
|
1993-11-16 03:30:08 +00:00
|
|
|
|
1998-08-26 21:14:25 +00:00
|
|
|
(defvar appt-mode-string nil
|
1998-09-21 19:45:14 +00:00
|
|
|
"String being displayed in the mode line saying you have an appointment.
|
2004-01-11 22:24:57 +00:00
|
|
|
The actual string includes the amount of time till the appointment.
|
|
|
|
Only used if `appt-display-mode-line' is non-nil.")
|
2008-03-13 03:48:35 +00:00
|
|
|
(put 'appt-mode-string 'risky-local-variable t) ; for 'face property
|
1998-09-21 19:45:14 +00:00
|
|
|
|
|
|
|
(defvar appt-prev-comp-time nil
|
2004-01-11 22:24:57 +00:00
|
|
|
"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.")
|
1998-09-21 19:45:14 +00:00
|
|
|
|
|
|
|
(defvar appt-now-displayed nil
|
|
|
|
"Non-nil when we have started notifying about a appointment that is near.")
|
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(defvar appt-display-count nil
|
|
|
|
"Internal variable used to count number of consecutive reminders.")
|
1998-08-26 21:14:25 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(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."
|
2008-07-01 03:07:26 +00:00
|
|
|
;; Let-binding for backwards compatibility. Remove when obsolete
|
2004-02-19 01:12:21 +00:00
|
|
|
;; vars appt-msg-window and appt-visible are dropped.
|
|
|
|
(let ((appt-display-format
|
|
|
|
(if (eq appt-display-format 'ignore)
|
2008-04-02 03:52:36 +00:00
|
|
|
(cond (appt-msg-window 'window)
|
|
|
|
(appt-visible 'echo))
|
2004-02-19 01:12:21 +00:00
|
|
|
appt-display-format)))
|
2008-04-02 03:50:34 +00:00
|
|
|
(if appt-audible (beep 1))
|
2004-02-19 01:12:21 +00:00
|
|
|
(cond ((eq appt-display-format 'window)
|
|
|
|
(funcall appt-disp-window-function
|
|
|
|
(number-to-string mins)
|
2008-03-08 21:18:35 +00:00
|
|
|
;; TODO - use calendar-month-abbrev-array rather than %b?
|
2004-02-19 01:12:21 +00:00
|
|
|
(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)
|
2008-04-02 03:50:34 +00:00
|
|
|
(message "%s" string)))))
|
2004-01-11 22:24:57 +00:00
|
|
|
|
|
|
|
|
2008-03-15 02:59:34 +00:00
|
|
|
(defvar diary-selective-display)
|
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(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.
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
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:
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
02/23/89
|
|
|
|
18:00 Dinner
|
2003-02-04 13:24:35 +00:00
|
|
|
|
1991-01-30 21:30:11 +00:00
|
|
|
Thursday
|
|
|
|
11:45am Lunch meeting.
|
|
|
|
|
1998-09-21 19:45:14 +00:00
|
|
|
Appointments are checked every `appt-display-interval' minutes.
|
|
|
|
The following variables control appointment notification:
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
`appt-display-format'
|
|
|
|
Controls the format in which reminders are displayed.
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1998-08-26 21:14:25 +00:00
|
|
|
`appt-audible'
|
2008-04-02 03:52:36 +00:00
|
|
|
Variable used to determine if reminder is audible.
|
|
|
|
Default is t.
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
`appt-message-warning-time'
|
2008-04-02 03:52:36 +00:00
|
|
|
Variable used to determine when appointment message
|
|
|
|
should first be displayed.
|
2004-01-11 22:24:57 +00:00
|
|
|
|
|
|
|
`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.
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
`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:
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1998-08-26 21:14:25 +00:00
|
|
|
`appt-display-duration'
|
2008-04-02 03:52:36 +00:00
|
|
|
The number of seconds an appointment message is displayed.
|
1993-11-16 03:30:08 +00:00
|
|
|
|
1998-09-21 19:45:14 +00:00
|
|
|
`appt-disp-window-function'
|
2008-04-02 03:52:36 +00:00
|
|
|
Function called to display appointment window.
|
2003-02-04 13:24:35 +00:00
|
|
|
|
1998-09-21 19:45:14 +00:00
|
|
|
`appt-delete-window-function'
|
2008-04-02 03:52:36 +00:00
|
|
|
Function called to remove appointment window and buffer."
|
2008-04-02 03:50:34 +00:00
|
|
|
(interactive "P") ; so people can force updates
|
1998-09-21 19:45:14 +00:00
|
|
|
(let* ((min-to-app -1)
|
2008-04-02 03:52:36 +00:00
|
|
|
(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))
|
2008-04-02 03:50:34 +00:00
|
|
|
now cur-comp-time appt-comp-time)
|
1998-09-21 19:45:14 +00:00
|
|
|
(when (or full-check mode-line-only)
|
|
|
|
(save-excursion
|
2008-04-02 03:52:36 +00:00
|
|
|
;; Convert current time to minutes after midnight (12.01am = 1).
|
|
|
|
(setq now (decode-time)
|
2008-04-02 03:50:34 +00:00
|
|
|
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))
|
2008-05-30 02:57:43 +00:00
|
|
|
(let* ((diary-display-function 'appt-make-list)
|
2009-09-03 06:35:25 +00:00
|
|
|
(d-buff (find-buffer-visiting diary-file))
|
2008-04-02 03:50:34 +00:00
|
|
|
(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))
|
2009-09-03 06:35:25 +00:00
|
|
|
(and (setq d-buff (find-buffer-visiting diary-file))
|
2008-04-02 03:50:34 +00:00
|
|
|
(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))
|
2010-06-15 03:38:58 +00:00
|
|
|
appt-warn-time (or (nth 3 (car appt-time-msg-list))
|
|
|
|
appt-message-warning-time)
|
2008-04-02 03:50:34 +00:00
|
|
|
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
|
2010-06-15 03:38:58 +00:00
|
|
|
;; `appt-warn-time' minutes after midnight, we
|
2008-04-02 03:50:34 +00:00
|
|
|
;; 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.
|
2010-06-15 03:38:58 +00:00
|
|
|
(if (and (< appt-comp-time appt-warn-time)
|
|
|
|
(> (+ cur-comp-time appt-warn-time)
|
2008-04-02 03:50:34 +00:00
|
|
|
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.
|
2010-06-15 03:38:58 +00:00
|
|
|
(when (and (<= min-to-app appt-warn-time)
|
2008-04-02 03:50:34 +00:00
|
|
|
(>= 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))))))))
|
1991-01-30 21:30:11 +00:00
|
|
|
|
|
|
|
(defun appt-disp-window (min-to-app new-time appt-msg)
|
2008-03-08 21:21:57 +00:00
|
|
|
"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."
|
2004-01-11 22:24:57 +00:00
|
|
|
(let ((this-window (selected-window))
|
2008-11-24 09:51:26 +00:00
|
|
|
(appt-disp-buf (get-buffer-create appt-buffer-name)))
|
|
|
|
;; 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)))
|
1994-10-09 09:19:16 +00:00
|
|
|
(if (cdr (assq 'unsplittable (frame-parameters)))
|
2008-04-02 03:52:36 +00:00
|
|
|
;; In an unsplittable frame, use something somewhere else.
|
2008-11-24 19:53:33 +00:00
|
|
|
(progn
|
|
|
|
(set-buffer appt-disp-buf)
|
|
|
|
(display-buffer appt-disp-buf))
|
1998-11-29 00:32:50 +00:00
|
|
|
(unless (or (special-display-p (buffer-name appt-disp-buf))
|
2008-04-02 03:52:36 +00:00
|
|
|
(same-window-p (buffer-name appt-disp-buf)))
|
|
|
|
;; By default, split the bottom window and use the lower part.
|
|
|
|
(appt-select-lowest-window)
|
2007-04-14 02:36:58 +00:00
|
|
|
;; Split the window, unless it's too small to do so.
|
|
|
|
(when (>= (window-height) (* 2 window-min-height))
|
|
|
|
(select-window (split-window))))
|
2004-05-13 00:18:15 +00:00
|
|
|
(switch-to-buffer appt-disp-buf))
|
2008-04-02 03:50:34 +00:00
|
|
|
;; FIXME Link to diary entry?
|
2004-05-13 00:18:15 +00:00
|
|
|
(calendar-set-mode-line
|
2008-04-02 03:50:34 +00:00
|
|
|
(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)
|
1998-08-26 21:14:25 +00:00
|
|
|
(erase-buffer)
|
2001-11-26 16:19:08 +00:00
|
|
|
(insert appt-msg)
|
1994-10-09 09:19:16 +00:00
|
|
|
(shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
|
1994-01-21 21:21:20 +00:00
|
|
|
(set-buffer-modified-p nil)
|
2008-04-02 03:50:34 +00:00
|
|
|
(setq buffer-read-only t)
|
1995-10-05 23:40:03 +00:00
|
|
|
(raise-frame (selected-frame))
|
2004-01-11 22:24:57 +00:00
|
|
|
(select-window this-window)))
|
2003-02-04 13:24:35 +00:00
|
|
|
|
1994-01-21 21:21:20 +00:00
|
|
|
(defun appt-delete-window ()
|
|
|
|
"Function called to undisplay appointment messages.
|
|
|
|
Usually just deletes the appointment buffer."
|
1994-10-16 01:42:08 +00:00
|
|
|
(let ((window (get-buffer-window appt-buffer-name t)))
|
|
|
|
(and window
|
2008-04-02 03:52:36 +00:00
|
|
|
(or (eq window (frame-root-window (window-frame window)))
|
|
|
|
(delete-window window))))
|
1994-01-21 21:21:20 +00:00
|
|
|
(kill-buffer appt-buffer-name)
|
|
|
|
(if appt-audible
|
|
|
|
(beep 1)))
|
1991-01-30 21:30:11 +00:00
|
|
|
|
|
|
|
(defun appt-select-lowest-window ()
|
2008-04-02 03:52:36 +00:00
|
|
|
"Select the lowest window on the frame."
|
2000-07-03 09:12:39 +00:00
|
|
|
(let ((lowest-window (selected-window))
|
2008-04-02 03:52:36 +00:00
|
|
|
(bottom-edge (nth 3 (window-edges)))
|
2008-04-02 03:50:34 +00:00
|
|
|
next-bottom-edge)
|
2000-07-03 09:12:39 +00:00
|
|
|
(walk-windows (lambda (w)
|
2008-04-02 03:52:36 +00:00
|
|
|
(when (< bottom-edge (setq next-bottom-edge
|
|
|
|
(nth 3 (window-edges w))))
|
|
|
|
(setq bottom-edge next-bottom-edge
|
|
|
|
lowest-window w))) 'nomini)
|
2000-07-03 09:12:39 +00:00
|
|
|
(select-window lowest-window)))
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2005-10-04 20:51:16 +00:00
|
|
|
(defconst appt-time-regexp
|
|
|
|
"[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
|
|
|
|
|
1998-09-21 19:45:14 +00:00
|
|
|
;;;###autoload
|
2010-06-15 03:38:58 +00:00
|
|
|
(defun appt-add (new-appt-time new-appt-msg new-appt-warning-time)
|
2005-03-30 15:18:09 +00:00
|
|
|
"Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
|
1991-01-30 21:30:11 +00:00
|
|
|
The time should be in either 24 hour format or am/pm format."
|
2010-06-15 03:38:58 +00:00
|
|
|
(interactive "sTime (hh:mm[am/pm]): \nsMessage:
|
|
|
|
sDelay in minutes (press return for default): ")
|
2005-10-04 20:51:16 +00:00
|
|
|
(unless (string-match appt-time-regexp new-appt-time)
|
1991-01-30 21:30:11 +00:00
|
|
|
(error "Unacceptable time-string"))
|
2010-06-15 03:38:58 +00:00
|
|
|
(setq new-appt-warning-time
|
|
|
|
(if (string= new-appt-warning-time "")
|
|
|
|
appt-message-warning-time
|
|
|
|
(string-to-number new-appt-warning-time)))
|
2006-04-15 16:35:44 +00:00
|
|
|
(let ((time-msg (list (list (appt-convert-time new-appt-time))
|
2010-06-15 03:38:58 +00:00
|
|
|
(concat new-appt-time " " new-appt-msg) t
|
|
|
|
new-appt-warning-time)))
|
2006-04-15 16:35:44 +00:00
|
|
|
(unless (member time-msg appt-time-msg-list)
|
|
|
|
(setq appt-time-msg-list
|
|
|
|
(appt-sort-list (nconc appt-time-msg-list (list time-msg)))))))
|
1991-01-30 21:30:11 +00:00
|
|
|
|
1998-09-21 19:45:14 +00:00
|
|
|
;;;###autoload
|
1991-01-30 21:30:11 +00:00
|
|
|
(defun appt-delete ()
|
|
|
|
"Delete an appointment from the list of appointments."
|
|
|
|
(interactive)
|
2004-01-11 22:24:57 +00:00
|
|
|
(let ((tmp-msg-list appt-time-msg-list))
|
2008-04-02 03:50:34 +00:00
|
|
|
(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 ""))
|
2003-02-04 13:24:35 +00:00
|
|
|
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2007-07-27 20:00:05 +00:00
|
|
|
(defvar number)
|
|
|
|
(defvar original-date)
|
|
|
|
(defvar diary-entries-list)
|
2008-04-10 03:43:52 +00:00
|
|
|
;; Autoload for the old way of using this package. Can be removed sometime.
|
1992-08-04 07:27:12 +00:00
|
|
|
;;;###autoload
|
1991-01-30 21:30:11 +00:00
|
|
|
(defun appt-make-list ()
|
2005-02-23 21:05:51 +00:00
|
|
|
"Update the appointments list from today's diary buffer.
|
2000-03-29 21:47:07 +00:00
|
|
|
The time must be at the beginning of a line for it to be
|
2004-01-11 22:24:57 +00:00
|
|
|
put in the appointments list (see examples in documentation of
|
|
|
|
the function `appt-check'). We assume that the variables DATE and
|
2006-05-13 06:10:44 +00:00
|
|
|
NUMBER hold the arguments that `diary-list-entries' received.
|
2005-02-23 21:05:51 +00:00
|
|
|
They specify the range of dates that the diary is being processed for.
|
|
|
|
|
2008-04-02 03:50:34 +00:00
|
|
|
Any appointments made with `appt-add' are not affected by this function.
|
2005-06-21 13:10:39 +00:00
|
|
|
|
|
|
|
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)
|
2008-08-26 03:03:21 +00:00
|
|
|
;; looking for entries beginning with a time. If the
|
2008-03-08 21:18:35 +00:00
|
|
|
;; entry begins with a time, add it to the
|
|
|
|
;; appt-time-msg-list. Then sort the list.
|
2005-06-21 13:10:39 +00:00
|
|
|
(let ((entry-list diary-entries-list)
|
2008-04-02 03:50:34 +00:00
|
|
|
(new-time-string "")
|
|
|
|
time-string)
|
2005-06-21 13:10:39 +00:00
|
|
|
;; 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
|
2008-03-15 02:59:34 +00:00
|
|
|
(calendar-current-date) (caar entry-list)))
|
2008-04-02 03:50:34 +00:00
|
|
|
(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
|
2009-06-22 06:29:59 +00:00
|
|
|
(substring time-string beg end))
|
2008-04-02 03:50:34 +00:00
|
|
|
(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) ""))))
|
2005-06-21 13:10:39 +00:00
|
|
|
(setq entry-list (cdr entry-list)))))
|
|
|
|
(setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
|
2008-04-02 03:50:34 +00:00
|
|
|
;; 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.
|
2005-06-21 13:10:39 +00:00
|
|
|
(let* ((now (decode-time))
|
2008-04-02 03:50:34 +00:00
|
|
|
(cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
|
2008-03-15 02:59:34 +00:00
|
|
|
(appt-comp-time (caar (car appt-time-msg-list))))
|
2005-06-21 13:10:39 +00:00
|
|
|
(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
|
2008-03-15 02:59:34 +00:00
|
|
|
(setq appt-comp-time (caar (car appt-time-msg-list))))))))))
|
2003-02-04 13:24:35 +00:00
|
|
|
|
1991-01-30 21:30:11 +00:00
|
|
|
|
|
|
|
(defun appt-sort-list (appt-list)
|
2004-01-11 22:24:57 +00:00
|
|
|
"Sort an appointment list, putting earlier items at the front.
|
|
|
|
APPT-LIST is a list of the same format as `appt-time-msg-list'."
|
2007-07-27 20:00:05 +00:00
|
|
|
(sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
|
1991-01-30 21:30:11 +00:00
|
|
|
|
|
|
|
|
|
|
|
(defun appt-convert-time (time2conv)
|
2008-03-08 21:21:57 +00:00
|
|
|
"Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
|
2004-01-11 22:24:57 +00:00
|
|
|
A period (.) can be used instead of a colon (:) to separate the
|
|
|
|
hour and minute parts."
|
2005-10-04 20:51:16 +00:00
|
|
|
;; 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)))
|
2008-03-08 21:18:35 +00:00
|
|
|
;; Convert the time appointment time into 24 hour time.
|
1999-12-02 07:55:46 +00:00
|
|
|
(cond ((and (string-match "pm" time2conv) (< hr 12))
|
2008-04-02 03:52:36 +00:00
|
|
|
(setq hr (+ 12 hr)))
|
|
|
|
((and (string-match "am" time2conv) (= hr 12))
|
1999-12-02 07:55:46 +00:00
|
|
|
(setq hr 0)))
|
2008-03-08 21:18:35 +00:00
|
|
|
;; Convert the actual time into minutes.
|
2005-10-04 20:51:16 +00:00
|
|
|
(+ (* hr 60) min)))
|
1991-01-30 21:30:11 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(defun appt-update-list ()
|
|
|
|
"If the current buffer is visiting the diary, update appointments.
|
|
|
|
This function is intended for use with `write-file-functions'."
|
2004-03-24 18:36:20 +00:00
|
|
|
(and (string-equal buffer-file-name (expand-file-name diary-file))
|
2004-01-11 22:24:57 +00:00
|
|
|
appt-timer
|
|
|
|
(let ((appt-display-diary nil))
|
|
|
|
(appt-check t)))
|
|
|
|
nil)
|
|
|
|
|
2005-06-21 13:10:39 +00:00
|
|
|
;; 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
|
2008-08-26 03:03:21 +00:00
|
|
|
;; roundabout way of loading this file. This file used to have code at
|
2005-06-21 13:10:39 +00:00
|
|
|
;; the top-level that set up the appt-timer and global-mode-string.
|
|
|
|
;; One way to maintain backwards compatibility would be to call
|
2008-08-26 03:03:21 +00:00
|
|
|
;; (appt-activate 1) at top-level. However, this goes against the
|
2005-06-21 13:10:39 +00:00
|
|
|
;; convention that just loading an Emacs package should not activate
|
2008-08-26 03:03:21 +00:00
|
|
|
;; it. Instead, we make appt-make-list activate the package (after a
|
|
|
|
;; suggestion from rms). This means that one has to call diary in
|
2005-06-21 13:10:39 +00:00
|
|
|
;; 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
|
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
;;;###autoload
|
|
|
|
(defun appt-activate (&optional arg)
|
2008-04-02 03:52:36 +00:00
|
|
|
"Toggle checking of appointments.
|
2004-01-11 22:24:57 +00:00
|
|
|
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)
|
2004-02-19 01:12:21 +00:00
|
|
|
(when appt-timer
|
|
|
|
(cancel-timer appt-timer)
|
|
|
|
(setq appt-timer nil))
|
2004-01-11 22:24:57 +00:00
|
|
|
(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))))
|
|
|
|
|
1998-08-26 21:14:25 +00:00
|
|
|
|
2004-01-11 22:24:57 +00:00
|
|
|
(provide 'appt)
|
1994-01-21 21:21:20 +00:00
|
|
|
|
2005-10-04 20:51:16 +00:00
|
|
|
;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
|
1998-08-26 21:14:25 +00:00
|
|
|
;;; appt.el ends here
|