diff options
| -rw-r--r-- | src/device-provider.c | 81 | ||||
| -rw-r--r-- | src/device-provider.h | 80 |
2 files changed, 161 insertions, 0 deletions
diff --git a/src/device-provider.c b/src/device-provider.c new file mode 100644 index 0000000..361ab3c --- /dev/null +++ b/src/device-provider.c @@ -0,0 +1,81 @@ +/* + * Copyright 2013 Canonical Ltd. + * + * Authors: + * Charles Kerr <charles.kerr@canonical.com> + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 3, as published + * by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranties of + * MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>. + */ + +#include "device-provider.h" + +enum +{ + SIGNAL_DEVICES_CHANGED, + SIGNAL_LAST +}; + +static guint signals[SIGNAL_LAST] = { 0 }; + +G_DEFINE_INTERFACE (IndicatorPowerDeviceProvider, + indicator_power_device_provider, + 0); + +static void +indicator_power_device_provider_default_init (IndicatorPowerDeviceProviderInterface * klass) +{ + signals[SIGNAL_DEVICES_CHANGED] = g_signal_new ( + "devices-changed", + G_TYPE_FROM_CLASS(klass), + G_SIGNAL_RUN_LAST, + G_STRUCT_OFFSET (IndicatorPowerDeviceProviderInterface, devices_changed), + NULL, NULL, + g_cclosure_marshal_VOID__VOID, + G_TYPE_NONE, 0); +} + +/*** +**** PUBLIC API +***/ + +/** + * Get a list of devices + * + * An easy way to free the list properly in one step is as follows: + * + * g_slist_free_full (list, (GDestroyNotify)g_object_unref); + * + * Return value: (element-type IndicatorPowerDevice) + * (transfer full): + * list of devices + */ +GList * +indicator_power_device_provider_get_devices (IndicatorPowerDeviceProvider * self) +{ + g_return_if_fail (INDICATOR_IS_POWER_DEVICE_PROVIDER (self)); + + return INDICATOR_POWER_DEVICE_PROVIDER_GET_INTERFACE (self)->get_devices (self); +} + +/** + * Emits the "devices-changed" signal. + * + * This should only be called by subclasses. + */ +void +indicator_power_device_provider_emit_devices_changed (IndicatorPowerDeviceProvider * self) +{ + g_return_if_fail (INDICATOR_IS_POWER_DEVICE_PROVIDER (self)); + + g_signal_emit (self, signals[SIGNAL_DEVICES_CHANGED], 0, NULL); +} diff --git a/src/device-provider.h b/src/device-provider.h new file mode 100644 index 0000000..edef6f2 --- /dev/null +++ b/src/device-provider.h @@ -0,0 +1,80 @@ +/* + * Copyright 2013 Canonical Ltd. + * + * Authors: + * Charles Kerr <charles.kerr@canonical.com> + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 3, as published + * by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranties of + * MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>. + */ + +#ifndef __INDICATOR_POWER_DEVICE_PROVIDER__H__ +#define __INDICATOR_POWER_DEVICE_PROVIDER__H__ + +#include <glib-object.h> + +G_BEGIN_DECLS + +#define INDICATOR_TYPE_POWER_DEVICE_PROVIDER \ + (indicator_power_device_provider_get_type ()) + +#define INDICATOR_POWER_DEVICE_PROVIDER(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST ((obj), \ + INDICATOR_TYPE_POWER_DEVICE_PROVIDER, \ + IndicatorPowerDeviceProvider)) + +#define INDICATOR_IS_POWER_DEVICE_PROVIDER(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE ((obj), INDICATOR_TYPE_POWER_DEVICE_PROVIDER)) + +#define INDICATOR_POWER_DEVICE_PROVIDER_GET_INTERFACE(inst) \ + (G_TYPE_INSTANCE_GET_INTERFACE ((inst), \ + INDICATOR_TYPE_POWER_DEVICE_PROVIDER, \ + IndicatorPowerDeviceProviderInterface)) + +typedef struct _IndicatorPowerDeviceProvider + IndicatorPowerDeviceProvider; + +typedef struct _IndicatorPowerDeviceProviderInterface + IndicatorPowerDeviceProviderInterface; + +/** + * An interface class for an object that provides IndicatorPowerDevices. + * + * Example uses: + * - in unit tests, a mock that feeds fake devices to the service + * - in production, an implementation that monitors upower + * - in the future, upower can be replaced by changing providers + */ +struct _IndicatorPowerDeviceProviderInterface +{ + GTypeInterface parent_iface; + + /* signals */ + void (*devices_changed) (IndicatorPowerDeviceProvider * self); + + /* virtual functions */ + GList* (*get_devices) (IndicatorPowerDeviceProvider * self); +}; + +GType indicator_power_device_provider_get_type (void); + +/*** +**** +***/ + +GList * indicator_power_device_provider_get_devices (IndicatorPowerDeviceProvider * self); + +void indicator_power_device_provider_emit_devices_changed (IndicatorPowerDeviceProvider * self); + +G_END_DECLS + +#endif /* __INDICATOR_POWER_DEVICE_PROVIDER__H__ */ |