atk/atkrelationset.c

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include <glib-object.h>
  21
  22 #include "atk.h"
  23
  24 static gpointer parent_class = NULL;
  25
  26 static void atk_relation_set_class_init (AtkRelationSetClass  *klass);
  27 static void atk_relation_set_finalize   (GObject              *object);
  28
  29 GType
  30 atk_relation_set_get_type (void)
  31 {
  32   static GType type = 0;
  33
  34   if (!type)
  35     {
  36       static const GTypeInfo typeInfo =
  37       {
  38         sizeof (AtkRelationSetClass),
  39         (GBaseInitFunc) NULL,
  40         (GBaseFinalizeFunc) NULL,
  41         (GClassInitFunc) atk_relation_set_class_init,
  42         (GClassFinalizeFunc) NULL,
  43         NULL,
  44         sizeof (AtkRelationSet),
  45         0,
  46         (GInstanceInitFunc) NULL,
  47       } ;
  48       type = g_type_register_static (G_TYPE_OBJECT, "AtkRelationSet", &typeInfo, 0) ;
  49     }
  50   return type;
  51 }
  52
  53 static void
  54 atk_relation_set_class_init (AtkRelationSetClass *klass)
  55 {
  56   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  57
  58   parent_class = g_type_class_peek_parent (klass);
  59
  60   gobject_class->finalize = atk_relation_set_finalize;
  61 }
  62
  63 /**
  64  * atk_relation_set_new:
  65  *
  66  * Creates a new empty relation set.
  67  *
  68  * Returns: a new #AtkRelationSet
  69  **/
  70 AtkRelationSet*
  71 atk_relation_set_new (void)
  72 {
  73   AtkRelationSet *relation_set;
  74
  75   relation_set = g_object_new (ATK_TYPE_RELATION_SET, NULL);
  76   return relation_set;
  77 }
  78
  79 /**
  80  * atk_relation_set_contains:
  81  * @set: an #AtkRelationSet
  82  * @relationship: an #AtkRelationType
  83  *
  84  * Determines whether the relation set contains a relation that matches the
  85  * specified type.
  86  *
  87  * Returns: %TRUE if @relationship is the relationship type of a relation
  88  * in @set, %FALSE otherwise
  89  **/
  90 gboolean
  91 atk_relation_set_contains (AtkRelationSet   *set,
  92                            AtkRelationType  relationship)
  93 {
  94   GPtrArray *array_item;
  95   AtkRelation *item;
  96   gint  i;
  97
  98   g_return_val_if_fail (ATK_IS_RELATION_SET (set), FALSE);
  99
 100   array_item = set->relations;
 101   if (array_item == NULL)
 102     return FALSE;
 103   for (i = 0; i < array_item->len; i++)
 104   {
 105     item = g_ptr_array_index (array_item, i);
 106     if (item->relationship == relationship)
 107       return TRUE;
 108   }
 109   return FALSE;
 110 }
 111
 112 /**
 113  * atk_relation_set_remove:
 114  * @set: an #AtkRelationSet
 115  * @relation: an #AtkRelation
 116  *
 117  * Removes a relation from the relation set.
 118  * This function unref's the #AtkRelation so it will be deleted unless there
 119  * is another reference to it.
 120  **/
 121 void
 122 atk_relation_set_remove (AtkRelationSet *set,
 123                          AtkRelation    *relation)
 124 {
 125   GPtrArray *array_item;
 126
 127   g_return_if_fail (ATK_IS_RELATION_SET (set));
 128
 129   array_item = set->relations;
 130   if (array_item == NULL)
 131     return;
 132
 133   if (g_ptr_array_remove (array_item, relation))
 134   {
 135     g_object_unref (relation);
 136   }
 137 }
 138
 139 /**
 140  * atk_relation_set_add:
 141  * @set: an #AtkRelationSet
 142  * @relation: an #AtkRelation
 143  *
 144  * Add a new relation to the current relation set if it is not already
 145  * present.
 146  * This function ref's the AtkRelation so the caller of this function
 147  * should unref it to ensure that it will be destroyed when the AtkRelationSet
 148  * is destroyed.
 149  **/
 150 void
 151 atk_relation_set_add (AtkRelationSet *set,
 152                       AtkRelation    *relation)
 153 {
 154   AtkRelationType relationship;
 155
 156   g_return_if_fail (ATK_IS_RELATION_SET (set));
 157   g_return_if_fail (relation != NULL);
 158
 159   if (set->relations == NULL)
 160   {
 161     set->relations = g_ptr_array_new ();
 162   }
 163   relationship = atk_relation_get_relation_type (relation);
 164   if (!atk_relation_set_contains (set, relationship))
 165   {
 166     g_ptr_array_add (set->relations, relation);
 167   }
 168   g_object_ref (relation);
 169 }
 170
 171 /**
 172  * atk_relation_set_get_n_relations:
 173  * @set: an #AtkRelationSet
 174  *
 175  * Determines the number of relations in a relation set.
 176  *
 177  * Returns: an integer representing the number of relations in the set.
 178  **/
 179 gint
 180 atk_relation_set_get_n_relations (AtkRelationSet *set)
 181 {
 182   g_return_val_if_fail (ATK_IS_RELATION_SET (set), 0);
 183
 184   if (set->relations == NULL)
 185     return 0;
 186
 187   return set->relations->len;
 188 }
 189
 190 /**
 191  * atk_relation_set_get_relation
 192  * @set: an #AtkRelationSet
 193  * @i: a gint representing a position in the set, starting from 0.
 194  *
 195  * Determines the relation at the specified position in the relation set.
 196  *
 197  * Returns: a #AtkRelation, which is the relation at position i in the set.
 198  **/
 199 AtkRelation*
 200 atk_relation_set_get_relation (AtkRelationSet *set,
 201                                gint           i)
 202 {
 203   GPtrArray *array_item;
 204   AtkRelation* item;
 205
 206   g_return_val_if_fail (ATK_IS_RELATION_SET (set), NULL);
 207   g_return_val_if_fail (i >= 0, NULL);
 208
 209   array_item = set->relations;
 210   if (array_item == NULL)
 211     return NULL;
 212   item = g_ptr_array_index (array_item, i);
 213   if (item == NULL)
 214     return NULL;
 215
 216   return item;
 217 }
 218
 219 /**
 220  * atk_relation_set_get_relation_by_type:
 221  * @set: an #AtkRelationSet
 222  * @relationship: an #AtkRelationType
 223  *
 224  * Finds a relation that matches the specified type.
 225  *
 226  * Returns: an #AtkRelation, which is a relation matching the specified type.
 227  **/
 228 AtkRelation*
 229 atk_relation_set_get_relation_by_type (AtkRelationSet  *set,
 230                                        AtkRelationType relationship)
 231 {
 232   GPtrArray *array_item;
 233   AtkRelation *item;
 234   gint i;
 235
 236   g_return_val_if_fail (ATK_IS_RELATION_SET (set), NULL);
 237
 238   array_item = set->relations;
 239   if (array_item == NULL)
 240     return NULL;
 241   for (i = 0; i < array_item->len; i++)
 242   {
 243     item = g_ptr_array_index (array_item, i);
 244     if (item->relationship == relationship)
 245       return item;
 246   }
 247   return NULL;
 248 }
 249
 250 static void
 251 atk_relation_set_finalize (GObject *object)
 252 {
 253   AtkRelationSet     *relation_set;
 254   GPtrArray             *array;
 255   gint               i;
 256
 257   g_return_if_fail (ATK_IS_RELATION_SET (object));
 258
 259   relation_set = ATK_RELATION_SET (object);
 260   array = relation_set->relations;
 261
 262   if (array)
 263   {
 264     for (i = 0; i < array->len; i++)
 265     {
 266       g_object_unref (g_ptr_array_index (array, i));
 267     }
 268     g_ptr_array_free (array, TRUE);
 269   }
 270
 271   G_OBJECT_CLASS (parent_class)->finalize (object);
 272 }
 273
 274 /**
 275  * atk_relation_set_add_relation_by_type:
 276  * @set: an #AtkRelationSet
 277  * @relationship: an #AtkRelationType
 278  * @target: an #AtkObject
 279  *
 280  * Add a new relation of the specified type with the specified target to
 281  * the current relation set if the relation set does not contain a relation
 282  * of that type. If it is does contain a relation of that typea the target
 283  * is added to the relation.
 284  *
 285  * Since: ATK 1.9
 286  **/
 287 void
 288 atk_relation_set_add_relation_by_type (AtkRelationSet  *set,
 289                                        AtkRelationType relationship,
 290                                        AtkObject       *target)
 291 {
 292   AtkRelation *relation;
 293
 294   g_return_if_fail (ATK_IS_RELATION_SET (set));
 295   g_return_if_fail (ATK_IS_OBJECT (target));
 296
 297   relation = atk_relation_set_get_relation_by_type (set,
 298                                                     relationship);
 299   if (relation)
 300     {
 301       atk_relation_add_target (relation, target);
 302     }
 303   else
 304     {
 305       /* the relation hasn't been created yet ... */
 306       relation = atk_relation_new (&target, 1, relationship);
 307       atk_relation_set_add (set, relation);
 308       g_object_unref(relation);
 309     }
 310 }
 311