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 static void modest_dimming_rules_group_dispose    (GObject *obj);
  40
  41 #ifndef MODEST_TOOLKIT_GTK
  42 static void _insensitive_press_callback (GtkWidget *widget, gpointer user_data);
  43 #endif
  44
  45 static void on_window_destroy (gpointer data,
  46                                GObject *object);
  47
  48 static void _add_rule (ModestDimmingRulesGroup *self,
  49                        ModestDimmingRule *rule,
  50                        ModestWindow *window);
  51
  52 typedef struct _ModestDimmingRulesGroupPrivate ModestDimmingRulesGroupPrivate;
  53 struct _ModestDimmingRulesGroupPrivate {
  54         ModestWindow *window;
  55         gchar *name;
  56         gboolean notifications_enabled;
  57         GHashTable *rules_map;
  58         GSList *widget_rules;
  59 };
  60
  61
  62 #define MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  63                                                    MODEST_TYPE_DIMMING_RULES_GROUP, \
  64                                                    ModestDimmingRulesGroupPrivate))
  65
  66 /* globals */
  67 static GObjectClass *parent_class = NULL;
  68
  69 static void _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data);
  70 static void _execute_widget_dimming_rule (gpointer data, gpointer user_data);
  71
  72 GType
  73 modest_dimming_rules_group_get_type (void)
  74 {
  75         static GType my_type = 0;
  76         if (!my_type) {
  77                 static const GTypeInfo my_info = {
  78                         sizeof(ModestDimmingRulesGroupClass),
  79                         NULL,           /* base init */
  80                         NULL,           /* base finalize */
  81                         (GClassInitFunc) modest_dimming_rules_group_class_init,
  82                         NULL,           /* class finalize */
  83                         NULL,           /* class data */
  84                         sizeof(ModestDimmingRulesGroup),
  85                         1,              /* n_preallocs */
  86                         (GInstanceInitFunc) modest_dimming_rules_group_init,
  87                         NULL
  88                 };
  89                 my_type = g_type_register_static (G_TYPE_OBJECT,
  90                                                   "ModestDimmingRulesGroup",
  91                                                   &my_info, 0);
  92         }
  93         return my_type;
  94 }
  95
  96 static void
  97 modest_dimming_rules_group_class_init (ModestDimmingRulesGroupClass *klass)
  98 {
  99         GObjectClass *gobject_class;
 100         gobject_class = (GObjectClass*) klass;
 101
 102         parent_class            = g_type_class_peek_parent (klass);
 103         gobject_class->finalize = modest_dimming_rules_group_finalize;
 104         gobject_class->dispose  = modest_dimming_rules_group_dispose;
 105
 106         g_type_class_add_private (gobject_class, sizeof(ModestDimmingRulesGroupPrivate));
 107 }
 108
 109 static void
 110 modest_dimming_rules_group_init (ModestDimmingRulesGroup *obj)
 111 {
 112         ModestDimmingRulesGroupPrivate *priv;
 113
 114         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 115
 116         priv->name = NULL;
 117         priv->window = NULL;
 118         priv->notifications_enabled = FALSE;
 119         priv->rules_map = g_hash_table_new_full ((GHashFunc) g_str_hash,
 120                                                  (GEqualFunc) g_str_equal,
 121                                                  (GDestroyNotify) g_free,
 122                                                  (GDestroyNotify) g_object_unref);
 123         priv->widget_rules = NULL;
 124 }
 125
 126 static void
 127 modest_dimming_rules_group_finalize (GObject *obj)
 128 {
 129         ModestDimmingRulesGroupPrivate *priv;
 130
 131         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 132
 133         if (priv->window)
 134                 g_object_weak_unref (G_OBJECT (priv->window), on_window_destroy, obj);
 135
 136         G_OBJECT_CLASS(parent_class)->finalize (obj);
 137 }
 138
 139 static void
 140 modest_dimming_rules_group_dispose (GObject *obj)
 141 {
 142         ModestDimmingRulesGroupPrivate *priv;
 143
 144         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 145
 146         if (priv->rules_map != NULL) {
 147                 g_hash_table_destroy (priv->rules_map);
 148                 priv->rules_map = NULL;
 149         }
 150
 151         if (priv->widget_rules != NULL) {
 152                 g_slist_foreach (priv->widget_rules, (GFunc) g_object_unref, NULL);
 153                 priv->widget_rules = NULL;
 154         }
 155
 156         G_OBJECT_CLASS(parent_class)->dispose (obj);
 157 }
 158
 159
 160 ModestDimmingRulesGroup*
 161 modest_dimming_rules_group_new(const gchar *group_name,
 162                                gboolean notifications_enabled)
 163 {
 164         ModestDimmingRulesGroup *obj;
 165         ModestDimmingRulesGroupPrivate *priv;
 166
 167         g_return_val_if_fail (group_name != NULL, NULL);
 168
 169         obj = MODEST_DIMMING_RULES_GROUP(g_object_new(MODEST_TYPE_DIMMING_RULES_GROUP, NULL));
 170
 171         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 172         priv->name = g_strdup(group_name);
 173         priv->notifications_enabled = notifications_enabled;
 174
 175         return obj;
 176 }
 177
 178
 179 gchar *
 180 modest_dimming_rules_group_get_name (ModestDimmingRulesGroup *self)
 181 {
 182         ModestDimmingRulesGroupPrivate *priv;
 183
 184         g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), NULL);
 185
 186         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 187
 188         return g_strdup (priv->name);
 189 }
 190
 191 static void
 192 _add_rule (ModestDimmingRulesGroup *self,
 193            ModestDimmingRule *rule,
 194            ModestWindow *window)
 195 {
 196         ModestDimmingRulesGroupPrivate *priv;
 197         GtkWidget *widget = NULL;
 198         const gchar *action_path = NULL;
 199
 200         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 201         g_return_if_fail (MODEST_IS_WINDOW(window));
 202         g_return_if_fail (MODEST_IS_DIMMING_RULE (rule));
 203
 204         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 205
 206         /* Set window to process dimming rules */
 207         priv->window = MODEST_WINDOW (window);
 208
 209         widget = modest_dimming_rule_get_widget (rule);
 210 #ifndef MODEST_TOOLKIT_GTK
 211         /* Connect insensitive-presss handler to show notifications */
 212         g_signal_connect (G_OBJECT (widget), "insensitive-press",
 213                           G_CALLBACK (_insensitive_press_callback),
 214                           rule);
 215 #endif
 216         /* Register new dimming rule */
 217         modest_dimming_rule_set_group (rule, self);
 218         action_path = modest_dimming_rule_get_action_path (rule);
 219         if (action_path)
 220                 g_hash_table_insert (priv->rules_map, g_strdup(action_path), rule);
 221         else
 222                 priv->widget_rules = g_slist_prepend (priv->widget_rules, rule);
 223 }
 224
 225 void
 226 modest_dimming_rules_group_add_widget_rule (ModestDimmingRulesGroup *self,
 227                                             GtkWidget *widget,
 228                                             GCallback callback,
 229                                             ModestWindow *window)
 230 {
 231         ModestDimmingRulesGroupPrivate *priv;
 232         ModestDimmingRule *dim_rule = NULL;
 233
 234         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 235         g_return_if_fail (GTK_IS_WIDGET (widget));
 236         g_return_if_fail (MODEST_IS_WINDOW(window));
 237
 238         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 239
 240         /* Set window to process dimming rules */
 241         priv->window = MODEST_WINDOW (window);
 242
 243         dim_rule = modest_dimming_rule_new_from_widget (priv->window,
 244                                                         (ModestDimmingCallback) callback,
 245                                                         widget);
 246
 247         _add_rule (self, dim_rule, window);
 248 }
 249
 250 void
 251 modest_dimming_rules_group_add_rules (ModestDimmingRulesGroup *self,
 252                                       const ModestDimmingEntry modest_dimming_entries[],
 253                                       guint n_elements,
 254                                       ModestWindow *window)
 255 {
 256         ModestDimmingRulesGroupPrivate *priv;
 257         ModestDimmingRule *dim_rule = NULL;
 258         ModestDimmingEntry entry;
 259         GtkWidget *widget = NULL;
 260         gboolean unique = FALSE;
 261         guint i;
 262
 263         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 264         g_return_if_fail (modest_dimming_entries != NULL);
 265         g_return_if_fail (n_elements > 0);
 266         g_return_if_fail (MODEST_IS_WINDOW(window));
 267
 268         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 269
 270         /* Set window to process dimming rules */
 271         priv->window = MODEST_WINDOW (window);
 272         g_object_weak_ref (G_OBJECT (window), on_window_destroy, self);
 273
 274         /* Add dimming rules */
 275         for (i=0; i < n_elements; i++) {
 276                 entry = modest_dimming_entries[i];
 277
 278                 /* Check dimming_rule and action path are NOT NULL */
 279                 if (entry.action_path == NULL) continue;
 280                 if (entry.callback == NULL) continue;
 281
 282                 /* Check action path is unique */
 283                 unique = g_hash_table_lookup (priv->rules_map, entry.action_path) == NULL;
 284                 if (!unique) continue;
 285
 286                 /* Check action path is valid */
 287                 widget = modest_window_get_action_widget (MODEST_WINDOW (window), entry.action_path);
 288                 if (widget == NULL) continue;
 289
 290                 /* Create a new dimming rule */
 291                 dim_rule = modest_dimming_rule_new (priv->window,
 292                                                     (ModestDimmingCallback) entry.callback,
 293                                                     entry.action_path);
 294
 295                 _add_rule (self, dim_rule, window);
 296         }
 297 }
 298
 299 gboolean
 300 modest_dimming_rules_group_notifications_enabled (ModestDimmingRulesGroup *self)
 301 {
 302         ModestDimmingRulesGroupPrivate *priv;
 303
 304         g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), FALSE);
 305         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 306
 307         return priv->notifications_enabled;
 308 }
 309
 310 void
 311 modest_dimming_rules_group_execute (ModestDimmingRulesGroup *self)
 312 {
 313         ModestDimmingRulesGroupPrivate *priv;
 314         DimmedState *state = NULL;
 315
 316         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 317         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 318
 319         if (!priv->window)
 320                 return;
 321
 322         /* Init dimming rules init data */
 323         state = modest_ui_dimming_rules_define_dimming_state (priv->window);
 324         modest_window_set_dimming_state (priv->window, state);
 325
 326         /* execute group dimming rules */
 327         g_hash_table_foreach (priv->rules_map, _execute_dimming_rule, NULL);
 328         g_slist_foreach (priv->widget_rules, (GFunc) _execute_widget_dimming_rule, NULL);
 329
 330         /* Free dimming ruls init data */
 331         modest_window_set_dimming_state (priv->window, NULL);
 332 }
 333
 334
 335 static void
 336 _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data)
 337 {
 338         g_return_if_fail (MODEST_IS_DIMMING_RULE (value));
 339
 340         /* Process dimming rule */
 341         modest_dimming_rule_process (MODEST_DIMMING_RULE(value));
 342 }
 343
 344 static void
 345 _execute_widget_dimming_rule (gpointer data, gpointer user_data)
 346 {
 347         g_return_if_fail (MODEST_IS_DIMMING_RULE (data));
 348
 349         /* Process dimming rule */
 350         modest_dimming_rule_process (MODEST_DIMMING_RULE(data));
 351 }
 352
 353 #ifndef MODEST_TOOLKIT_GTK
 354 static void
 355 _insensitive_press_callback (GtkWidget *widget, gpointer user_data)
 356 {
 357         ModestDimmingRulesGroup *group = NULL;
 358         ModestDimmingRule *rule = NULL;
 359         gchar *notification = NULL;
 360
 361         g_return_if_fail (MODEST_IS_DIMMING_RULE (user_data));
 362         rule = MODEST_DIMMING_RULE (user_data);
 363
 364         /* Check if this group has notification system enabled */
 365         group = modest_dimming_rule_get_group (rule);
 366         if (!modest_dimming_rules_group_notifications_enabled (group))
 367                 goto frees;
 368
 369         /* Get specific notification */
 370         notification = modest_dimming_rule_get_notification (rule);
 371         if (notification == NULL)
 372                 goto frees;
 373
 374         /* Notifications for dimmed items are not shown in Hildon2 */
 375 #ifndef MODEST_TOOLKIT_HILDON2
 376         /* Show notification banner */
 377         modest_platform_information_banner (NULL, NULL, notification);
 378 #endif
 379
 380         /* Free */
 381  frees:
 382         if (group != NULL)
 383                 g_object_unref(group);
 384         if (notification != NULL)
 385                 g_free(notification);
 386 }
 387 #endif
 388
 389 static void
 390 on_window_destroy (gpointer data,
 391                    GObject *object)
 392 {
 393         ModestDimmingRulesGroup *self = MODEST_DIMMING_RULES_GROUP (data);
 394         ModestDimmingRulesGroupPrivate *priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE (self);
 395
 396         priv->window = NULL;
 397 }