Create a little stand-alone library for the low-level alarm trigger

2001-02-26  Federico Mena Quintero  <federico@ximian.com>

	* gui/alarm-notify/Makefile.am (libalarm_a_SOURCES): Create a
	little stand-alone library for the low-level alarm trigger
	mechanism.  This is so that the GUI parts of the calendar can use
	it in addition to the alarm daemon.

	* gui/main.c: #include "alarm-notify/alarm.h".

	* gui/calendar-summary.c: Likewise.
	(alarm_fn): Do not remove the previous alarm; it is removed
	automatically when it is triggered.

	* gui/Makefile.am (evolution_calendar_SOURCES): Removed alarm.[ch]
	from the sources.

	* gui/alarm.[ch]: Removed obsolete files.

svn path=/trunk/; revision=8394

6 files changed, 13 insertions, 413 deletions

diff --git a/calendar/gui/Makefile.am b/calendar/gui/Makefile.am
index d6b7e6edea..bf3a7f200e 100644
--- a/calendar/gui/Makefile.am
+++ b/calendar/gui/Makefile.am
@@ -14,7 +14,6 @@ $(IDL_GENERATED): $(IDLS)
                 $(srcdir)/../../composer/Evolution-Composer.idl
 
 SUBDIRS = alarm-notify dialogs
-#SUBDIRS = dialogs
 
 help_base = $(datadir)/gnome/help/cal
 
@@ -47,8 +46,6 @@ glade_DATA = 					\
 
 evolution_calendar_SOURCES =			\
 	$(IDL_GENERATED)			\
-	alarm.c					\
-	alarm.h					\
 	calendar-config.c			\
 	calendar-config.h			\
 	calendar-commands.c			\
@@ -114,6 +111,7 @@ evolution_calendar_SOURCES =			\
 	widget-util.h
 
 evolution_calendar_LDADD =								\
+	alarm-notify/libalarm.a								\
 	$(top_builddir)/shell/libeshell.a						\
 	$(top_builddir)/calendar/cal-client/libcal-client.la				\
 	$(top_builddir)/calendar/cal-util/libcal-util.la				\
diff --git a/calendar/gui/alarm-notify/Makefile.am b/calendar/gui/alarm-notify/Makefile.am
index 3201f062f6..4a1ace63ad 100644
--- a/calendar/gui/alarm-notify/Makefile.am
+++ b/calendar/gui/alarm-notify/Makefile.am
@@ -13,6 +13,12 @@ $(CORBA_GENERATED): $(idls)
 
 bin_PROGRAMS = evolution-alarm-notify
 
+noinst_LIBRARIES = libalarm.a
+
+libalarm_a_SOURCES =	\
+	alarm.c		\
+	alarm.h
+
 INCLUDES = 						\
 	-DG_LOG_DOMAIN=\"evolution-alarm-notify\"	\
 	-I$(top_srcdir)					\
@@ -30,8 +36,6 @@ INCLUDES = 						\
 gladedir   = $(datadir)/evolution/glade
 
 evolution_alarm_notify_SOURCES =	\
-	alarm.c				\
-	alarm.h				\
 	alarm-notify.c			\
 	alarm-notify.h			\
 	alarm-queue.c			\
@@ -39,6 +43,7 @@ evolution_alarm_notify_SOURCES =	\
 	notify-main.c
 
 evolution_alarm_notify_LDADD =								\
+	libalarm.a									\
 	$(top_builddir)/calendar/cal-client/libcal-client.la				\
 	$(top_builddir)/calendar/cal-util/libcal-util.la				\
 	$(top_builddir)/libical/src/libical/libical.la					\
