atk/atkregistry.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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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 "atkregistry.h"
  21 #include "atknoopobjectfactory.h"
  22
  23 static AtkRegistry *default_registry = NULL;;
  24
  25 static void              atk_registry_init           (AtkRegistry      *instance,
  26                                                       AtkRegistryClass *klass);
  27 static void              atk_registry_finalize       (GObject          *instance);
  28 static void              atk_registry_class_init     (AtkRegistryClass *klass);
  29
  30 static AtkRegistry*      atk_registry_new            ();
  31 static GType           atk_registry_get_factory_type (AtkRegistry      *registry,
  32                                                       GType            type);
  33
  34 GType
  35 atk_registry_get_type (void)
  36 {
  37   static GType type = 0;
  38
  39   if (!type)
  40     {
  41       static const GTypeInfo info =
  42       {
  43         sizeof (AtkRegistryClass),
  44         (GBaseInitFunc) NULL,                             /* base_init */
  45         (GBaseFinalizeFunc) NULL,                         /* base_finalize */
  46         (GClassInitFunc) atk_registry_class_init,         /* class_init */
  47         (GClassFinalizeFunc) NULL,                        /* class_finalize */
  48         NULL,                                             /* class_data */
  49         sizeof (AtkRegistry),                             /* instance size */
  50         0,                                                /* n_preallocs */
  51         (GInstanceInitFunc) atk_registry_init,            /* instance init */
  52         NULL                                              /* value table */
  53       };
  54
  55       type = g_type_register_static (G_TYPE_OBJECT, "AtkRegistry", &info, 0);
  56     }
  57
  58   return type;
  59 }
  60
  61 static void
  62 atk_registry_class_init (AtkRegistryClass *klass)
  63 {
  64   GObjectClass *object_class;
  65
  66   /* is paranoia appropriate in a class initializer ? */
  67   g_return_if_fail (G_IS_OBJECT_CLASS (klass));
  68
  69   object_class = G_OBJECT_CLASS (klass);
  70   object_class->finalize = atk_registry_finalize;
  71   default_registry = atk_registry_new ();
  72 }
  73
  74 #if 0
  75 /*
  76  * Cannot define a class_finalize function when calling
  77  * g_type_register_static()
  78  */
  79 static void
  80 atk_registry_class_finalize (GObjectClass *klass)
  81 {
  82   g_return_if_fail (ATK_IS_REGISTRY_CLASS (klass));
  83
  84   g_free (default_registry);
  85 }
  86 #endif
  87
  88 static void
  89 atk_registry_init (AtkRegistry *instance, AtkRegistryClass *klass)
  90 {
  91   instance->factory_type_registry = g_hash_table_new (NULL, NULL);
  92   instance->factory_singleton_cache = g_hash_table_new (NULL, NULL);
  93 }
  94
  95 static AtkRegistry*
  96 atk_registry_new ()
  97 {
  98   GObject *object;
  99
 100   object = g_object_new (ATK_TYPE_REGISTRY, NULL);
 101
 102   g_return_val_if_fail ((object != NULL), NULL);
 103   g_return_val_if_fail (ATK_IS_REGISTRY (object), NULL);
 104
 105   return (AtkRegistry *) object;
 106 }
 107
 108 static void
 109 atk_registry_finalize (GObject *instance)
 110 {
 111   AtkRegistry *registry;
 112
 113   g_return_if_fail (ATK_IS_REGISTRY (instance));
 114   registry = ATK_REGISTRY (instance);
 115   g_free (registry->factory_type_registry);
 116   g_free (registry->factory_singleton_cache);
 117 }
 118
 119 /**
 120  *atk_registry_set_factory_type:
 121  *@registry: the #AtkRegistry in which to register the association
 122  * between an #AtkObjectFactory #GType and an #AtkObject @GType
 123  *@type: an #AtkObject #GType
 124  *@factory_type: an #AtkObjectFactory #GType to associate with @type
 125  *
 126  *Associate an #AtkObjectFactory subclass with a #GType. Note:
 127  * The associated @factory_type will thereafter be responsible for
 128  * the creation of new #AtkObject implementations for instances
 129  * of type @type.
 130  **/
 131 void
 132 atk_registry_set_factory_type (AtkRegistry *registry,
 133                                GType type,
 134                                GType factory_type)
 135 {
 136   GType old_type;
 137   gpointer value;
 138   AtkObjectFactory *old_factory;
 139
 140   g_return_if_fail (ATK_IS_REGISTRY (registry));
 141
 142   value = g_hash_table_lookup (registry->factory_type_registry,
 143                                   GUINT_TO_POINTER (type));
 144   old_type = GPOINTER_TO_UINT (value);
 145   if (old_type && old_type != factory_type)
 146     {
 147       g_hash_table_remove (registry->factory_type_registry,
 148                            GUINT_TO_POINTER (type));
 149       /*
 150        * If the old factory was created, notify it that it has
 151        * been replaced, then free it.
 152        */
 153       old_factory = g_hash_table_lookup (registry->factory_singleton_cache,
 154                                          GUINT_TO_POINTER (old_type));
 155       if (old_factory)
 156         {
 157           atk_object_factory_invalidate (old_factory);
 158           g_type_free_instance ((GTypeInstance *) old_factory);
 159         }
 160     }
 161   g_hash_table_insert (registry->factory_type_registry,
 162                        GUINT_TO_POINTER (type),
 163                        GUINT_TO_POINTER (factory_type));
 164 }
 165
 166 /**
 167  *atk_registry_get_factory_type:
 168  *@registry: an #AtkRegistry
 169  *@type: a #GType with which to look up the associated #AtkObjectFactory
 170  * subclass
 171  *
 172  *Provides a GType indicating the #AtkObjectFactory subclass
 173  * associated with type @type
 174  *
 175  *Returns: a GType indicating the AtkObjectFactory subclass
 176  * associated with type @type
 177  **/
 178 GType
 179 atk_registry_get_factory_type (AtkRegistry *registry,
 180                                GType type)
 181 {
 182   GType factory_type;
 183   gpointer value;
 184
 185   /*
 186    * look up factory type in first hash;
 187    * if there isn't an explicitly registered factory type,
 188    * try inheriting one...
 189    */
 190   do {
 191     value =
 192         g_hash_table_lookup (registry->factory_type_registry,
 193                              GUINT_TO_POINTER (type));
 194     type = g_type_parent (type);
 195     if (type == G_TYPE_INVALID)
 196       {
 197         break;
 198       }
 199   } while (value == NULL);
 200
 201   factory_type = GPOINTER_TO_UINT (value);
 202   return factory_type;
 203 }
 204
 205 /**
 206  *atk_registry_get_factory:
 207  *@registry: an #AtkRegistry
 208  *@type: a #GType with which to look up the associated #AtkObjectFactory
 209  *
 210  *Returns an #AtkObjectFactory appropriate for creating #AtkObjects
 211  * of type @type.
 212  *
 213  *Returns: an #AtkObjectFactory appropriate for creating #AtkObjects
 214  * of type @type.
 215  **/
 216 AtkObjectFactory*
 217 atk_registry_get_factory (AtkRegistry *registry,
 218                           GType type)
 219 {
 220   gpointer factory_pointer = NULL;
 221   GType factory_type;
 222
 223   factory_type = atk_registry_get_factory_type (registry, type);
 224
 225   if (factory_type == G_TYPE_INVALID)
 226   {
 227   /* Factory type has not been specified for this object type */
 228     static AtkObjectFactory* default_factory = NULL;
 229
 230     if (!default_factory)
 231       default_factory = atk_no_op_object_factory_new ();
 232
 233     return default_factory;
 234   }
 235
 236   /* ask second hashtable for instance of factory type */
 237   factory_pointer =
 238         g_hash_table_lookup (registry->factory_singleton_cache,
 239         GUINT_TO_POINTER (factory_type));
 240
 241   /* if there isn't one already, create one and save it */
 242   if (factory_pointer == NULL)
 243     {
 244       factory_pointer = g_type_create_instance (factory_type);
 245       g_hash_table_insert (registry->factory_singleton_cache,
 246                            GUINT_TO_POINTER (factory_type),
 247                            factory_pointer);
 248     }
 249
 250   return ATK_OBJECT_FACTORY (factory_pointer);
 251 }
 252
 253 /**
 254  *atk_get_default_registry:
 255  *
 256  *Return a default implementation of the #AtkObjectFactory/type
 257  * registry.
 258  *Note: For most toolkit maintainers, this will be the correct
 259  * registry for registering new #AtkObject factories. Following
 260  * a call to this function, maintainers may call atk_registry_set_factory_type()
 261  * to associate an #AtkObjectFactory subclass with the GType of objects
 262  * for whom accessability information will be provided.
 263  *
 264  *Returns: a default implementation of the #AtkObjectFactory/type
 265  * registry
 266  **/
 267 AtkRegistry*
 268 atk_get_default_registry ()
 269 {
 270   if (!default_registry)
 271   {
 272     default_registry = atk_registry_new();
 273   }
 274   return default_registry;
 275 }