| blob | c3f4d77fcaef925531becc83b5c4b3efe87cd484 |
1 ;;; appt.el --- appointment notification functions
3 ;; Copyright (C) 1989, 1990, 1994, 1998 Free Software Foundation, Inc.
5 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: calendar
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;;
29 ;; appt.el - visible and/or audible notification of
30 ;; appointments from ~/diary file.
31 ;;
32 ;;;
33 ;;; Thanks to Edward M. Reingold for much help and many suggestions,
34 ;;; And to many others for bug fixes and suggestions.
35 ;;;
36 ;;;
37 ;;; This functions in this file will alert the user of a
38 ;;; pending appointment based on their diary file.
39 ;;;
40 ;;; A message will be displayed in the mode line of the Emacs buffer
41 ;;; and (if you request) the terminal will beep and display a message
42 ;;; from the diary in the mini-buffer, or you can choose to
43 ;;; have a message displayed in a new buffer.
44 ;;;
45 ;;; The variable `appt-message-warning-time' allows the
46 ;;; user to specify how much notice they want before the appointment. The
47 ;;; variable `appt-issue-message' specifies whether the user wants
48 ;;; to be notified of a pending appointment.
49 ;;;
50 ;;; In order to use the appt package, you only need
51 ;;; to load it---provided you have appointments.
52 ;;;
53 ;;; Before that, you can also set some options if you want
54 ;;; (setq view-diary-entries-initially t)
55 ;;; (setq appt-issue-message t)
56 ;;;
57 ;;; This is an example of what can be in your diary file:
58 ;;; Monday
59 ;;; 9:30am Coffee break
60 ;;; 12:00pm Lunch
61 ;;;
62 ;;; Based upon the above lines in your .emacs and diary files,
63 ;;; the calendar and diary will be displayed when you enter
64 ;;; Emacs and your appointments list will automatically be created.
65 ;;; You will then be reminded at 9:20am about your coffee break
66 ;;; and at 11:50am to go to lunch.
67 ;;;
68 ;;; Use describe-function on appt-check for a description of other variables
69 ;;; that can be used to personalize the notification system.
70 ;;;
71 ;;; In order to add or delete items from todays list, use appt-add
72 ;;; and appt-delete.
73 ;;;
74 ;;; Additionally, the appointments list is recreated automatically
75 ;;; at 12:01am for those who do not logout every day or are programming
76 ;;; late.
77 ;;;
78 ;;; Brief internal description - Skip this if you are not interested!
79 ;;;
80 ;;; The function appt-make-list creates the appointments list which appt-check
81 ;;; reads. This is all done automatically.
82 ;;; It is invoked from the function list-diary-entries.
83 ;;;
84 ;;; You can change the way the appointment window is created/deleted by
85 ;;; setting the variables
86 ;;;
87 ;;; appt-disp-window-function
88 ;;; and
89 ;;; appt-delete-window-function
90 ;;;
91 ;;; For instance, these variables can be set to functions that display
92 ;;; appointments in pop-up frames, which are lowered or iconified after
93 ;;; appt-display-interval minutes.
94 ;;;
96 ;;; Code:
98 ;; Make sure calendar is loaded when we compile this.
103 ;;;###autoload
105 "*Non-nil means check for appointments in the diary buffer.
106 To be detected, the diary entry must have the time
107 as the first thing on a line."
111 ;;;###autoload
113 "*Time in minutes before an appointment that the warning begins."
117 ;;;###autoload
119 "*Non-nil means beep to indicate appointment."
123 ;;;###autoload
125 "*Non-nil means display appointment message in echo area."
129 ;;;###autoload
131 "*Non-nil means display minutes to appointment and time on the mode line."
135 ;;;###autoload
137 "*Non-nil means display appointment message in another window."
141 ;;;###autoload
143 "*The number of seconds an appointment message is displayed."
147 ;;;###autoload
149 "*Non-nil means to display the next days diary on the screen.
150 This will occur at midnight when the appointment list is updated."
155 "The list of appointments for today.
156 Use `appt-add' and `appt-delete' to add and delete appointments from list.
157 The original list is generated from the today's `diary-entries-list'.
164 "*Number of minutes to wait between checking the appointment list."
178 "String being displayed in the mode line saying you have an appointment.
190 "Check for an appointment and update the mode line.
191 Note: the time must be the first thing in the line in the diary
192 for a warning to be issued.
194 The format of the time can be either 24 hour or am/pm.
195 Example:
197 02/23/89
198 18:00 Dinner
200 Thursday
201 11:45am Lunch meeting.
203 Appointments are checked every `appt-display-interval' minutes.
204 The following variables control appointment notification:
206 `appt-issue-message'
207 If t, the diary buffer is checked for appointments.
209 `appt-message-warning-time'
210 Variable used to determine if appointment message
211 should be displayed.
213 `appt-audible'
214 Variable used to determine if appointment is audible.
215 Default is t.
217 `appt-visible'
218 Variable used to determine if appointment message should be
219 displayed in the mini-buffer. Default is t.
221 `appt-msg-window'
222 Variable used to determine if appointment message
223 should temporarily appear in another window. Mutually exclusive
224 to `appt-visible'.
226 `appt-display-duration'
227 The number of seconds an appointment message
228 is displayed in another window.
230 `appt-disp-window-function'
231 Function called to display appointment window. You can customize
232 appt.el by setting this variable to a function different from the
233 one provided with this package.
235 `appt-delete-window-function'
236 Function called to remove appointment window and buffer. You can
237 customize appt.el by setting this variable to a function different
238 from the one provided with this package."
244 ;; Non-nil means do a full check for pending appointments
245 ;; and display in whatever ways the user has selected.
246 ;; When no appointment is being displayed,
247 ;; we always do a full check.
250 ;; This is true every appt-display-interval minutes.
252 ;; Non-nil means only update the interval displayed in the mode line.
259 ;; Get the current time and convert it to minutes
260 ;; from midnight. ie. 12:01am = 1, midnight = 0.
267 ;; At the first check in any given day, update our
268 ;; appointments to today's list.
284 ;; If there are entries in the list, and the
285 ;; user wants a message issued,
286 ;; get the first time off of the list
287 ;; and calculate the number of minutes until the appointment.
300 ;; If we have an appointment between midnight and
301 ;; 'appt-message-warning-time' minutes after midnight,
302 ;; we must begin to issue a message before midnight.
303 ;; Midnight is considered 0 minutes and 11:59pm is
304 ;; 1439 minutes. Therefore we must recalculate the minutes
305 ;; to appointment variable. It is equal to the number of
306 ;; minutes before midnight plus the number of
307 ;; minutes after midnight our appointment is.
311 appt-max-time))
313 appt-comp-time))
315 ;; issue warning if the appointment time is
316 ;; within appt-message-warning time
329 appt-disp-window-function
335 nil
336 appt-delete-window-function))
337 ;;; else
352 ;; When an appointment is reached,
353 ;; delete it from the list.
354 ;; Reset the count to 0 in case we display another
355 ;; appointment on the next cycle.
359 appt-display-count nil)))))
361 ;; If we have changed the mode line string,
362 ;; redisplay all mode lines.
365 prev-appt-mode-string))
368 ;; If the string now has a notification,
369 ;; redisplay right now.
375 "Display appointment message APPT-MSG in a separate buffer."
378 ;; Make sure we're not in the minibuffer
379 ;; before splitting the window.
392 ;; In an unsplittable frame, use something somewhere else.
396 ;; By default, split the bottom window and use the lower part.
413 "Function called to undisplay appointment messages.
414 Usually just deletes the appointment buffer."
424 "Select the lowest window on the frame."
431 lowest-window w)))))
434 ;;;###autoload
436 "Add an appointment for the day at NEW-APPT-TIME and issue message NEW-APPT-MSG.
437 The time should be in either 24 hour format or am/pm format."
441 nil
450 ;;;###autoload
452 "Delete an appointment from the list of appointments."
458 ;; We want to quote any doublequotes
459 ;; in the string, as well as put
460 ;; doublequotes around it.
476 ;;;###autoload
478 "Create the appointments list from todays diary buffer.
479 The time must be at the beginning of a line for it to be
480 put in the appointments list.
481 02/23/89
482 12:00pm lunch
483 Wednesday
484 10:00am group meeting
485 We assume that the variables DATE and NUMBER
486 hold the arguments that `list-diary-entries' received.
487 They specify the range of dates that the diary is being processed for."
489 ;; We have something to do if the range of dates that the diary is
490 ;; considering includes the current date.
498 number)))))
500 ;; Clear the appointments list, then fill it in from the diary.
504 ;; Cycle through the entry-list (diary-entries-list)
505 ;; looking for entries beginning with a time. If
506 ;; the entry begins with a time, add it to the
507 ;; appt-time-msg-list. Then sort the list.
511 ;; Skip diary entries for dates before today.
516 ;; Parse the entries for today.
523 time-string)
525 ;; Get just the time for this appointment.
527 ;; Find the end of this appointment
528 ;; (the start of the next).
531 time-string
533 ;; Get the whole string for this appointment.
537 ;; Add this appointment to appt-time-msg-list.
543 ;; Discard this appointment from the string.
549 ;; Get the current time and convert it to minutes
550 ;; from midnight. ie. 12:01am = 1, midnight = 0,
551 ;; so that the elements in the list
552 ;; that are earlier than the present time can
553 ;; be removed.
568 "Simple sort to put the appointments list APPT-LIST in order.
569 Scan the list for the smallest element left in the list.
570 Append the smallest element left into the new list, and remove
571 it from the original list."
579 nil
585 order-list))
589 "Convert hour:min[am/pm] format to minutes from midnight."
603 ;; convert the time appointment time into 24 hour time
610 ;; convert the actual time
611 ;; into minutes for comparison
612 ;; against the actual time.
615 conv-time))
628 ;;; appt.el ends here