annotate lisp/calendar/appt.el @ 97571:c532aa80972d

*** empty log message ***
author David Reitter <david.reitter@gmail.com>
date Wed, 20 Aug 2008 17:53:23 +0000
parents f9c7bc38ee36
children 8b10135f8d6c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 30538
diff changeset
1 ;;; appt.el --- appointment notification functions
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 179
diff changeset
2
68721
8daf7d9a0771 Add 2006 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 67465
diff changeset
3 ;; Copyright (C) 1989, 1990, 1994, 1998, 2001, 2002, 2003, 2004, 2005,
79703
974a828870fe Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78216
diff changeset
4 ;; 2006, 2007, 2008 Free Software Foundation, Inc.
846
20674ae6bf52 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
5
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
6 ;; Author: Neil Mager <neilm@juliet.ll.mit.edu>
65919
5c09efcfc1d9 Update maintainer email address.
Glenn Morris <rgm@gnu.org>
parents: 65840
diff changeset
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
8 ;; Keywords: calendar
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
9
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11
94653
e49abd957e81 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93948
diff changeset
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
94653
e49abd957e81 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93948
diff changeset
14 ;; the Free Software Foundation, either version 3 of the License, or
e49abd957e81 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93948
diff changeset
15 ;; (at your option) any later version.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20 ;; GNU General Public License for more details.
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
94653
e49abd957e81 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 93948
diff changeset
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
24
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
25 ;;; Commentary:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
26
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 ;;
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 ;; appt.el - visible and/or audible notification of
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
29 ;; appointments from diary file.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 ;;
93237
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
31 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
32 ;; Thanks to Edward M. Reingold for much help and many suggestions,
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
33 ;; And to many others for bug fixes and suggestions.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
34 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
35 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
36 ;; This functions in this file will alert the user of a
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
37 ;; pending appointment based on his/her diary file. This package
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
38 ;; is documented in the Emacs manual.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
39 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
40 ;; To activate this package, simply use (appt-activate 1).
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
41 ;; A `diary-file' with appointments of the format described in the
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
42 ;; documentation of the function `appt-check' is required.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
43 ;; Relevant customizable variables are also listed in the
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
44 ;; documentation of that function.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
45 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
46 ;; Today's appointment list is initialized from the diary when this
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
47 ;; package is activated. Additionally, the appointments list is
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
48 ;; recreated automatically at 12:01am for those who do not logout
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
49 ;; every day or are programming late. It is also updated when the
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
50 ;; `diary-file' is saved. Calling `appt-check' with an argument forces
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
51 ;; a re-initialization at any time.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
52 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
53 ;; In order to add or delete items from today's list, without
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
54 ;; changing the diary file, use `appt-add' and `appt-delete'.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
55 ;;
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
56
93237
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
57 ;; Brief internal description - Skip this if you are not interested!
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
58 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
59 ;; The function `appt-make-list' creates the appointments list which
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
60 ;; `appt-check' reads.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
61 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
62 ;; You can change the way the appointment window is created/deleted by
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
63 ;; setting the variables
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
64 ;;
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
65 ;; appt-disp-window-function
93237
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
66 ;; and
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
67 ;; appt-delete-window-function
93237
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
68 ;;
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
69 ;; For instance, these variables could be set to functions that display
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
70 ;; appointments in pop-up frames, which are lowered or iconified after
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
71 ;; `appt-display-interval' minutes.
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
72 ;;
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
73
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
74 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 777
diff changeset
75
93948
a90650368da6 Require diary-lib rather than calendar.
Glenn Morris <rgm@gnu.org>
parents: 93532
diff changeset
76 (require 'diary-lib)
8500
1e2396756604 Require calendar.
Richard M. Stallman <rms@gnu.org>
parents: 8493
diff changeset
77
92577
2d599418bddb (appt): Move custom group here from calendar.el.
Glenn Morris <rgm@gnu.org>
parents: 92545
diff changeset
78
2d599418bddb (appt): Move custom group here from calendar.el.
Glenn Morris <rgm@gnu.org>
parents: 92545
diff changeset
79 (defgroup appt nil
2d599418bddb (appt): Move custom group here from calendar.el.
Glenn Morris <rgm@gnu.org>
parents: 92545
diff changeset
80 "Appointment notification."
93948
a90650368da6 Require diary-lib rather than calendar.
Glenn Morris <rgm@gnu.org>
parents: 93532
diff changeset
81 :prefix "appt-"
92577
2d599418bddb (appt): Move custom group here from calendar.el.
Glenn Morris <rgm@gnu.org>
parents: 92545
diff changeset
82 :group 'calendar)
2d599418bddb (appt): Move custom group here from calendar.el.
Glenn Morris <rgm@gnu.org>
parents: 92545
diff changeset
83
53562
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
84 (defcustom appt-issue-message t
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
85 "Non-nil means check for appointments in the diary buffer.
53562
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
86 To be detected, the diary entry must have the format described in the
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
87 documentation of the function `appt-check'."
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
88 :type 'boolean
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
89 :group 'appt)
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
90
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
91 (make-obsolete-variable 'appt-issue-message
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
92 "use the function `appt-activate', and the \
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 55559
diff changeset
93 variable `appt-display-format' instead." "22.1")
53562
8014694c2be8 (appt-issue-message): Mark as obsolete rather than deleting outright.
Glenn Morris <rgm@gnu.org>
parents: 53556
diff changeset
94
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
95 (defcustom appt-message-warning-time 12
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
96 "Time in minutes before an appointment that the warning begins."
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
97 :type 'integer
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
98 :group 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
99
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
100 (defcustom appt-audible t
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
101 "Non-nil means beep to indicate appointment."
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
102 :type 'boolean
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
103 :group 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
104
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
105 (defcustom appt-visible t
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
106 "Non-nil means display appointment message in echo area.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
107 This variable is only relevant if `appt-msg-window' is nil."
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
108 :type 'boolean
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
109 :group 'appt)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
110
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 55559
diff changeset
111 (make-obsolete-variable 'appt-visible 'appt-display-format "22.1")
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
112
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
113 (defcustom appt-msg-window t
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
114 "Non-nil means display appointment message in another window.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
115 If non-nil, this variable overrides `appt-visible'."
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
116 :type 'boolean
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
117 :group 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
118
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 55559
diff changeset
119 (make-obsolete-variable 'appt-msg-window 'appt-display-format "22.1")
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
120
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
121 ;; TODO - add popup.
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
122 (defcustom appt-display-format 'ignore
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
123 "How appointment reminders should be displayed.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
124 The options are:
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
125 window - use a separate window
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
126 echo - use the echo area
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
127 nil - no visible reminder.
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
128 See also `appt-audible' and `appt-display-mode-line'.
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
129
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
130 The default value is 'ignore, which means to fall back on the value
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
131 of the (obsolete) variables `appt-msg-window' and `appt-visible'."
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
132 :type '(choice
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
133 (const :tag "Separate window" window)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
134 (const :tag "Echo-area" echo)
71406
901e09680d63 (appt-display-format): Default value must be
Glenn Morris <rgm@gnu.org>
parents: 70633
diff changeset
135 (const :tag "No visible display" nil)
901e09680d63 (appt-display-format): Default value must be
Glenn Morris <rgm@gnu.org>
parents: 70633
diff changeset
136 (const :tag "Backwards compatibility setting - choose another value"
901e09680d63 (appt-display-format): Default value must be
Glenn Morris <rgm@gnu.org>
parents: 70633
diff changeset
137 ignore))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
138 :group 'appt
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 55559
diff changeset
139 :version "22.1")
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
140
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
141 (defcustom appt-display-mode-line t
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
142 "Non-nil means display minutes to appointment and time on the mode line.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
143 This is in addition to any other display of appointment messages."
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
144 :type 'boolean
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
145 :group 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
146
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
147 (defcustom appt-display-duration 10
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
148 "The number of seconds an appointment message is displayed.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
149 Only relevant if reminders are to be displayed in their own window."
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
150 :type 'integer
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
151 :group 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
152
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
153 (defcustom appt-display-diary t
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
154 "Non-nil displays the diary when the appointment list is first initialized.
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
155 This will occur at midnight when the appointment list is updated."
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
156 :type 'boolean
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
157 :group 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
158
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
159 (defcustom appt-display-interval 3
86418
bbc7f9c9ad6e Remove leading `*' from defcustom doc-strings.
Glenn Morris <rgm@gnu.org>
parents: 82176
diff changeset
160 "Number of minutes to wait between checking the appointment list."
17624
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
161 :type 'integer
7634c31da26e Add defgroup and use defcustom.
Richard M. Stallman <rms@gnu.org>
parents: 15679
diff changeset
162 :group 'appt)
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
163
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
164 (defcustom appt-disp-window-function 'appt-disp-window
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
165 "Function called to display appointment window.
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
166 Only relevant if reminders are being displayed in a window.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
167 It should take three string arguments: the number of minutes till
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
168 the appointment, the current time, and the text of the appointment."
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
169 :type '(choice (const appt-disp-window)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
170 function)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
171 :group 'appt)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
172
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
173 (defcustom appt-delete-window-function 'appt-delete-window
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
174 "Function called to remove appointment window and buffer.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
175 Only relevant if reminders are being displayed in a window."
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
176 :type '(choice (const appt-delete-window)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
177 function)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
178 :group 'appt)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
179
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
180
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
181 ;;; Internal variables below this point.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
182
93237
0f4b8a3dc49e (appt-buffer-name): Don't use a leading space for buffers shown to the user.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92968
diff changeset
183 (defconst appt-buffer-name "*appt-buf*"
5659
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
184 "Name of the appointments buffer.")
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
185
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
186 (defvar appt-time-msg-list nil
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
187 "The list of appointments for today.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
188 Use `appt-add' and `appt-delete' to add and delete appointments.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
189 The original list is generated from today's `diary-entries-list', and
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
190 can be regenerated using the function `appt-check'.
60225
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
191 Each element of the generated list has the form (MINUTES STRING [FLAG]); where
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
192 MINUTES is the time in minutes of the appointment after midnight, and
60225
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
193 STRING is the description of the appointment.
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
194 FLAG, if non-nil, says that the element was made with `appt-add'
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
195 so calling `appt-make-list' again should preserve it.")
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
196
65840
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
197 (defconst appt-max-time (1- (* 24 60))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
198 "11:59pm in minutes - number of minutes in a day minus 1.")
5034
c7badee38b64 (appt-display-interval): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 957
diff changeset
199
23112
81052242dbce (appt-mode-string): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17624
diff changeset
200 (defvar appt-mode-string nil
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
201 "String being displayed in the mode line saying you have an appointment.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
202 The actual string includes the amount of time till the appointment.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
203 Only used if `appt-display-mode-line' is non-nil.")
92816
0a27edb53589 (appt-mode-string): Mark as risky.
Glenn Morris <rgm@gnu.org>
parents: 92655
diff changeset
204 (put 'appt-mode-string 'risky-local-variable t) ; for 'face property
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
205
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
206 (defvar appt-prev-comp-time nil
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
207 "Time of day (mins since midnight) at which we last checked appointments.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
208 A nil value forces the diary file to be (re-)checked for appointments.")
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
209
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
210 (defvar appt-now-displayed nil
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
211 "Non-nil when we have started notifying about a appointment that is near.")
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
212
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
213 (defvar appt-display-count nil
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
214 "Internal variable used to count number of consecutive reminders.")
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
215
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
216 (defvar appt-timer nil
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
217 "Timer used for diary appointment notifications (`appt-check').
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
218 If this is non-nil, appointment checking is active.")
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
219
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
220
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
221 ;;; Functions.
23112
81052242dbce (appt-mode-string): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17624
diff changeset
222
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
223 (defun appt-display-message (string mins)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
224 "Display a reminder about an appointment.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
225 The string STRING describes the appointment, due in integer MINS minutes.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
226 The format of the visible reminder is controlled by `appt-display-format'.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
227 The variable `appt-audible' controls the audible reminder."
96465
f9c7bc38ee36 Spelling fix.
Glenn Morris <rgm@gnu.org>
parents: 95411
diff changeset
228 ;; Let-binding for backwards compatibility. Remove when obsolete
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
229 ;; vars appt-msg-window and appt-visible are dropped.
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
230 (let ((appt-display-format
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
231 (if (eq appt-display-format 'ignore)
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
232 (cond (appt-msg-window 'window)
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
233 (appt-visible 'echo))
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
234 appt-display-format)))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
235 (if appt-audible (beep 1))
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
236 (cond ((eq appt-display-format 'window)
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
237 (funcall appt-disp-window-function
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
238 (number-to-string mins)
92654
71481bc91b5a Formatting changes only.
Glenn Morris <rgm@gnu.org>
parents: 92577
diff changeset
239 ;; TODO - use calendar-month-abbrev-array rather than %b?
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
240 (format-time-string "%a %b %e " (current-time))
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
241 string)
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
242 (run-at-time (format "%d sec" appt-display-duration)
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
243 nil
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
244 appt-delete-window-function))
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
245 ((eq appt-display-format 'echo)
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
246 (message "%s" string)))))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
247
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
248
92968
e2f0046a8cb4 (appt-check, appt-delete, appt-make-list): Use caar.
Glenn Morris <rgm@gnu.org>
parents: 92816
diff changeset
249 (defvar diary-selective-display)
e2f0046a8cb4 (appt-check, appt-delete, appt-make-list): Use caar.
Glenn Morris <rgm@gnu.org>
parents: 92816
diff changeset
250
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
251 (defun appt-check (&optional force)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
252 "Check for an appointment and update any reminder display.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
253 If optional argument FORCE is non-nil, reparse the diary file for
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
254 appointments. Otherwise the diary file is only parsed once per day,
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
255 and when saved.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
256
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
257 Note: the time must be the first thing in the line in the diary
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
258 for a warning to be issued. The format of the time can be either
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
259 24 hour or am/pm. For example:
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
260
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
261 02/23/89
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
262 18:00 Dinner
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
263
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
264 Thursday
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
265 11:45am Lunch meeting.
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
266
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
267 Appointments are checked every `appt-display-interval' minutes.
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
268 The following variables control appointment notification:
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
269
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
270 `appt-display-format'
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
271 Controls the format in which reminders are displayed.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
272
23112
81052242dbce (appt-mode-string): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17624
diff changeset
273 `appt-audible'
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
274 Variable used to determine if reminder is audible.
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
275 Default is t.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
276
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
277 `appt-message-warning-time'
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
278 Variable used to determine when appointment message
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
279 should first be displayed.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
280
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
281 `appt-display-mode-line'
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
282 If non-nil, a generic message giving the time remaining
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
283 is shown in the mode-line when an appointment is due.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
284
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
285 `appt-display-interval'
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
286 Interval in minutes at which to check for pending appointments.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
287
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
288 `appt-display-diary'
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
289 Display the diary buffer when the appointment list is
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
290 initialized for the first time in a day.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
291
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
292 The following variables are only relevant if reminders are being
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
293 displayed in a window:
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
294
23112
81052242dbce (appt-mode-string): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17624
diff changeset
295 `appt-display-duration'
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
296 The number of seconds an appointment message is displayed.
5034
c7badee38b64 (appt-display-interval): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 957
diff changeset
297
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
298 `appt-disp-window-function'
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
299 Function called to display appointment window.
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
300
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
301 `appt-delete-window-function'
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
302 Function called to remove appointment window and buffer."
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
303 (interactive "P") ; so people can force updates
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
304 (let* ((min-to-app -1)
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
305 (prev-appt-mode-string appt-mode-string)
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
306 (prev-appt-display-count (or appt-display-count 0))
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
307 ;; Non-nil means do a full check for pending appointments and
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
308 ;; display in whatever ways the user has selected. When no
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
309 ;; appointment is being displayed, we always do a full check.
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
310 (full-check
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
311 (or (not appt-now-displayed)
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
312 ;; This is true every appt-display-interval minutes.
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
313 (zerop (mod prev-appt-display-count appt-display-interval))))
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
314 ;; Non-nil means only update the interval displayed in the mode line.
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
315 (mode-line-only (unless full-check appt-now-displayed))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
316 now cur-comp-time appt-comp-time)
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
317 (when (or full-check mode-line-only)
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
318 (save-excursion
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
319 ;; Convert current time to minutes after midnight (12.01am = 1).
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
320 (setq now (decode-time)
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
321 cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
322 ;; At first check in any day, update appointments to today's list.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
323 (if (or force ; eg initialize, diary save
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
324 (null appt-prev-comp-time) ; first check
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
325 (< cur-comp-time appt-prev-comp-time)) ; new day
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
326 (condition-case nil
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
327 (if appt-display-diary
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
328 (let ((diary-hook
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
329 (if (assoc 'appt-make-list diary-hook)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
330 diary-hook
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
331 (cons 'appt-make-list diary-hook))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
332 (diary))
95411
7a388916f4ae (appt-check): Use diary-display-function rather than diary-display-hook.
Glenn Morris <rgm@gnu.org>
parents: 94653
diff changeset
333 (let* ((diary-display-function 'appt-make-list)
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
334 (d-buff (find-buffer-visiting
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
335 (substitute-in-file-name diary-file)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
336 (selective
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
337 (if d-buff ; diary buffer exists
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
338 (with-current-buffer d-buff
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
339 diary-selective-display))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
340 (diary)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
341 ;; If the diary buffer existed before this command,
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
342 ;; restore its display state. Otherwise, kill it.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
343 (if d-buff
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
344 ;; Displays the diary buffer.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
345 (or selective (diary-show-all-entries))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
346 (and (setq d-buff (find-buffer-visiting
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
347 (substitute-in-file-name diary-file)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
348 (kill-buffer d-buff)))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
349 (error nil)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
350 (setq appt-prev-comp-time cur-comp-time
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
351 appt-mode-string nil
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
352 appt-display-count nil)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
353 ;; If there are entries in the list, and the user wants a
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
354 ;; message issued, get the first time off of the list and
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
355 ;; calculate the number of minutes until the appointment.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
356 (when (and appt-issue-message appt-time-msg-list)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
357 (setq appt-comp-time (caar (car appt-time-msg-list))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
358 min-to-app (- appt-comp-time cur-comp-time))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
359 (while (and appt-time-msg-list
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
360 (< appt-comp-time cur-comp-time))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
361 (setq appt-time-msg-list (cdr appt-time-msg-list))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
362 (if appt-time-msg-list
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
363 (setq appt-comp-time (caar (car appt-time-msg-list)))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
364 ;; If we have an appointment between midnight and
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
365 ;; `appt-message-warning-time' minutes after midnight, we
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
366 ;; must begin to issue a message before midnight. Midnight
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
367 ;; is considered 0 minutes and 11:59pm is 1439
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
368 ;; minutes. Therefore we must recalculate the minutes to
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
369 ;; appointment variable. It is equal to the number of
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
370 ;; minutes before midnight plus the number of minutes after
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
371 ;; midnight our appointment is.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
372 (if (and (< appt-comp-time appt-message-warning-time)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
373 (> (+ cur-comp-time appt-message-warning-time)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
374 appt-max-time))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
375 (setq min-to-app (+ (- (1+ appt-max-time) cur-comp-time)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
376 appt-comp-time)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
377 ;; Issue warning if the appointment time is within
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
378 ;; appt-message-warning time.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
379 (when (and (<= min-to-app appt-message-warning-time)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
380 (>= min-to-app 0))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
381 (setq appt-now-displayed t
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
382 appt-display-count (1+ prev-appt-display-count))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
383 (unless mode-line-only
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
384 (appt-display-message (cadr (car appt-time-msg-list))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
385 min-to-app))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
386 (when appt-display-mode-line
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
387 (setq appt-mode-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
388 (concat " " (propertize
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
389 (format "App't in %s min." min-to-app)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
390 'face 'mode-line-emphasis))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
391 ;; When an appointment is reached, delete it from the
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
392 ;; list. Reset the count to 0 in case we display another
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
393 ;; appointment on the next cycle.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
394 (if (zerop min-to-app)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
395 (setq appt-time-msg-list (cdr appt-time-msg-list)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
396 appt-display-count nil))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
397 ;; If we have changed the mode line string, redisplay all mode lines.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
398 (and appt-display-mode-line
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
399 (not (string-equal appt-mode-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
400 prev-appt-mode-string))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
401 (progn
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
402 (force-mode-line-update t)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
403 ;; If the string now has a notification, redisplay right now.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
404 (if appt-mode-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
405 (sit-for 0))))))))
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
406
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
407 (defun appt-disp-window (min-to-app new-time appt-msg)
92655
e5e96d20ca3e (appt-disp-window, appt-convert-time): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 92654
diff changeset
408 "Display appointment due in MIN-TO-APP (a string) minutes.
e5e96d20ca3e (appt-disp-window, appt-convert-time): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 92654
diff changeset
409 NEW-TIME is a string giving the date. Displays the appointment
e5e96d20ca3e (appt-disp-window, appt-convert-time): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 92654
diff changeset
410 message APPT-MSG in a separate buffer."
86420
b245f4378114 (appt-disp-window): Restore a simplified version of
Glenn Morris <rgm@gnu.org>
parents: 86418
diff changeset
411 ;; Make sure we're not in the minibuffer before splitting the window.
b245f4378114 (appt-disp-window): Restore a simplified version of
Glenn Morris <rgm@gnu.org>
parents: 86418
diff changeset
412 ;; FIXME this seems needlessly complicated?
b245f4378114 (appt-disp-window): Restore a simplified version of
Glenn Morris <rgm@gnu.org>
parents: 86418
diff changeset
413 (when (minibufferp)
b245f4378114 (appt-disp-window): Restore a simplified version of
Glenn Morris <rgm@gnu.org>
parents: 86418
diff changeset
414 (other-window 1)
b245f4378114 (appt-disp-window): Restore a simplified version of
Glenn Morris <rgm@gnu.org>
parents: 86418
diff changeset
415 (and (minibufferp) (display-multi-frame-p) (other-frame 1)))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
416 (let ((this-window (selected-window))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
417 (appt-disp-buf (set-buffer (get-buffer-create appt-buffer-name))))
9413
e54eede71446 (appt-delete-window): Look on all frames for the window.
Richard M. Stallman <rms@gnu.org>
parents: 8500
diff changeset
418 (if (cdr (assq 'unsplittable (frame-parameters)))
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
419 ;; In an unsplittable frame, use something somewhere else.
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
420 (display-buffer appt-disp-buf)
23777
5d10105c2906 (appt-disp-window): Use pop-to-buffer,
Richard M. Stallman <rms@gnu.org>
parents: 23297
diff changeset
421 (unless (or (special-display-p (buffer-name appt-disp-buf))
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
422 (same-window-p (buffer-name appt-disp-buf)))
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
423 ;; By default, split the bottom window and use the lower part.
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
424 (appt-select-lowest-window)
77192
2b47f00a7c16 (appt-disp-window): Do not split small windows.
Glenn Morris <rgm@gnu.org>
parents: 75346
diff changeset
425 ;; Split the window, unless it's too small to do so.
2b47f00a7c16 (appt-disp-window): Do not split small windows.
Glenn Morris <rgm@gnu.org>
parents: 75346
diff changeset
426 (when (>= (window-height) (* 2 window-min-height))
2b47f00a7c16 (appt-disp-window): Do not split small windows.
Glenn Morris <rgm@gnu.org>
parents: 75346
diff changeset
427 (select-window (split-window))))
55559
a4d697f046db (appt-disp-window): Use `calendar-set-mode-line' for a centered
Glenn Morris <rgm@gnu.org>
parents: 54535
diff changeset
428 (switch-to-buffer appt-disp-buf))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
429 ;; FIXME Link to diary entry?
55559
a4d697f046db (appt-disp-window): Use `calendar-set-mode-line' for a centered
Glenn Morris <rgm@gnu.org>
parents: 54535
diff changeset
430 (calendar-set-mode-line
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
431 (format " Appointment %s. %s "
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
432 (if (string-equal "0" min-to-app) "now"
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
433 (format "in %s minute%s" min-to-app
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
434 (if (string-equal "1" min-to-app) "" "s")))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
435 new-time))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
436 (setq buffer-read-only nil
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
437 buffer-undo-list t)
23112
81052242dbce (appt-mode-string): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17624
diff changeset
438 (erase-buffer)
41565
6ecdf9c3fd25 (appt-disp-window): Use insert instead of insert-string.
Pavel Janík <Pavel@Janik.cz>
parents: 38412
diff changeset
439 (insert appt-msg)
9413
e54eede71446 (appt-delete-window): Look on all frames for the window.
Richard M. Stallman <rms@gnu.org>
parents: 8500
diff changeset
440 (shrink-window-if-larger-than-buffer (get-buffer-window appt-disp-buf t))
5659
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
441 (set-buffer-modified-p nil)
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
442 (setq buffer-read-only t)
13125
731ef06c5677 (appt-disp-window): Call raise-frame.
Richard M. Stallman <rms@gnu.org>
parents: 12549
diff changeset
443 (raise-frame (selected-frame))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
444 (select-window this-window)))
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
445
5659
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
446 (defun appt-delete-window ()
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
447 "Function called to undisplay appointment messages.
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
448 Usually just deletes the appointment buffer."
9551
ac21ac5e8c69 (appt-select-lowest-window): Locally bind lowest-window.
Richard M. Stallman <rms@gnu.org>
parents: 9413
diff changeset
449 (let ((window (get-buffer-window appt-buffer-name t)))
ac21ac5e8c69 (appt-select-lowest-window): Locally bind lowest-window.
Richard M. Stallman <rms@gnu.org>
parents: 9413
diff changeset
450 (and window
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
451 (or (eq window (frame-root-window (window-frame window)))
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
452 (delete-window window))))
5659
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
453 (kill-buffer appt-buffer-name)
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
454 (if appt-audible
32a02ab40d58 (appt-check): Use the new variables
Richard M. Stallman <rms@gnu.org>
parents: 5034
diff changeset
455 (beep 1)))
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
456
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
457 (defun appt-select-lowest-window ()
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
458 "Select the lowest window on the frame."
30001
55656f797f82 (appt-select-lowest-window): Use walk-windows
Gerd Moellmann <gerd@gnu.org>
parents: 28968
diff changeset
459 (let ((lowest-window (selected-window))
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
460 (bottom-edge (nth 3 (window-edges)))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
461 next-bottom-edge)
30001
55656f797f82 (appt-select-lowest-window): Use walk-windows
Gerd Moellmann <gerd@gnu.org>
parents: 28968
diff changeset
462 (walk-windows (lambda (w)
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
463 (when (< bottom-edge (setq next-bottom-edge
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
464 (nth 3 (window-edges w))))
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
465 (setq bottom-edge next-bottom-edge
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
466 lowest-window w))) 'nomini)
30001
55656f797f82 (appt-select-lowest-window): Use walk-windows
Gerd Moellmann <gerd@gnu.org>
parents: 28968
diff changeset
467 (select-window lowest-window)))
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
468
65840
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
469 (defconst appt-time-regexp
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
470 "[0-9]?[0-9]\\(h\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]\\)\\(am\\|pm\\)?")
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
471
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
472 ;;;###autoload
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
473 (defun appt-add (new-appt-time new-appt-msg)
61140
b9677b0e5e91 Update maintainer.
Glenn Morris <rgm@gnu.org>
parents: 60225
diff changeset
474 "Add an appointment for today at NEW-APPT-TIME with message NEW-APPT-MSG.
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
475 The time should be in either 24 hour format or am/pm format."
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
476 (interactive "sTime (hh:mm[am/pm]): \nsMessage: ")
65840
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
477 (unless (string-match appt-time-regexp new-appt-time)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
478 (error "Unacceptable time-string"))
70029
14a3b2b9c00b (appt-add): Check whether an appointment is already present in
Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
parents: 69080
diff changeset
479 (let ((time-msg (list (list (appt-convert-time new-appt-time))
14a3b2b9c00b (appt-add): Check whether an appointment is already present in
Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
parents: 69080
diff changeset
480 (concat new-appt-time " " new-appt-msg) t)))
14a3b2b9c00b (appt-add): Check whether an appointment is already present in
Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
parents: 69080
diff changeset
481 (unless (member time-msg appt-time-msg-list)
14a3b2b9c00b (appt-add): Check whether an appointment is already present in
Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
parents: 69080
diff changeset
482 (setq appt-time-msg-list
14a3b2b9c00b (appt-add): Check whether an appointment is already present in
Roland Winkler <Roland.Winkler@physik.uni-erlangen.de>
parents: 69080
diff changeset
483 (appt-sort-list (nconc appt-time-msg-list (list time-msg)))))))
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
484
23297
e23cdc314c10 (appt-interval): Variable deleted.
Karl Heuer <kwzh@gnu.org>
parents: 23124
diff changeset
485 ;;;###autoload
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
486 (defun appt-delete ()
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
487 "Delete an appointment from the list of appointments."
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
488 (interactive)
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
489 (let ((tmp-msg-list appt-time-msg-list))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
490 (dolist (element tmp-msg-list)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
491 (if (y-or-n-p (concat "Delete "
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
492 ;; We want to quote any doublequotes in the
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
493 ;; string, as well as put doublequotes around it.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
494 (prin1-to-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
495 (substring-no-properties (cadr element) 0))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
496 " from list? "))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
497 (setq appt-time-msg-list (delq element appt-time-msg-list)))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
498 (appt-check)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
499 (message ""))
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
500
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
501
82176
907a4e983597 Don't wrap defvar within eval-when-compile.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78216
diff changeset
502 (defvar number)
907a4e983597 Don't wrap defvar within eval-when-compile.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78216
diff changeset
503 (defvar original-date)
907a4e983597 Don't wrap defvar within eval-when-compile.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78216
diff changeset
504 (defvar diary-entries-list)
93948
a90650368da6 Require diary-lib rather than calendar.
Glenn Morris <rgm@gnu.org>
parents: 93532
diff changeset
505 ;; Autoload for the old way of using this package. Can be removed sometime.
927
587a08c3a70b *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 846
diff changeset
506 ;;;###autoload
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
507 (defun appt-make-list ()
60225
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
508 "Update the appointments list from today's diary buffer.
28404
243081e5c0e7 Doc fixes.
Dave Love <fx@gnu.org>
parents: 27829
diff changeset
509 The time must be at the beginning of a line for it to be
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
510 put in the appointments list (see examples in documentation of
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
511 the function `appt-check'). We assume that the variables DATE and
70633
95f7f08b0a17 (appt-check, appt-make-list): Refer to
Glenn Morris <rgm@gnu.org>
parents: 70029
diff changeset
512 NUMBER hold the arguments that `diary-list-entries' received.
60225
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
513 They specify the range of dates that the diary is being processed for.
c467ceeff8c7 (appt-time-msg-list): 3rd elt of each
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
514
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
515 Any appointments made with `appt-add' are not affected by this function.
28404
243081e5c0e7 Doc fixes.
Dave Love <fx@gnu.org>
parents: 27829
diff changeset
516
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
517 For backwards compatibility, this function activates the
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
518 appointment package (if it is not already active)."
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
519 ;; See comments above appt-activate defun.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
520 (if (not appt-timer)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
521 (appt-activate 1)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
522 ;; We have something to do if the range of dates that the diary is
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
523 ;; considering includes the current date.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
524 (if (and (not (calendar-date-compare
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
525 (list (calendar-current-date))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
526 (list original-date)))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
527 (calendar-date-compare
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
528 (list (calendar-current-date))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
529 (list (calendar-gregorian-from-absolute
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
530 (+ (calendar-absolute-from-gregorian original-date)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
531 number)))))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
532 (save-excursion
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
533 ;; Clear the appointments list, then fill it in from the diary.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
534 (dolist (elt appt-time-msg-list)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
535 ;; Delete any entries that were not made with appt-add.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
536 (unless (nth 2 elt)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
537 (setq appt-time-msg-list
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
538 (delq elt appt-time-msg-list))))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
539 (if diary-entries-list
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
540 ;; Cycle through the entry-list (diary-entries-list)
92654
71481bc91b5a Formatting changes only.
Glenn Morris <rgm@gnu.org>
parents: 92577
diff changeset
541 ;; looking for entries beginning with a time. If the
71481bc91b5a Formatting changes only.
Glenn Morris <rgm@gnu.org>
parents: 92577
diff changeset
542 ;; entry begins with a time, add it to the
71481bc91b5a Formatting changes only.
Glenn Morris <rgm@gnu.org>
parents: 92577
diff changeset
543 ;; appt-time-msg-list. Then sort the list.
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
544 (let ((entry-list diary-entries-list)
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
545 (new-time-string "")
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
546 time-string)
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
547 ;; Skip diary entries for dates before today.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
548 (while (and entry-list
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
549 (calendar-date-compare
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
550 (car entry-list) (list (calendar-current-date))))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
551 (setq entry-list (cdr entry-list)))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
552 ;; Parse the entries for today.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
553 (while (and entry-list
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
554 (calendar-date-equal
92968
e2f0046a8cb4 (appt-check, appt-delete, appt-make-list): Use caar.
Glenn Morris <rgm@gnu.org>
parents: 92816
diff changeset
555 (calendar-current-date) (caar entry-list)))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
556 (setq time-string (cadr (car entry-list)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
557 (while (string-match appt-time-regexp time-string)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
558 (let* ((beg (match-beginning 0))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
559 ;; Get just the time for this appointment.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
560 (only-time (match-string 0 time-string))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
561 ;; Find the end of this appointment
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
562 ;; (the start of the next).
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
563 (end (string-match
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
564 (concat "\n[ \t]*" appt-time-regexp)
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
565 time-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
566 (match-end 0)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
567 ;; Get the whole string for this appointment.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
568 (appt-time-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
569 (substring time-string beg (if end (1- end))))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
570 (appt-time (list (appt-convert-time only-time)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
571 (time-msg (list appt-time appt-time-string)))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
572 ;; Add this appointment to appt-time-msg-list.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
573 (setq appt-time-msg-list
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
574 (nconc appt-time-msg-list (list time-msg))
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
575 ;; Discard this appointment from the string.
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
576 time-string
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
577 (if end (substring time-string end) ""))))
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
578 (setq entry-list (cdr entry-list)))))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
579 (setq appt-time-msg-list (appt-sort-list appt-time-msg-list))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
580 ;; Convert current time to minutes after midnight (12:01am = 1),
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
581 ;; so that elements in the list that are earlier than the
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
582 ;; present time can be removed.
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
583 (let* ((now (decode-time))
93530
4fa95a348719 (appt-disp-window-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 93237
diff changeset
584 (cur-comp-time (+ (* 60 (nth 2 now)) (nth 1 now)))
92968
e2f0046a8cb4 (appt-check, appt-delete, appt-make-list): Use caar.
Glenn Morris <rgm@gnu.org>
parents: 92816
diff changeset
585 (appt-comp-time (caar (car appt-time-msg-list))))
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
586 (while (and appt-time-msg-list (< appt-comp-time cur-comp-time))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
587 (setq appt-time-msg-list (cdr appt-time-msg-list))
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
588 (if appt-time-msg-list
92968
e2f0046a8cb4 (appt-check, appt-delete, appt-make-list): Use caar.
Glenn Morris <rgm@gnu.org>
parents: 92816
diff changeset
589 (setq appt-comp-time (caar (car appt-time-msg-list))))))))))
49598
0d8b17d428b5 Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46909
diff changeset
590
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
591
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
592 (defun appt-sort-list (appt-list)
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
593 "Sort an appointment list, putting earlier items at the front.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
594 APPT-LIST is a list of the same format as `appt-time-msg-list'."
82176
907a4e983597 Don't wrap defvar within eval-when-compile.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78216
diff changeset
595 (sort appt-list (lambda (e1 e2) (< (caar e1) (caar e2)))))
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
596
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
597
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
598 (defun appt-convert-time (time2conv)
92655
e5e96d20ca3e (appt-disp-window, appt-convert-time): Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 92654
diff changeset
599 "Convert hour:min[am/pm] format TIME2CONV to minutes from midnight.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
600 A period (.) can be used instead of a colon (:) to separate the
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
601 hour and minute parts."
65840
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
602 ;; Formats that should be accepted:
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
603 ;; 10:00 10.00 10h00 10h 10am 10:00am 10.00am
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
604 (let ((min (if (string-match "[h:.]\\([0-9][0-9]\\)" time2conv)
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
605 (string-to-number (match-string 1 time2conv))
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
606 0))
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
607 (hr (if (string-match "[0-9]*[0-9]" time2conv)
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
608 (string-to-number (match-string 0 time2conv))
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
609 0)))
92654
71481bc91b5a Formatting changes only.
Glenn Morris <rgm@gnu.org>
parents: 92577
diff changeset
610 ;; Convert the time appointment time into 24 hour time.
26677
b6b1fe18ecf5 (appt-convert-time): Handle "12:MMam",
Gerd Moellmann <gerd@gnu.org>
parents: 24493
diff changeset
611 (cond ((and (string-match "pm" time2conv) (< hr 12))
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
612 (setq hr (+ 12 hr)))
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
613 ((and (string-match "am" time2conv) (= hr 12))
26677
b6b1fe18ecf5 (appt-convert-time): Handle "12:MMam",
Gerd Moellmann <gerd@gnu.org>
parents: 24493
diff changeset
614 (setq hr 0)))
92654
71481bc91b5a Formatting changes only.
Glenn Morris <rgm@gnu.org>
parents: 92577
diff changeset
615 ;; Convert the actual time into minutes.
65840
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
616 (+ (* hr 60) min)))
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
617
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
618 (defun appt-update-list ()
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
619 "If the current buffer is visiting the diary, update appointments.
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
620 This function is intended for use with `write-file-functions'."
54535
f5c18c1f02ce (appt-check): Remove superfluous progn.
Glenn Morris <rgm@gnu.org>
parents: 54070
diff changeset
621 (and (string-equal buffer-file-name (expand-file-name diary-file))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
622 appt-timer
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
623 (let ((appt-display-diary nil))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
624 (appt-check t)))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
625 nil)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
626
63614
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
627 ;; In Emacs-21.3, the manual documented the following procedure to
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
628 ;; activate this package:
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
629 ;; (display-time)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
630 ;; (add-hook 'diary-hook 'appt-make-list)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
631 ;; (diary 0)
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
632 ;; The display-time call was not necessary, AFAICS.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
633 ;; What was really needed was to add the hook and load this file.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
634 ;; Calling (diary 0) once the hook had been added was in some sense a
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
635 ;; roundabout way of loading this file. This file used to have code at
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
636 ;; the top-level that set up the appt-timer and global-mode-string.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
637 ;; One way to maintain backwards compatibility would be to call
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
638 ;; (appt-activate 1) at top-level. However, this goes against the
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
639 ;; convention that just loading an Emacs package should not activate
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
640 ;; it. Instead, we make appt-make-list activate the package (after a
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
641 ;; suggestion from rms). This means that one has to call diary in
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
642 ;; order to get it to work, but that is in line with the old (weird,
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
643 ;; IMO) documented behavior for activating the package.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
644 ;; Actually, since (diary 0) does not run diary-hook, I don't think
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
645 ;; the documented behavior in Emacs-21.3 would ever have worked.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
646 ;; Oh well, at least with the changes to appt-make-list it will now
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
647 ;; work as well as it ever did.
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
648 ;; The new method is just to use (appt-activate 1).
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
649 ;; -- gmorris
6533273f3b46 (appt-make-list): Activate the package, if not already active (for
Glenn Morris <rgm@gnu.org>
parents: 62402
diff changeset
650
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
651 ;;;###autoload
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
652 (defun appt-activate (&optional arg)
93532
54d9e787a82a Whitespace only.
Glenn Morris <rgm@gnu.org>
parents: 93530
diff changeset
653 "Toggle checking of appointments.
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
654 With optional numeric argument ARG, turn appointment checking on if
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
655 ARG is positive, otherwise off."
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
656 (interactive "P")
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
657 (let ((appt-active appt-timer))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
658 (setq appt-active (if arg (> (prefix-numeric-value arg) 0)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
659 (not appt-active)))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
660 (remove-hook 'write-file-functions 'appt-update-list)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
661 (or global-mode-string (setq global-mode-string '("")))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
662 (delq 'appt-mode-string global-mode-string)
54070
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
663 (when appt-timer
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
664 (cancel-timer appt-timer)
e3c36780d566 (appt-display-format): Change default to'ignore, for backwards compatability.
Glenn Morris <rgm@gnu.org>
parents: 53643
diff changeset
665 (setq appt-timer nil))
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
666 (when appt-active
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
667 (add-hook 'write-file-functions 'appt-update-list)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
668 (setq appt-timer (run-at-time t 60 'appt-check)
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
669 global-mode-string
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
670 (append global-mode-string '(appt-mode-string)))
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
671 (appt-check t))))
23112
81052242dbce (appt-mode-string): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 17624
diff changeset
672
53556
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
673
68254590be55 Update copyright and commentary.
Glenn Morris <rgm@gnu.org>
parents: 53549
diff changeset
674 (provide 'appt)
179
b88e2c9f0f5b Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
675
65840
df9b548f3218 (appt-time-regexp): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64085
diff changeset
676 ;; arch-tag: bf5791c4-8921-499e-a26f-772b1788d347
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 179
diff changeset
677 ;;; appt.el ends here