atk/atkrelation.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 <string.h>
  21 #include <glib-object.h>
  22 #include "atkobject.h"
  23 #include "atkrelation.h"
  24 #include "atk-enum-types.h"
  25
  26 enum {
  27   PROP_0,
  28
  29   PROP_RELATION_TYPE,
  30   PROP_TARGET,
  31   PROP_LAST
  32 };
  33
  34 GPtrArray *extra_names = NULL;
  35
  36 static gpointer parent_class = NULL;
  37
  38 static void atk_relation_class_init   (AtkRelationClass *klass);
  39 static void atk_relation_finalize     (GObject          *object);
  40 static void atk_relation_set_property (GObject          *object,
  41                                        guint            prop_id,
  42                                        const GValue     *value,
  43                                        GParamSpec       *pspec);
  44 static void atk_relation_get_property (GObject          *object,
  45                                        guint            prop_id,
  46                                        GValue           *value,
  47                                        GParamSpec       *pspec);
  48
  49 static GPtrArray* atk_relation_get_ptr_array_from_value_array (GValueArray *array);
  50 static GValueArray* atk_relation_get_value_array_from_ptr_array (GPtrArray *array);
  51
  52 GType
  53 atk_relation_get_type (void)
  54 {
  55   static GType type = 0;
  56
  57   if (!type)
  58     {
  59       static const GTypeInfo typeInfo =
  60       {
  61         sizeof (AtkRelationClass),
  62         (GBaseInitFunc) NULL,
  63         (GBaseFinalizeFunc) NULL,
  64         (GClassInitFunc) atk_relation_class_init,
  65         (GClassFinalizeFunc) NULL,
  66         NULL,
  67         sizeof (AtkRelation),
  68         0,
  69         (GInstanceInitFunc) NULL,
  70       } ;
  71       type = g_type_register_static (G_TYPE_OBJECT, "AtkRelation", &typeInfo, 0) ;
  72     }
  73   return type;
  74 }
  75
  76 static void
  77 atk_relation_class_init (AtkRelationClass *klass)
  78 {
  79   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  80
  81   parent_class = g_type_class_peek_parent (klass);
  82
  83   gobject_class->finalize = atk_relation_finalize;
  84   gobject_class->set_property = atk_relation_set_property;
  85   gobject_class->get_property = atk_relation_get_property;
  86
  87   g_object_class_install_property (gobject_class,
  88                                    PROP_RELATION_TYPE,
  89                                    g_param_spec_enum ("relation_type",
  90                                                       "Relation Type",
  91                                                       "The type of the relation",
  92                                                       ATK_TYPE_RELATION_TYPE,
  93                                                       ATK_RELATION_NULL,
  94                                                       G_PARAM_READWRITE));
  95   g_object_class_install_property (gobject_class,
  96                                    PROP_TARGET,
  97                                    g_param_spec_value_array ("target",
  98                                                              "Target",
  99                                                              "An array of the targets for the relation",
 100                                                              NULL,
 101
 102                                                              G_PARAM_READWRITE));
 103 }
 104
 105 /**
 106  * atk_relation_type_register:
 107  * @name: a name string
 108  *
 109  * Associate @name with a new #AtkRelationType
 110
 111  * Returns: an #AtkRelationType associated with @name
 112  **/
 113 AtkRelationType
 114 atk_relation_type_register (const gchar *name)
 115 {
 116   g_return_val_if_fail (name, ATK_RELATION_NULL);
 117
 118   if (!extra_names)
 119     extra_names = g_ptr_array_new ();
 120
 121   g_ptr_array_add (extra_names, g_strdup (name));
 122   return extra_names->len + ATK_RELATION_LAST_DEFINED;
 123 }
 124
 125 /**
 126  * atk_relation_type_get_name:
 127  * @type: The #AtkRelationType whose name is required
 128  *
 129  * Gets the description string describing the #AtkRelationType @type.
 130  *
 131  * Returns: the string describing the AtkRelationType
 132  */
 133 G_CONST_RETURN gchar*
 134 atk_relation_type_get_name (AtkRelationType type)
 135 {
 136   GTypeClass *type_class;
 137   GEnumValue *value;
 138   gchar *name = NULL;
 139
 140   type_class = g_type_class_ref (ATK_TYPE_RELATION_TYPE);
 141   g_return_val_if_fail (G_IS_ENUM_CLASS (type_class), NULL);
 142
 143   value = g_enum_get_value (G_ENUM_CLASS (type_class), type);
 144
 145   if (value)
 146     {
 147       name = value->value_nick;
 148     }
 149   else
 150     {
 151       if (extra_names)
 152         {
 153           gint n = type;
 154
 155           n -= ATK_RELATION_LAST_DEFINED + 1;
 156
 157           if (n < extra_names->len)
 158             name = g_ptr_array_index (extra_names, n);
 159         }
 160     }
 161   g_type_class_unref (type_class);
 162   return name;
 163 }
 164
 165 /**
 166  * atk_relation_type_for_name:
 167  * @name: a string which is the (non-localized) name of an ATK relation type.
 168  *
 169  * Get the #AtkRelationType type corresponding to a relation name.
 170  *
 171  * Returns: the #AtkRelationType enumerated type corresponding to the specified name,
 172  *          or #ATK_RELATION_NULL if no matching relation type is found.
 173  **/
 174 AtkRelationType
 175 atk_relation_type_for_name (const gchar *name)
 176 {
 177   GTypeClass *type_class;
 178   GEnumValue *value;
 179   AtkRelationType type = ATK_RELATION_NULL;
 180
 181   g_return_val_if_fail (name, ATK_RELATION_NULL);
 182
 183   type_class = g_type_class_ref (ATK_TYPE_RELATION_TYPE);
 184   g_return_val_if_fail (G_IS_ENUM_CLASS (type_class), ATK_RELATION_NULL);
 185
 186   value = g_enum_get_value_by_nick (G_ENUM_CLASS (type_class), name);
 187
 188   if (value)
 189     {
 190       type = value->value;
 191     }
 192   else
 193     {
 194       gint i;
 195
 196       if (extra_names)
 197         {
 198           for (i = 0; i < extra_names->len; i++)
 199             {
 200               gchar *extra_name = (gchar *)g_ptr_array_index (extra_names, i);
 201
 202               g_return_val_if_fail (extra_name, ATK_RELATION_NULL);
 203
 204               if (strcmp (name, extra_name) == 0)
 205                 {
 206                   type = i + 1 + ATK_RELATION_LAST_DEFINED;
 207                   break;
 208                 }
 209             }
 210         }
 211     }
 212   g_type_class_unref (type_class);
 213
 214   return type;
 215 }
 216
 217
 218 /**
 219  * atk_relation_new:
 220  * @targets: an array of pointers to #AtkObjects
 221  * @n_targets: number of #AtkObjects pointed to by @targets
 222  * @relationship: an #AtkRelationType with which to create the new
 223  *  #AtkRelation
 224  *
 225  * Create a new relation for the specified key and the specified list
 226  * of targets.
 227  *
 228  * Returns: a pointer to a new #AtkRelation
 229  **/
 230 AtkRelation*
 231 atk_relation_new (AtkObject       **targets,
 232                   gint            n_targets,
 233                   AtkRelationType relationship)
 234 {
 235   AtkRelation *relation;
 236   int         i;
 237   GValueArray *array;
 238   GValue      *value;
 239
 240   g_return_val_if_fail (targets != NULL, NULL);
 241
 242   array = g_value_array_new (n_targets);
 243   for (i = 0; i < n_targets; i++)
 244   {
 245     value = g_new0 (GValue, 1);
 246     g_value_init (value, ATK_TYPE_OBJECT);
 247     g_value_set_object (value, targets[i]);
 248     array = g_value_array_append (array, value);
 249     g_free (value);
 250   }
 251
 252   relation =  g_object_new (ATK_TYPE_RELATION,
 253                             "relation_type", relationship,
 254                             "target", array,
 255                             NULL);
 256
 257   g_value_array_free (array);
 258
 259   return relation;
 260 }
 261
 262 /**
 263  * atk_relation_get_relation_type:
 264  * @relation: an #AtkRelation
 265  *
 266  * Gets the type of @relation
 267  *
 268  * Returns: the type of @relation
 269  **/
 270 AtkRelationType
 271 atk_relation_get_relation_type (AtkRelation *relation)
 272 {
 273   g_return_val_if_fail (ATK_IS_RELATION (relation), 0);
 274
 275   return relation->relationship;
 276 }
 277
 278 /**
 279  * atk_relation_get_target:
 280  * @relation: an #AtkRelation
 281  *
 282  * Gets the target list of @relation
 283  *
 284  * Returns: the target list of @relation
 285  **/
 286 GPtrArray*
 287 atk_relation_get_target (AtkRelation *relation)
 288 {
 289   g_return_val_if_fail (ATK_IS_RELATION (relation), NULL);
 290
 291   return relation->target;
 292 }
 293
 294 static void
 295 atk_relation_finalize (GObject *object)
 296 {
 297   AtkRelation        *relation;
 298
 299   g_return_if_fail (ATK_IS_RELATION (object));
 300
 301   relation = ATK_RELATION (object);
 302
 303   if (relation->target)
 304   {
 305     gint i;
 306
 307     for (i = 0; i < relation->target->len; i++)
 308     {
 309       /*
 310        * Remove a reference to AtkObject being removed from a relation
 311        */
 312       g_object_unref (g_ptr_array_index (relation->target, i));
 313     }
 314     g_ptr_array_free (relation->target, TRUE);
 315   }
 316
 317   G_OBJECT_CLASS (parent_class)->finalize (object);
 318 }
 319
 320 static void
 321 atk_relation_set_property (GObject       *object,
 322                            guint         prop_id,
 323                            const GValue  *value,
 324                            GParamSpec    *pspec)
 325 {
 326   AtkRelation *relation;
 327   gpointer boxed;
 328
 329   relation = ATK_RELATION (object);
 330
 331   switch (prop_id)
 332     {
 333     case PROP_RELATION_TYPE:
 334       relation->relationship = g_value_get_enum (value);
 335       break;
 336     case PROP_TARGET:
 337       boxed = g_value_get_boxed (value);
 338       relation->target = atk_relation_get_ptr_array_from_value_array ( (GValueArray *) boxed);
 339       break;
 340     default:
 341       break;
 342     }
 343 }
 344
 345 static void
 346 atk_relation_get_property (GObject    *object,
 347                            guint      prop_id,
 348                            GValue     *value,
 349                            GParamSpec *pspec)
 350 {
 351   AtkRelation *relation;
 352   GValueArray *array;
 353
 354   relation = ATK_RELATION (object);
 355
 356   switch (prop_id)
 357     {
 358     case PROP_RELATION_TYPE:
 359       g_value_set_enum (value, relation->relationship);
 360       break;
 361     case PROP_TARGET:
 362       array = atk_relation_get_value_array_from_ptr_array (relation->target);
 363       g_value_set_boxed (value, array);
 364       break;
 365     default:
 366       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 367       break;
 368     }
 369 }
 370
 371 static GPtrArray*
 372 atk_relation_get_ptr_array_from_value_array (GValueArray *array)
 373 {
 374   gint i;
 375   GPtrArray *return_array;
 376   GValue *value;
 377   GObject *obj;
 378
 379   return_array = g_ptr_array_sized_new (array->n_values);
 380   for (i = 0; i < array->n_values; i++)
 381     {
 382       value = g_value_array_get_nth (array, i);
 383       obj = g_value_get_object (value);
 384       g_object_ref (obj);
 385       g_ptr_array_add (return_array, obj);
 386     }
 387
 388   return return_array;
 389 }
 390
 391 static GValueArray*
 392 atk_relation_get_value_array_from_ptr_array (GPtrArray *array)
 393 {
 394   int         i;
 395   GValueArray *return_array;
 396   GValue      *value;
 397
 398   return_array = g_value_array_new (array->len);
 399   for (i = 0; i < array->len; i++)
 400     {
 401       value = g_new0 (GValue, 1);
 402       g_value_init (value, ATK_TYPE_OBJECT);
 403       g_value_set_object (value, g_ptr_array_index (array, i));
 404       return_array = g_value_array_append (return_array, value);
 405     }
 406   return return_array;
 407 }