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
  43 typedef struct _ModestDimmingRulesGroupPrivate ModestDimmingRulesGroupPrivate;
  44 struct _ModestDimmingRulesGroupPrivate {
  45         ModestWindow *window;
  46         gchar *name;
  47         gboolean notifications_enabled;
  48         GHashTable *rules_map;
  49 };
  50
  51
  52 #define MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  53                                                    MODEST_TYPE_DIMMING_RULES_GROUP, \
  54                                                    ModestDimmingRulesGroupPrivate))
  55
  56 /* globals */
  57 static GObjectClass *parent_class = NULL;
  58
  59 static void _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data);
  60 static void _insensitive_press_callback (GtkWidget *widget, gpointer user_data);
  61
  62
  63
  64 GType
  65 modest_dimming_rules_group_get_type (void)
  66 {
  67         static GType my_type = 0;
  68         if (!my_type) {
  69                 static const GTypeInfo my_info = {
  70                         sizeof(ModestDimmingRulesGroupClass),
  71                         NULL,           /* base init */
  72                         NULL,           /* base finalize */
  73                         (GClassInitFunc) modest_dimming_rules_group_class_init,
  74                         NULL,           /* class finalize */
  75                         NULL,           /* class data */
  76                         sizeof(ModestDimmingRulesGroup),
  77                         1,              /* n_preallocs */
  78                         (GInstanceInitFunc) modest_dimming_rules_group_init,
  79                         NULL
  80                 };
  81                 my_type = g_type_register_static (G_TYPE_OBJECT,
  82                                                   "ModestDimmingRulesGroup",
  83                                                   &my_info, 0);
  84         }
  85         return my_type;
  86 }
  87
  88 static void
  89 modest_dimming_rules_group_class_init (ModestDimmingRulesGroupClass *klass)
  90 {
  91         GObjectClass *gobject_class;
  92         gobject_class = (GObjectClass*) klass;
  93
  94         parent_class            = g_type_class_peek_parent (klass);
  95         gobject_class->finalize = modest_dimming_rules_group_finalize;
  96
  97         g_type_class_add_private (gobject_class, sizeof(ModestDimmingRulesGroupPrivate));
  98 }
  99
 100 static void
 101 modest_dimming_rules_group_init (ModestDimmingRulesGroup *obj)
 102 {
 103         ModestDimmingRulesGroupPrivate *priv;
 104
 105         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 106
 107         priv->name = NULL;
 108         priv->window = NULL;
 109         priv->notifications_enabled = FALSE;
 110         priv->rules_map = g_hash_table_new_full ((GHashFunc) g_str_hash,
 111                                                  (GEqualFunc) g_str_equal,
 112                                                  (GDestroyNotify) g_free,
 113                                                  (GDestroyNotify) g_object_unref);
 114 }
 115
 116 static void
 117 modest_dimming_rules_group_finalize (GObject *obj)
 118 {
 119         ModestDimmingRulesGroupPrivate *priv;
 120
 121         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 122
 123         if (priv->name != NULL)
 124                 g_free(priv->name);
 125
 126         if (priv->rules_map != NULL)
 127                 g_hash_table_destroy (priv->rules_map);
 128
 129         G_OBJECT_CLASS(parent_class)->finalize (obj);
 130 }
 131
 132
 133 ModestDimmingRulesGroup*
 134 modest_dimming_rules_group_new(const gchar *group_name,
 135                                gboolean notifications_enabled)
 136 {
 137         ModestDimmingRulesGroup *obj;
 138         ModestDimmingRulesGroupPrivate *priv;
 139
 140         g_return_val_if_fail (group_name != NULL, NULL);
 141
 142         obj = MODEST_DIMMING_RULES_GROUP(g_object_new(MODEST_TYPE_DIMMING_RULES_GROUP, NULL));
 143
 144         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(obj);
 145         priv->name = g_strdup(group_name);
 146         priv->notifications_enabled = notifications_enabled;
 147
 148         return obj;
 149 }
 150
 151
 152 gchar *
 153 modest_dimming_rules_group_get_name (ModestDimmingRulesGroup *self)
 154 {
 155         ModestDimmingRulesGroupPrivate *priv;
 156
 157         g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), NULL);
 158
 159         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 160
 161         return g_strdup (priv->name);
 162 }
 163
 164 void
 165 modest_dimming_rules_group_add_rules (ModestDimmingRulesGroup *self,
 166                                       const ModestDimmingEntry modest_dimming_entries[],
 167                                       guint n_elements,
 168                                       gpointer user_data)
 169 {
 170         ModestDimmingRulesGroupPrivate *priv;
 171         ModestDimmingRule *dim_rule = NULL;
 172         ModestDimmingEntry entry;
 173         GtkWidget *widget = NULL;
 174         gboolean unique = FALSE;
 175         guint i;
 176
 177         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 178         g_return_if_fail (modest_dimming_entries != NULL);
 179         g_return_if_fail (n_elements > 0);
 180         g_return_if_fail (MODEST_IS_WINDOW(user_data));
 181
 182         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 183
 184         /* Set window to process dimming rules */
 185         priv->window = MODEST_WINDOW (user_data);
 186
 187         /* Add dimming rules */
 188         for (i=0; i < n_elements; i++) {
 189                 entry = modest_dimming_entries[i];
 190
 191                 /* Check dimming_rule and action path are NOT NULL */
 192                 if (entry.action_path == NULL) continue;
 193                 if (entry.callback == NULL) continue;
 194
 195                 /* Check action path is unique */
 196                 unique = g_hash_table_lookup (priv->rules_map, entry.action_path) == NULL;
 197                 if (!unique) continue;
 198
 199                 /* Check action path is valid */
 200                 widget = modest_window_get_action_widget (MODEST_WINDOW (user_data), entry.action_path);
 201                 if (widget == NULL) continue;
 202
 203                 /* Create a new dimming rule */
 204                 dim_rule = modest_dimming_rule_new (priv->window,
 205                                                     (ModestDimmingCallback) entry.callback,
 206                                                     entry.action_path);
 207
 208                 /* Connect insensitive-presss handler to show notifications */
 209                 g_signal_connect (G_OBJECT (widget), "insensitive-press",
 210                                   G_CALLBACK (_insensitive_press_callback),
 211                                   dim_rule);
 212
 213                 /* Register new dimming rule */
 214                 modest_dimming_rule_set_group (dim_rule, self);
 215                 g_hash_table_insert (priv->rules_map, g_strdup(entry.action_path), dim_rule);
 216         }
 217 }
 218
 219 gboolean
 220 modest_dimming_rules_group_notifications_enabled (ModestDimmingRulesGroup *self)
 221 {
 222         ModestDimmingRulesGroupPrivate *priv;
 223
 224         g_return_val_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self), FALSE);
 225         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 226
 227         return priv->notifications_enabled;
 228 }
 229
 230 void
 231 modest_dimming_rules_group_execute (ModestDimmingRulesGroup *self)
 232 {
 233         ModestDimmingRulesGroupPrivate *priv;
 234         DimmedState *state = NULL;
 235
 236         g_return_if_fail (MODEST_IS_DIMMING_RULES_GROUP(self));
 237         priv = MODEST_DIMMING_RULES_GROUP_GET_PRIVATE(self);
 238
 239         /* Init dimming rules init data */
 240         state = modest_ui_dimming_rules_define_dimming_state (priv->window);
 241         modest_window_set_dimming_state (priv->window, state);
 242
 243         /* execute group dimming rules */
 244         g_hash_table_foreach (priv->rules_map, _execute_dimming_rule, NULL);
 245
 246         /* Free dimming ruls init data */
 247         modest_window_set_dimming_state (priv->window, NULL);
 248 }
 249
 250
 251 static void
 252 _execute_dimming_rule (gpointer key, gpointer value, gpointer user_data)
 253 {
 254         g_return_if_fail (MODEST_IS_DIMMING_RULE (value));
 255
 256         /* Process dimming rule */
 257         modest_dimming_rule_process (MODEST_DIMMING_RULE(value));
 258 }
 259
 260 static void
 261 _insensitive_press_callback (GtkWidget *widget, gpointer user_data)
 262 {
 263         ModestDimmingRulesGroup *group = NULL;
 264         ModestDimmingRule *rule = NULL;
 265         gchar *notification = NULL;
 266
 267         g_return_if_fail (MODEST_IS_DIMMING_RULE (user_data));
 268         rule = MODEST_DIMMING_RULE (user_data);
 269
 270         /* Check if this group has notification system enabled */
 271         group = modest_dimming_rule_get_group (rule);
 272         if (!modest_dimming_rules_group_notifications_enabled (group))
 273                 goto frees;
 274
 275         /* Get specific notification */
 276         notification = modest_dimming_rule_get_notification (rule);
 277         if (notification == NULL)
 278                 goto frees;
 279
 280         /* Show notification banner */
 281         modest_platform_information_banner (NULL, NULL, notification);
 282
 283         /* Free */
 284  frees:
 285         if (group != NULL)
 286                 g_object_unref(group);
 287         if (notification != NULL)
 288                 g_free(notification);
 289 }