git.maemo.org Git - modest/blob - src/modest-dimming-rules-group.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #include "modest-dimming-rules-group.h"
  31 #include "modest-dimming-rules-group-priv.h"
  32 #include "modest-dimming-rule.h"
  33 #include "modest-platform.h"
  34 #include "modest-ui-dimming-rules.h"
  35
  36 static void modest_dimming_rules_group_class_init (ModestDimmingRulesGroupClass *klass);
  37 static void modest_dimming_rules_group_init       (ModestDimmingRulesGroup *obj);
  38 static void modest_dimming_rules_group_finalize   (GObject *obj);
  39
  40 static void _insensitive_press_callback (GtkWidget *widget, gpointer user_data);
  41
  42 static void _add_rule (ModestDimmingRulesGroup *self,
  43                        ModestDimmingRule *rule,
  44                        ModestWindow *window);
  45
  46 typedef struct _ModestDimmingRulesGroupPrivate ModestDimmingRulesGroupPrivate;
  47 struct _ModestDimmingRulesGroupPrivate {
  48         ModestWindow *window;
  49         gchar *name;
  50         gboolean notifications_enabled;
  51         GHashTable *rules_map;
  52         GSList *widget_rules;
  53 };
  54
  55
  56 #define MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  57                                                    MODEST_TYPE_DIMMING_RULES_GROUP, \
  58                                                    ModestDimmingRulesGroupPrivate))
  59
  60 /* globals */
  61 static GObjectClass *parent_class = NULL;
  62
  63 static void _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data);
  64 static void _execute_widget_dimming_rule (gpointer data, gpointer user_data);
  65 static void _insensitive_press_callback (GtkWidget *widget, gpointer user_data);
  66
  67
  68
  69 GType
  70 modest_dimming_rules_group_get_type (void)
  71 {
  72         static GType my_type = 0;
  73         if (!my_type) {
  74                 static const GTypeInfo my_info = {
  75                         sizeof(ModestDimmingRulesGroupClass),
  76                         NULL,           /* base init */
  77                         NULL,           /* base finalize */
  78                         (GClassInitFunc) modest_dimming_rules_group_class_init,
  79                         NULL,           /* class finalize */
  80                         NULL,           /* class data */
  81                         sizeof(ModestDimmingRulesGroup),
  82                         1,              /* n_preallocs */
  83                         (GInstanceInitFunc) modest_dimming_rules_group_init,
  84                         NULL
  85                 };
  86                 my_type = g_type_register_static (G_TYPE_OBJECT,
  87                                                   "ModestDimmingRulesGroup",
  88                                                   &my_info, 0);
  89         }
  90         return my_type;
  91 }
  92
  93 static void
  94 modest_dimming_rules_group_class_init (ModestDimmingRulesGroupClass *klass)
  95 {
  96         GObjectClass *gobject_class;
  97         gobject_class = (GObjectClass*) klass;
  98
  99         parent_class            = g_type_class_peek_parent (klass);
 100         gobject_class->finalize = modest_dimming_rules_group_finalize;
 101
 102         g_type_class_add_private (gobject_class, sizeof(ModestDimmingRulesGroupPrivate));
 103 }
 104
 105 static void
 106 modest_dimming_rules_group_init (ModestDimmingRulesGroup *obj)
 107 {
 108         ModestDimmingRulesGroupPrivate *priv;
 109
 110         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 111
 112         priv->name = NULL;
 113         priv->window = NULL;
 114         priv->notifications_enabled = FALSE;
 115         priv->rules_map = g_hash_table_new_full ((GHashFunc) g_str_hash,
 116                                                  (GEqualFunc) g_str_equal,
 117                                                  (GDestroyNotify) g_free,
 118                                                  (GDestroyNotify) g_object_unref);
 119         priv->widget_rules = NULL;
 120 }
 121
 122 static void
 123 modest_dimming_rules_group_finalize (GObject *obj)
 124 {
 125         ModestDimmingRulesGroupPrivate *priv;
 126
 127         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 128
 129         if (priv->name != NULL)
 130                 g_free(priv->name);
 131
 132         if (priv->rules_map != NULL)
 133                 g_hash_table_destroy (priv->rules_map);
 134
 135         if (priv->widget_rules != NULL)
 136                 g_slist_foreach (priv->widget_rules, (GFunc) g_object_unref, NULL);
 137
 138         G_OBJECT_CLASS(parent_class)->finalize (obj);
 139 }
 140
 141
 142 ModestDimmingRulesGroup*
 143 modest_dimming_rules_group_new(const gchar *group_name,
 144                                gboolean notifications_enabled)
 145 {
 146         ModestDimmingRulesGroup *obj;
 147         ModestDimmingRulesGroupPrivate *priv;
 148
 149         g_return_val_if_fail (group_name != NULL, NULL);
 150
 151         obj = MODEST_DIMMING_RULES_GROUP(g_object_new(MODEST_TYPE_DIMMING_RULES_GROUP, NULL));
 152
 153         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 154         priv->name = g_strdup(group_name);
 155         priv->notifications_enabled = notifications_enabled;
 156
 157         return obj;
 158 }
 159
 160
 161 gchar *
 162 modest_dimming_rules_group_get_name (ModestDimmingRulesGroup *self)
 163 {
 164         ModestDimmingRulesGroupPrivate *priv;
 165
 166         g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), NULL);
 167
 168         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 169
 170         return g_strdup (priv->name);
 171 }
 172
 173 static void
 174 _add_rule (ModestDimmingRulesGroup *self,
 175            ModestDimmingRule *rule,
 176            ModestWindow *window)
 177 {
 178         ModestDimmingRulesGroupPrivate *priv;
 179         GtkWidget *widget = NULL;
 180         const gchar *action_path = NULL;
 181
 182         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 183         g_return_if_fail (MODEST_IS_WINDOW(window));
 184         g_return_if_fail (MODEST_IS_DIMMING_RULE (rule));
 185
 186         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 187
 188         /* Set window to process dimming rules */
 189         priv->window = MODEST_WINDOW (window);
 190
 191         widget = modest_dimming_rule_get_widget (rule);
 192         /* Connect insensitive-presss handler to show notifications */
 193         g_signal_connect (G_OBJECT (widget), "insensitive-press",
 194                           G_CALLBACK (_insensitive_press_callback),
 195                           rule);
 196
 197         /* Register new dimming rule */
 198         modest_dimming_rule_set_group (rule, self);
 199         action_path = modest_dimming_rule_get_action_path (rule);
 200         if (action_path)
 201                 g_hash_table_insert (priv->rules_map, g_strdup(action_path), rule);
 202         else
 203                 priv->widget_rules = g_slist_prepend (priv->widget_rules, rule);
 204 }
 205
 206 void
 207 modest_dimming_rules_group_add_widget_rule (ModestDimmingRulesGroup *self,
 208                                             GtkWidget *widget,
 209                                             GCallback callback,
 210                                             ModestWindow *window)
 211 {
 212         ModestDimmingRulesGroupPrivate *priv;
 213         ModestDimmingRule *dim_rule = NULL;
 214
 215         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 216         g_return_if_fail (GTK_IS_WIDGET (widget));
 217         g_return_if_fail (MODEST_IS_WINDOW(window));
 218
 219         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 220
 221         /* Set window to process dimming rules */
 222         priv->window = MODEST_WINDOW (window);
 223
 224         dim_rule = modest_dimming_rule_new_from_widget (priv->window,
 225                                                         (ModestDimmingCallback) callback,
 226                                                         widget);
 227
 228         _add_rule (self, dim_rule, window);
 229 }
 230
 231 void
 232 modest_dimming_rules_group_add_rules (ModestDimmingRulesGroup *self,
 233                                       const ModestDimmingEntry modest_dimming_entries[],
 234                                       guint n_elements,
 235                                       ModestWindow *window)
 236 {
 237         ModestDimmingRulesGroupPrivate *priv;
 238         ModestDimmingRule *dim_rule = NULL;
 239         ModestDimmingEntry entry;
 240         GtkWidget *widget = NULL;
 241         gboolean unique = FALSE;
 242         guint i;
 243
 244         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 245         g_return_if_fail (modest_dimming_entries != NULL);
 246         g_return_if_fail (n_elements > 0);
 247         g_return_if_fail (MODEST_IS_WINDOW(window));
 248
 249         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 250
 251         /* Set window to process dimming rules */
 252         priv->window = MODEST_WINDOW (window);
 253
 254         /* Add dimming rules */
 255         for (i=0; i < n_elements; i++) {
 256                 entry = modest_dimming_entries[i];
 257
 258                 /* Check dimming_rule and action path are NOT NULL */
 259                 if (entry.action_path == NULL) continue;
 260                 if (entry.callback == NULL) continue;
 261
 262                 /* Check action path is unique */
 263                 unique = g_hash_table_lookup (priv->rules_map, entry.action_path) == NULL;
 264                 if (!unique) continue;
 265
 266                 /* Check action path is valid */
 267                 widget = modest_window_get_action_widget (MODEST_WINDOW (window), entry.action_path);
 268                 if (widget == NULL) continue;
 269
 270                 /* Create a new dimming rule */
 271                 dim_rule = modest_dimming_rule_new (priv->window,
 272                                                     (ModestDimmingCallback) entry.callback,
 273                                                     entry.action_path);
 274
 275                 _add_rule (self, dim_rule, window);
 276         }
 277 }
 278
 279 gboolean
 280 modest_dimming_rules_group_notifications_enabled (ModestDimmingRulesGroup *self)
 281 {
 282         ModestDimmingRulesGroupPrivate *priv;
 283
 284         g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), FALSE);
 285         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 286
 287         return priv->notifications_enabled;
 288 }
 289
 290 void
 291 modest_dimming_rules_group_execute (ModestDimmingRulesGroup *self)
 292 {
 293         ModestDimmingRulesGroupPrivate *priv;
 294         DimmedState *state = NULL;
 295
 296         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 297         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 298
 299         /* Init dimming rules init data */
 300         state = modest_ui_dimming_rules_define_dimming_state (priv->window);
 301         modest_window_set_dimming_state (priv->window, state);
 302
 303         /* execute group dimming rules */
 304         g_hash_table_foreach (priv->rules_map, _execute_dimming_rule, NULL);
 305         g_slist_foreach (priv->widget_rules, (GFunc) _execute_widget_dimming_rule, NULL);
 306
 307         /* Free dimming ruls init data */
 308         modest_window_set_dimming_state (priv->window, NULL);
 309 }
 310
 311
 312 static void
 313 _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data)
 314 {
 315         g_return_if_fail (MODEST_IS_DIMMING_RULE (value));
 316
 317         /* Process dimming rule */
 318         modest_dimming_rule_process (MODEST_DIMMING_RULE(value));
 319 }
 320
 321 static void
 322 _execute_widget_dimming_rule (gpointer data, gpointer user_data)
 323 {
 324         g_return_if_fail (MODEST_IS_DIMMING_RULE (data));
 325
 326         /* Process dimming rule */
 327         modest_dimming_rule_process (MODEST_DIMMING_RULE(data));
 328 }
 329
 330 static void
 331 _insensitive_press_callback (GtkWidget *widget, gpointer user_data)
 332 {
 333         ModestDimmingRulesGroup *group = NULL;
 334         ModestDimmingRule *rule = NULL;
 335         gchar *notification = NULL;
 336
 337         g_return_if_fail (MODEST_IS_DIMMING_RULE (user_data));
 338         rule = MODEST_DIMMING_RULE (user_data);
 339
 340         /* Check if this group has notification system enabled */
 341         group = modest_dimming_rule_get_group (rule);
 342         if (!modest_dimming_rules_group_notifications_enabled (group))
 343                 goto frees;
 344
 345         /* Get specific notification */
 346         notification = modest_dimming_rule_get_notification (rule);
 347         if (notification == NULL)
 348                 goto frees;
 349
 350         /* Show notification banner */
 351         modest_platform_information_banner (NULL, NULL, notification);
 352
 353         /* Free */
 354  frees:
 355         if (group != NULL)
 356                 g_object_unref(group);
 357         if (notification != NULL)
 358                 g_free(notification);
 359 }