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