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