aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/gui/alarm-notify/alarm.c
blob: f750ed515c92783764335cab17ab29fe84953734 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
/* Evolution calendar - Low-level alarm timer mechanism
 *
 * Copyright (C) 2000 Ximian, Inc.
 * Copyright (C) 2000 Ximian, Inc.
 *
 * Authors: Miguel de Icaza <miguel@ximian.com>
 *          Federico Mena-Quintero <federico@ximian.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

#include <config.h>
#include <unistd.h>
#include <time.h>
#include <fcntl.h>
#include <signal.h>
#include <sys/time.h>
#include <gdk/gdk.h>
#include "alarm.h"



/* Our glib timeout */
static guint timeout_id;

/* The list of pending alarms */
static GList *alarms = NULL;

/* A queued alarm structure */
typedef struct {
    time_t             trigger;
    AlarmFunction      alarm_fn;
    gpointer           data;
    AlarmDestroyNotify destroy_notify_fn;
} AlarmRecord;

static void setup_timeout (time_t now);



/* Removes the head alarm from the queue.  Does not touch the timeout_id. */
static void
pop_alarm (void)
{
    AlarmRecord *ar;
    GList *l;

    g_assert (alarms != NULL);

    ar = alarms->data;

    l = alarms;
    alarms = g_list_remove_link (alarms, l);
    g_list_free_1 (l);

    g_free (ar);
}

/* Callback from the alarm timeout */
static gboolean
alarm_ready_cb (gpointer data)
{
    time_t now;

    g_assert (alarms != NULL);
    timeout_id = 0;

    now = time (NULL);

    while (alarms) {
        AlarmRecord *notify_id, *ar;
        AlarmRecord ar_copy;

        ar = alarms->data;

        if (ar->trigger > now)
            break;

        notify_id = ar;

        ar_copy = *ar;
        ar = &ar_copy;

        pop_alarm (); /* This will free the original AlarmRecord; that's why we copy it */

        (* ar->alarm_fn) (notify_id, ar->trigger, ar->data);

        if (ar->destroy_notify_fn)
            (* ar->destroy_notify_fn) (notify_id, ar->data);
    }

    if (alarms) {
        /* We need this check because one of the alarm_fn above may have
         * re-entered and added an alarm of its own, so the timer will
         * already be set up.
         */
        if (timeout_id == 0)
            setup_timeout (now);
    } else
        g_assert (timeout_id == 0);

    return FALSE;
}

/* Sets up a timeout for the next minute */
static void
setup_timeout (time_t now)
{
    time_t next, diff;
    struct tm tm;

    g_assert (timeout_id == 0);
    g_assert (alarms != NULL);

    tm = *localtime (&now);
    tm.tm_sec = 0;
    tm.tm_min++; /* next minute */

    next = mktime (&tm);
    g_assert (next != -1);

    diff = next - now;

    g_assert (diff >= 0);
    timeout_id = g_timeout_add (diff * 1000, alarm_ready_cb, NULL);
}

/* Used from g_list_insert_sorted(); compares the trigger times of two AlarmRecord structures. */
static int
compare_alarm_by_time (gconstpointer a, gconstpointer b)
{
    const AlarmRecord *ara = a;
    const AlarmRecord *arb = b;
    time_t diff;

    diff = ara->trigger - arb->trigger;
    return (diff < 0) ? -1 : (diff > 0) ? 1 : 0;
}

/* Adds an alarm to the queue and sets up the timer */
static void
queue_alarm (AlarmRecord *ar)
{
    time_t now;
    AlarmRecord *old_head;

    if (alarms) {
        g_assert (timeout_id != 0);

        old_head = alarms->data;
    } else {
        g_assert (timeout_id == 0);

        old_head = NULL;
    }

    alarms = g_list_insert_sorted (alarms, ar, compare_alarm_by_time);

    if (old_head == alarms->data)
        return;

    /* Set the timer for removal upon activation */

    if (!old_head) {
        now = time (NULL);
        setup_timeout (now);
    }
}



/**
 * alarm_add:
 * @trigger: Time at which alarm will trigger.
 * @alarm_fn: Callback for trigger.
 * @data: Closure data for callback.
 *
 * Adds an alarm to trigger at the specified time.  The @alarm_fn will be called
 * with the provided data and the alarm will be removed from the trigger list.
 *
 * Return value: An identifier for this alarm; it can be used to remove the
 * alarm later with alarm_remove().  If the trigger time occurs in the past, then
 * the alarm will not be queued and the function will return NULL.
 **/
gpointer
alarm_add (time_t trigger, AlarmFunction alarm_fn, gpointer data,
       AlarmDestroyNotify destroy_notify_fn)
{
    AlarmRecord *ar;

    g_return_val_if_fail (trigger != -1, NULL);
    g_return_val_if_fail (alarm_fn != NULL, NULL);

    ar = g_new (AlarmRecord, 1);
    ar->trigger = trigger;
    ar->alarm_fn = alarm_fn;
    ar->data = data;
    ar->destroy_notify_fn = destroy_notify_fn;

    queue_alarm (ar);

    return ar;
}

/**
 * alarm_remove:
 * @alarm: A queued alarm identifier.
 * 
 * Removes an alarm from the alarm queue.
 **/
void
alarm_remove (gpointer alarm)
{
    AlarmRecord *notify_id, *ar;
    AlarmRecord ar_copy;
    AlarmRecord *old_head;
    GList *l;

    g_return_if_fail (alarm != NULL);

    ar = alarm;

    l = g_list_find (alarms, ar);
    if (!l) {
        g_message ("alarm_remove(): Requested removal of nonexistent alarm!");
        return;
    }

    old_head = alarms->data;

    notify_id = ar;

    if (old_head == ar) {
        ar_copy = *ar;
        ar = &ar_copy;
        pop_alarm (); /* This will free the original AlarmRecord; that's why we copy it */
    } else {
        alarms = g_list_remove_link (alarms, l);
        g_list_free_1 (l);
    }

    /* Reset the timeout */

    g_assert (timeout_id != 0);

    if (!alarms) {
        g_source_remove (timeout_id);
        timeout_id = 0;
    }

    /* Notify about destructiono of the alarm */

    if (ar->destroy_notify_fn)
        (* ar->destroy_notify_fn) (notify_id, ar->data);

}

/**
 * alarm_done:
 * 
 * Terminates the alarm timer mechanism.  This should be called at the end of
 * the program.
 **/
void
alarm_done (void)
{
    GList *l;

    if (timeout_id == 0) {
        g_assert (alarms == NULL);
        return;
    }

    g_assert (alarms != NULL);

    g_source_remove (timeout_id);
    timeout_id = 0;

    for (l = alarms; l; l = l->next) {
        AlarmRecord *ar;

        ar = l->data;

        if (ar->destroy_notify_fn)
            (* ar->destroy_notify_fn) (ar, ar->data);

        g_free (ar);
    }

    g_list_free (alarms);
    alarms = NULL;
}