diff --git a/calendar/gui/alarm.c b/calendar/gui/alarm.c
deleted file mode 100644
index a0fe90f337..0000000000
--- a/calendar/gui/alarm.c
+++ /dev/null
@@ -1,356 +0,0 @@
-/* Evolution calendar - Low-level alarm timer mechanism
- *
- * Copyright (C) 2000 Helix Code, Inc.
- *
- * Authors: Miguel de Icaza <miguel@helixcode.com>
- *          Federico Mena-Quintero <federico@helixcode.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"
-
-
-
-/* Whether the timer system has been initialized */
-static gboolean alarm_inited;
-
-/* The pipes used to notify about an alarm */
-static int alarm_pipes [2];
-
-/* The list of pending alarms */
-static GList *alarms;
-
-/* A queued alarm structure */
-typedef struct {
-	time_t             trigger;
-	AlarmFunction      alarm_fn;
-	gpointer           data;
-	AlarmDestroyNotify destroy_notify_fn;
-} AlarmRecord;
-
-
-
-/* SIGALRM handler.  Notifies the callback about the alarm. */
-static void
-alarm_signal (int arg)
-{
-	char c = 0;
-
-	write (alarm_pipes [1], &c, 1);
-}
-
-/* Sets up an itimer and returns a success code */
-static gboolean
-setup_itimer (time_t diff)
-{
-	struct itimerval itimer;
-	int v;
-
-	itimer.it_interval.tv_sec = 0;
-	itimer.it_interval.tv_usec = 0;
-	itimer.it_value.tv_sec = diff;
-	itimer.it_value.tv_usec = 0;
-
-	v = setitimer (ITIMER_REAL, &itimer, NULL);
-
-	return (v == 0) ? TRUE : FALSE;
-}
-
-/* Clears the itimer we have pending */
-static gboolean
-clear_itimer (void)
-{
-	return setup_itimer (0);
-}
-
-/* Removes the head alarm, returns it, and schedules the next alarm in the
- * queue.
- */
-static AlarmRecord *
-pop_alarm (void)
-{
-	AlarmRecord *ar;
-	GList *l;
-
-	if (!alarms)
-		return NULL;
-
-	ar = alarms->data;
-
-	l = alarms;
-	alarms = g_list_remove_link (alarms, l);
-	g_list_free_1 (l);
-
-	if (alarms) {
-		time_t now;
-		AlarmRecord *new_ar;
-
-		now = time (NULL);
-		new_ar = alarms->data;
-
-		if (!setup_itimer (new_ar->trigger - now)) {
-			g_message ("pop_alarm(): Could not reset the timer!  "
-				   "Weird things will happen.");
-
-			/* FIXME: should we free the alarm list?  What
-			 * about further alarm removal requests that
-			 * will fail?
-			 */
-		}
-	} else
-		if (!clear_itimer ())
-			g_message ("pop_alarm(): Could not clear the timer!  "
-				   "Weird things may happen.");
-
-	return ar;
-}
-
-/* Input handler for our own alarm notification pipe */
-static void
-alarm_ready (gpointer data, gint fd, GdkInputCondition cond)
-{
-	AlarmRecord *ar;
-	char c;
-
-	if (read (alarm_pipes [0], &c, 1) != 1) {
-		g_message ("alarm_ready(): Uh?  Could not read from notification pipe.");
-		return;
-	}
-
-	g_assert (alarms != NULL);
-	ar = pop_alarm ();
-
-	g_print ("alarm_ready(): Notifying about alarm on %s\n", ctime (&ar->trigger));
-
-	(* ar->alarm_fn) (ar, ar->trigger, ar->data);
-
-	if (ar->destroy_notify_fn)
-		(* ar->destroy_notify_fn) (ar, ar->data);
-
-	g_free (ar);
-}
-
-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 gboolean
-queue_alarm (time_t now, AlarmRecord *ar)
-{
-	time_t diff;
-	AlarmRecord *old_head;
-
-	if (alarms)
-		old_head = alarms->data;
-	else
-		old_head = NULL;
-
-	alarms = g_list_insert_sorted (alarms, ar, compare_alarm_by_time);
-
-	if (old_head == alarms->data)
-		return TRUE;
-
-	/* Set the timer for removal upon activation */
-
-	diff = ar->trigger - now;
-	if (!setup_itimer (diff)) {
-		GList *l;
-
-		g_message ("queue_alarm(): Could not set up timer!  Not queueing alarm.");
-
-		l = g_list_find (alarms, ar);
-		g_assert (l != NULL);
-
-		alarms = g_list_remove_link (alarms, l);
-		g_list_free_1 (l);
-		return FALSE;
-	}
-
-	return TRUE;
-}
-
-/**
- * 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)
-{
-	time_t now;
-	AlarmRecord *ar;
-
-	g_return_val_if_fail (alarm_inited, NULL);
-	g_return_val_if_fail (trigger != -1, NULL);
-	g_return_val_if_fail (alarm_fn != NULL, NULL);
-
-	now = time (NULL);
-	if (trigger < now)
-		return NULL;
-
-	ar = g_new (AlarmRecord, 1);
-	ar->trigger = trigger;
-	ar->alarm_fn = alarm_fn;
-	ar->data = data;
-	ar->destroy_notify_fn = destroy_notify_fn;
-
-	g_print ("alarm_add(): Adding alarm for %s\n", ctime (&trigger));
-
-	if (!queue_alarm (now, ar)) {
-		g_free (ar);
-		ar = NULL;
-	}
-
-	return ar;
-}
-
-/**
- * alarm_remove:
- * @alarm: A queued alarm identifier.
- * 
- * Removes an alarm from the alarm queue.
- **/
-void
-alarm_remove (gpointer alarm)
-{
-	AlarmRecord *ar;
-	AlarmRecord *old_head;
-	GList *l;
-
-	g_return_if_fail (alarm_inited);
-	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;
-
-	if (old_head == ar)
-		pop_alarm ();
-	else {
-		alarms = g_list_remove_link (alarms, l);
-		g_list_free_1 (l);
-	}
-
-	if (ar->destroy_notify_fn)
-		(* ar->destroy_notify_fn) (ar, ar->data);
-
-	g_free (ar);
-}
-
-/**
- * alarm_init:
- *
- * Initializes the alarm timer mechanism.  This must be called near the
- * beginning of the program.
- **/
-void
-alarm_init (void)
-{
-	struct sigaction sa;
-	int flags;
-
-	g_return_if_fail (alarm_inited == FALSE);
-
-	pipe (alarm_pipes);
-
-	/* set non blocking mode */
-	flags = 0;
-	fcntl (alarm_pipes [0], F_GETFL, &flags);
-	fcntl (alarm_pipes [0], F_SETFL, flags | O_NONBLOCK);
-	gdk_input_add (alarm_pipes [0], GDK_INPUT_READ, alarm_ready, NULL);
-
-	/* Setup the signal handler */
-	sa.sa_handler = alarm_signal;
-	sigemptyset (&sa.sa_mask);
-	sa.sa_flags = SA_RESTART;
-	sigaction (SIGALRM, &sa, NULL);
-
-	alarm_inited = TRUE;
-}
-
-/**
- * alarm_done:
- * 
- * Terminates the alarm timer mechanism.  This should be called at the end of
- * the program.
- **/
-void
-alarm_done (void)
-{
-	GList *l;
-
-	g_return_if_fail (alarm_inited);
-
-	if (!clear_itimer ())
-		g_message ("alarm_done(): Could not clear the timer!  "
-			   "Weird things may happen.");
-
-	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;
-
-	if (close (alarm_pipes[0]) != 0)
-		g_message ("alarm_done(): Could not close the input pipe for notification");
-
-	alarm_pipes[0] = -1;
-
-	if (close (alarm_pipes[1]) != 0)
-		g_message ("alarm_done(): Could not close the output pipe for notification");
-
-	alarm_pipes[1] = -1;
-
-	alarm_inited = FALSE;
-}
diff --git a/calendar/gui/alarm.h b/calendar/gui/alarm.h
deleted file mode 100644
index afa79edfd8..0000000000
--- a/calendar/gui/alarm.h
+++ /dev/null
@@ -1,43 +0,0 @@
-/* Evolution calendar - Low-level alarm timer mechanism
- *
- * Copyright (C) 2000 Helix Code, Inc.
- *
- * Authors: Miguel de Icaza <miguel@helixcode.com>
- *          Federico Mena-Quintero <federico@helixcode.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.
- */
-
-#ifndef ALARM_H
-#define ALARM_H
-
-#include <time.h>
-#include <glib.h>
-
-
-
-typedef void (* AlarmFunction) (gpointer alarm_id, time_t trigger, gpointer data);
-typedef void (* AlarmDestroyNotify) (gpointer alarm_id, gpointer data);
-
-void alarm_init (void);
-void alarm_done (void);
-
-gpointer alarm_add (time_t trigger, AlarmFunction alarm_fn, gpointer data,
-		    AlarmDestroyNotify destroy_notify_fn);
-void alarm_remove (gpointer alarm);
-
-
-
-#endif
diff --git a/calendar/gui/calendar-summary.c b/calendar/gui/calendar-summary.c
index 0d0c404769..163d56f524 100644
--- a/calendar/gui/calendar-summary.c
+++ b/calendar/gui/calendar-summary.c
@@ -39,11 +39,10 @@
 #include <gnome-xml/parser.h>
 #include <gnome-xml/xmlmemory.h>
 
