Fix lifecycle of an accessible's cache
[platform/upstream/at-spi2-core.git] / atspi / atspi-matchrule.c
index 3083bf1..8abeb13 100644 (file)
@@ -4,6 +4,7 @@
  *
  * Copyright 2001, 2002 Sun Microsystems Inc.,
  * Copyright 2001, 2002 Ximian, Inc.
+ * Copyright 2010, 2011 Novell, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -59,6 +60,9 @@ atspi_match_rule_finalize (GObject *object)
   if (rule->interfaces)
     g_array_free (rule->interfaces, TRUE);
 
+  if (rule->attributes)
+    g_hash_table_unref (rule->attributes);
+
   G_OBJECT_CLASS (atspi_match_rule_parent_class)->finalize (object);
 }
 
@@ -73,29 +77,37 @@ atspi_match_rule_class_init (AtspiMatchRuleClass *klass)
 
 /**
  * atspi_match_rule_new:
- *
  * @states: An #AtspiStateSet specifying the states to match or NULL if none.
  * @statematchtype: An #AtspiCollectionMatchType specifying how to interpret
- *                  @states.
+ *          @states.
  * @attributes: (element-type gchar* gchar*): A #GHashTable specifying
- *              attributes to match.
+ *          attributes to match. To specify multiple attribute values,
+ *          separate each value with a :: If an attribute value contains a :,
+ *          then it can be escaped by preceding it with a \. A backslash can
+ *          likewise be escaped by inserting a double backslash.
  * @attributematchtype: An #AtspiCollectionMatchType specifying how to
- *                      interpret @attributes.
+ *          interpret @attributes.
  * @interfaces: (element-type gchar*): An array of interfaces to match, or
- *              NUL if not applicable.  Interface names should be specified
- *              by their DBus names (org.a11y.Atspi.Accessible,
- *              org.a11y.Atspi.Component, etc).
+ *          NULL if not applicable.  Interface names should be specified
+ *          by their DBus names (org.a11y.Atspi.Accessible,
+ *          org.a11y.Atspi.Component, etc).
  * @interfacematchtype: An #AtspiCollectionMatchType specifying how to
- *                      interpret @interfaces.
+ *          interpret @interfaces.
  * @roles: (element-type AtspiRole): A #GArray of roles to match, or NULL if
- *         not applicable.
+ *          not applicable.
  * @rolematchtype: An #AtspiCollectionMatchType specifying how to
- *                      interpret @roles.
- * @invert: Specifies whether results should be inverted.
- * TODO: Document this parameter better.
+ *          interpret @roles.
+ * @invert: if #TRUE, the match rule should be denied (inverted); if #FALSE,
+ *          it should not. For example, if the match rule defines that a match is
+ *          an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action,
+ *          inverting it would match all objects that are not of ROLE_HEADING,
+ *          focusable and clickable at the same time.
+ *
+ * Creates a new #AtspiMatchRule with specified @states, @attributes, 
+ * @interfaces, and @roles.
  *
  * Returns: (transfer full): A new #AtspiMatchRule.
- */
+ **/
 AtspiMatchRule *
 atspi_match_rule_new (AtspiStateSet *states,
                       AtspiCollectionMatchType statematchtype,
@@ -110,16 +122,24 @@ atspi_match_rule_new (AtspiStateSet *states,
   AtspiMatchRule *rule = g_object_new (ATSPI_TYPE_MATCH_RULE, NULL);
   int i;
 
-  if (!rule)
-    return NULL;
-
   if (states)
     rule->states = g_object_ref (states);
   rule->statematchtype = statematchtype;
 
   if (attributes)
-    rule->attributes = g_hash_table_ref (attributes);
-    rule->attributematchtype = attributematchtype;
+  {
+    GHashTableIter hash_table_iter;
+    gchar *key, *value;
+    rule->attributes = g_hash_table_new_full (g_str_hash, g_str_equal,
+                                              (GDestroyNotify) g_free,
+                                              (GDestroyNotify) g_free);
+    g_hash_table_iter_init (&hash_table_iter, attributes);
+            while (g_hash_table_iter_next (&hash_table_iter, (gpointer *)&key,
+                   (gpointer *)&value))
+      g_hash_table_insert (rule->attributes, g_strdup (key), g_strdup (value));
+  } else
+    rule->attributes = NULL;
+  rule->attributematchtype = attributematchtype;
 
   if (interfaces)
     rule->interfaces = g_array_ref (interfaces);
@@ -146,7 +166,7 @@ atspi_match_rule_new (AtspiStateSet *states,
 }
 
 static void
-append_entry (gpointer *key, gpointer *val, gpointer data)
+append_entry (gpointer key, gpointer val, gpointer data)
 {
   DBusMessageIter *iter = data;
   DBusMessageIter iter_entry;
@@ -196,7 +216,8 @@ _atspi_match_rule_marshal (AtspiMatchRule *rule, DBusMessageIter *iter)
   if (!dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "{ss}",
                                          &iter_dict))
     return FALSE;
-  g_hash_table_foreach (rule->attributes, append_entry, &iter_dict);
+  if (rule->attributes)
+    g_hash_table_foreach (rule->attributes, append_entry, &iter_dict);
   dbus_message_iter_close_container (&iter_struct, &iter_dict);
   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &d_attributematchtype);