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   AtkRelationType relationship;
 127
 128   g_return_if_fail (ATK_IS_RELATION_SET (set));
 129
 130   array_item = set->relations;
 131   if (array_item == NULL)
 132     return;
 133
 134   if (g_ptr_array_remove (array_item, relation))
 135   {
 136     g_object_unref (relation);
 137   }
 138   else
 139   {
 140     relationship = atk_relation_get_relation_type (relation);
 141     if (atk_relation_set_contains (set, relationship))
 142     {
 143       AtkRelation *exist_relation;
 144       gint i;
 145       exist_relation = atk_relation_set_get_relation_by_type (set, relationship);
 146       for (i = 0; i < relation->target->len; i++)
 147       {
 148         AtkObject *target = g_ptr_array_index(relation->target, i);
 149         atk_relation_remove_target (exist_relation, target);
 150       }
 151     }
 152   }
 153 }
 154
 155 /**
 156  * atk_relation_set_add:
 157  * @set: an #AtkRelationSet
 158  * @relation: an #AtkRelation
 159  *
 160  * Add a new relation to the current relation set if it is not already
 161  * present.
 162  * This function ref's the AtkRelation so the caller of this function
 163  * should unref it to ensure that it will be destroyed when the AtkRelationSet
 164  * is destroyed.
 165  **/
 166 void
 167 atk_relation_set_add (AtkRelationSet *set,
 168                       AtkRelation    *relation)
 169 {
 170   AtkRelationType relationship;
 171
 172   g_return_if_fail (ATK_IS_RELATION_SET (set));
 173   g_return_if_fail (relation != NULL);
 174
 175   if (set->relations == NULL)
 176   {
 177     set->relations = g_ptr_array_new ();
 178   }
 179
 180   relationship = atk_relation_get_relation_type (relation);
 181   if (!atk_relation_set_contains (set, relationship))
 182   {
 183     g_ptr_array_add (set->relations, relation);
 184     g_object_ref (relation);
 185   }
 186   else
 187   {
 188     AtkRelation *exist_relation;
 189     gint i;
 190     exist_relation = atk_relation_set_get_relation_by_type (set, relationship);
 191     for (i = 0; i < relation->target->len; i++)
 192     {
 193       AtkObject *target = g_ptr_array_index(relation->target, i);
 194       atk_relation_add_target (exist_relation, target);
 195     }
 196   }
 197 }
 198
 199 /**
 200  * atk_relation_set_get_n_relations:
 201  * @set: an #AtkRelationSet
 202  *
 203  * Determines the number of relations in a relation set.
 204  *
 205  * Returns: an integer representing the number of relations in the set.
 206  **/
 207 gint
 208 atk_relation_set_get_n_relations (AtkRelationSet *set)
 209 {
 210   g_return_val_if_fail (ATK_IS_RELATION_SET (set), 0);
 211
 212   if (set->relations == NULL)
 213     return 0;
 214
 215   return set->relations->len;
 216 }
 217
 218 /**
 219  * atk_relation_set_get_relation
 220  * @set: an #AtkRelationSet
 221  * @i: a gint representing a position in the set, starting from 0.
 222  *
 223  * Determines the relation at the specified position in the relation set.
 224  *
 225  * Returns: a #AtkRelation, which is the relation at position i in the set.
 226  **/
 227 AtkRelation*
 228 atk_relation_set_get_relation (AtkRelationSet *set,
 229                                gint           i)
 230 {
 231   GPtrArray *array_item;
 232   AtkRelation* item;
 233
 234   g_return_val_if_fail (ATK_IS_RELATION_SET (set), NULL);
 235   g_return_val_if_fail (i >= 0, NULL);
 236
 237   array_item = set->relations;
 238   if (array_item == NULL)
 239     return NULL;
 240   item = g_ptr_array_index (array_item, i);
 241   if (item == NULL)
 242     return NULL;
 243
 244   return item;
 245 }
 246
 247 /**
 248  * atk_relation_set_get_relation_by_type:
 249  * @set: an #AtkRelationSet
 250  * @relationship: an #AtkRelationType
 251  *
 252  * Finds a relation that matches the specified type.
 253  *
 254  * Returns: an #AtkRelation, which is a relation matching the specified type.
 255  **/
 256 AtkRelation*
 257 atk_relation_set_get_relation_by_type (AtkRelationSet  *set,
 258                                        AtkRelationType relationship)
 259 {
 260   GPtrArray *array_item;
 261   AtkRelation *item;
 262   gint i;
 263
 264   g_return_val_if_fail (ATK_IS_RELATION_SET (set), NULL);
 265
 266   array_item = set->relations;
 267   if (array_item == NULL)
 268     return NULL;
 269   for (i = 0; i < array_item->len; i++)
 270   {
 271     item = g_ptr_array_index (array_item, i);
 272     if (item->relationship == relationship)
 273       return item;
 274   }
 275   return NULL;
 276 }
 277
 278 static void
 279 atk_relation_set_finalize (GObject *object)
 280 {
 281   AtkRelationSet     *relation_set;
 282   GPtrArray             *array;
 283   gint               i;
 284
 285   g_return_if_fail (ATK_IS_RELATION_SET (object));
 286
 287   relation_set = ATK_RELATION_SET (object);
 288   array = relation_set->relations;
 289
 290   if (array)
 291   {
 292     for (i = 0; i < array->len; i++)
 293     {
 294       g_object_unref (g_ptr_array_index (array, i));
 295     }
 296     g_ptr_array_free (array, TRUE);
 297   }
 298
 299   G_OBJECT_CLASS (parent_class)->finalize (object);
 300 }
 301
 302 /**
 303  * atk_relation_set_add_relation_by_type:
 304  * @set: an #AtkRelationSet
 305  * @relationship: an #AtkRelationType
 306  * @target: an #AtkObject
 307  *
 308  * Add a new relation of the specified type with the specified target to
 309  * the current relation set if the relation set does not contain a relation
 310  * of that type. If it is does contain a relation of that typea the target
 311  * is added to the relation.
 312  *
 313  * Since: 1.9
 314  **/
 315 void
 316 atk_relation_set_add_relation_by_type (AtkRelationSet  *set,
 317                                        AtkRelationType relationship,
 318                                        AtkObject       *target)
 319 {
 320   AtkRelation *relation;
 321
 322   g_return_if_fail (ATK_IS_RELATION_SET (set));
 323   g_return_if_fail (ATK_IS_OBJECT (target));
 324
 325   relation = atk_relation_set_get_relation_by_type (set,
 326                                                     relationship);
 327   if (relation)
 328     {
 329       atk_relation_add_target (relation, target);
 330     }
 331   else
 332     {
 333       /* the relation hasn't been created yet ... */
 334       relation = atk_relation_new (&target, 1, relationship);
 335       atk_relation_set_add (set, relation);
 336       g_object_unref(relation);
 337     }
 338 }
 339