-#include "cal-util/cal-component.h"
-#include "cal-util/timeutil.h"
-#include "alarm.h"
+#include <cal-util/cal-component.h>
+#include <cal-util/timeutil.h>
+#include "alarm-notify/alarm.h"
 #include "calendar-model.h"
-
 #include "calendar-summary.h"
 
 typedef struct {
@@ -457,7 +456,7 @@ cal_opened_cb (CalClient *client,
 
 static void
 alarm_fn (gpointer alarm_id,
-	  time_t old_t,
+	  time_t trigger,
 	  gpointer data)
 {
 	CalSummary *summary;
@@ -465,9 +464,6 @@ alarm_fn (gpointer alarm_id,
 
 	summary = data;
 
-	/* Remove the old alarm, and start a new one for the next midnight */
-	alarm_remove (alarm_id);
-
 	t = time (NULL);
 	day_end = time_day_end (t);
 	summary->alarm = alarm_add (day_end, alarm_fn, summary, NULL);
diff --git a/calendar/gui/main.c b/calendar/gui/main.c
index dccf4c4af0..2060934fa2 100644
--- a/calendar/gui/main.c
+++ b/calendar/gui/main.c
@@ -33,7 +33,7 @@
 
 #include <gal/widgets/e-cursors.h>
 
-#include "alarm.h"
+#include "alarm-notify/alarm.h"
 #include "calendar-commands.h"
 #include "calendar-config.h"
 #include "component-factory.h"