Pileus Git - ~andy/gtk/blob - gtk/gtkbuilder.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1998-2002 James Henstridge <james@daa.com.au>
   3  * Copyright (C) 2006-2007 Async Open Source,
   4  *                         Johan Dahlin <jdahlin@async.com.br>,
   5  *                         Henrique Romano <henrique@async.com.br>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include <config.h>
  24 #include <errno.h> /* errno */
  25 #include <stdlib.h> /* strtol, strtoul */
  26 #include <string.h> /* strlen */
  27
  28 #include "gtkbuilder.h"
  29 #include "gtkbuildable.h"
  30 #include "gtkbuilderprivate.h"
  31 #include "gtkmain.h"
  32 #include "gtkintl.h"
  33 #include "gtkprivate.h"
  34 #include "gtktypebuiltins.h"
  35 #include "gtkwindow.h"
  36 #include "gtkicontheme.h"
  37 #include "gtkstock.h"
  38 #include "gtkalias.h"
  39
  40 static void gtk_builder_class_init     (GtkBuilderClass *klass);
  41 static void gtk_builder_init           (GtkBuilder      *builder);
  42 static void gtk_builder_finalize       (GObject         *object);
  43 static void gtk_builder_set_property   (GObject         *object,
  44                                         guint            prop_id,
  45                                         const GValue    *value,
  46                                         GParamSpec      *pspec);
  47 static void gtk_builder_get_property   (GObject         *object,
  48                                         guint            prop_id,
  49                                         GValue          *value,
  50                                         GParamSpec      *pspec);
  51 static GType gtk_builder_real_get_type_from_name (GtkBuilder  *builder,
  52                                                   const gchar *type_name);
  53 static gboolean _gtk_builder_enum_from_string (GType         type,
  54                                                const gchar  *string,
  55                                                gint         *enum_value,
  56                                                GError      **error);
  57
  58
  59 enum {
  60   PROP_0,
  61   PROP_TRANSLATION_DOMAIN,
  62 };
  63
  64 struct _GtkBuilderPrivate
  65 {
  66   gchar *domain;
  67   GHashTable *objects;
  68   GSList *delayed_properties;
  69   GSList *signals;
  70   gchar *filename;
  71 };
  72
  73 G_DEFINE_TYPE (GtkBuilder, gtk_builder, G_TYPE_OBJECT)
  74
  75 static void
  76 gtk_builder_class_init (GtkBuilderClass *klass)
  77 {
  78   GObjectClass *gobject_class;
  79
  80   gobject_class = G_OBJECT_CLASS (klass);
  81
  82   gobject_class->finalize = gtk_builder_finalize;
  83   gobject_class->set_property = gtk_builder_set_property;
  84   gobject_class->get_property = gtk_builder_get_property;
  85
  86   klass->get_type_from_name = gtk_builder_real_get_type_from_name;
  87
  88  /**
  89   * GtkBuilder:translation-domain:
  90   *
  91   * The translation domain used when translating property values that
  92   * have been marked as translatable in interface descriptions.
  93   * If the translation domain is %NULL, #GtkBuilder uses gettext(),
  94   * otherwise dgettext().
  95   *
  96   * Since: 2.12
  97   */
  98   g_object_class_install_property (gobject_class,
  99                                    PROP_TRANSLATION_DOMAIN,
 100                                    g_param_spec_string ("translation-domain",
 101                                                         P_("Translation Domain"),
 102                                                         P_("The translation domain used by gettext"),
 103                                                         NULL,
 104                                                         GTK_PARAM_READWRITE));
 105
 106   g_type_class_add_private (gobject_class, sizeof (GtkBuilderPrivate));
 107 }
 108
 109 static void
 110 gtk_builder_init (GtkBuilder *builder)
 111 {
 112   builder->priv = G_TYPE_INSTANCE_GET_PRIVATE (builder, GTK_TYPE_BUILDER,
 113                                                GtkBuilderPrivate);
 114   builder->priv->domain = NULL;
 115   builder->priv->objects = g_hash_table_new_full (g_str_hash, g_str_equal,
 116                                                   g_free, g_object_unref);
 117 }
 118
 119
 120 /*
 121  * GObject virtual methods
 122  */
 123
 124 static void
 125 gtk_builder_finalize (GObject *object)
 126 {
 127   GtkBuilderPrivate *priv = GTK_BUILDER (object)->priv;
 128
 129   g_free (priv->domain);
 130   g_free (priv->filename);
 131
 132   g_hash_table_destroy (priv->objects);
 133
 134   g_slist_foreach (priv->signals, (GFunc) _free_signal_info, NULL);
 135   g_slist_free (priv->signals);
 136
 137   G_OBJECT_CLASS (gtk_builder_parent_class)->finalize (object);
 138 }
 139
 140 static void
 141 gtk_builder_set_property (GObject      *object,
 142                           guint         prop_id,
 143                           const GValue *value,
 144                           GParamSpec   *pspec)
 145 {
 146   GtkBuilder *builder = GTK_BUILDER (object);
 147
 148   switch (prop_id)
 149     {
 150     case PROP_TRANSLATION_DOMAIN:
 151       gtk_builder_set_translation_domain (builder, g_value_get_string (value));
 152       break;
 153     default:
 154       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 155       break;
 156     }
 157 }
 158
 159 static void
 160 gtk_builder_get_property (GObject    *object,
 161                           guint       prop_id,
 162                           GValue     *value,
 163                           GParamSpec *pspec)
 164 {
 165   GtkBuilder *builder = GTK_BUILDER (object);
 166
 167   switch (prop_id)
 168     {
 169     case PROP_TRANSLATION_DOMAIN:
 170       g_value_set_string (value, builder->priv->domain);
 171       break;
 172     default:
 173       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 174       break;
 175     }
 176 }
 177
 178
 179 /*
 180  * Try to map a type name to a _get_type function
 181  * and call it, eg:
 182  *
 183  * GtkWindow -> gtk_window_get_type
 184  * GtkHBox -> gtk_hbox_get_type
 185  * GtkUIManager -> gtk_ui_manager_get_type
 186  *
 187  */
 188 static GType
 189 _gtk_builder_resolve_type_lazily (const gchar *name)
 190 {
 191   static GModule *module = NULL;
 192   GTypeGetFunc func;
 193   GString *symbol_name = g_string_new ("");
 194   char c, *symbol;
 195   int i;
 196   GType gtype = G_TYPE_INVALID;
 197
 198   if (!module)
 199     module = g_module_open (NULL, 0);
 200
 201   for (i = 0; name[i] != '\0'; i++)
 202     {
 203       c = name[i];
 204       /* skip if uppercase, first or previous is uppercase */
 205       if ((c == g_ascii_toupper (c) &&
 206            i > 0 && name[i-1] != g_ascii_toupper (name[i-1])) ||
 207           (i > 2 && name[i]   == g_ascii_toupper (name[i]) &&
 208            name[i-1] == g_ascii_toupper (name[i-1]) &&
 209            name[i-2] == g_ascii_toupper (name[i-2])))
 210         g_string_append_c (symbol_name, '_');
 211       g_string_append_c (symbol_name, g_ascii_tolower (c));
 212     }
 213   g_string_append (symbol_name, "_get_type");
 214
 215   symbol = g_string_free (symbol_name, FALSE);
 216
 217   if (g_module_symbol (module, symbol, (gpointer)&func))
 218     gtype = func ();
 219
 220   g_free (symbol);
 221
 222   return gtype;
 223 }
 224
 225 /*
 226  * GtkBuilder virtual methods
 227  */
 228
 229 static GType
 230 gtk_builder_real_get_type_from_name (GtkBuilder  *builder,
 231                                      const gchar *type_name)
 232 {
 233   GType gtype;
 234
 235   gtype = g_type_from_name (type_name);
 236   if (gtype != G_TYPE_INVALID)
 237     return gtype;
 238
 239   return _gtk_builder_resolve_type_lazily (type_name);
 240 }
 241
 242 typedef struct
 243 {
 244   gchar *object;
 245   gchar *name;
 246   gchar *value;
 247 } DelayedProperty;
 248
 249 static void
 250 gtk_builder_get_parameters (GtkBuilder  *builder,
 251                             GType        object_type,
 252                             const gchar *object_name,
 253                             GSList      *properties,
 254                             GArray      **parameters,
 255                             GArray      **construct_parameters)
 256 {
 257   GSList *l;
 258   GParamSpec *pspec;
 259   GObjectClass *oclass;
 260   DelayedProperty *property;
 261   GError *error = NULL;
 262
 263   oclass = g_type_class_ref (object_type);
 264   g_assert (oclass != NULL);
 265
 266   *parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
 267   *construct_parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
 268
 269   for (l = properties; l; l = l->next)
 270     {
 271       PropertyInfo *prop = (PropertyInfo*)l->data;
 272       GParameter parameter = { NULL };
 273
 274       pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
 275                                             prop->name);
 276       if (!pspec)
 277         {
 278           g_warning ("Unknown property: %s.%s",
 279                      g_type_name (object_type), prop->name);
 280           continue;
 281         }
 282
 283       parameter.name = prop->name;
 284
 285       if (G_IS_PARAM_SPEC_OBJECT (pspec) &&
 286           (G_PARAM_SPEC_VALUE_TYPE (pspec) != GDK_TYPE_PIXBUF))
 287         {
 288           if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
 289             {
 290               GObject *object;
 291               object = gtk_builder_get_object (builder, prop->data);
 292               if (!object)
 293                 {
 294                   g_warning ("Failed to get constuct only property "
 295                              "%s of %s with value `%s'",
 296                              prop->name, object_name, prop->data);
 297                   continue;
 298                 }
 299               g_value_init (&parameter.value, G_OBJECT_TYPE (object));
 300               g_value_set_object (&parameter.value, object);
 301             }
 302           else
 303             {
 304               property = g_slice_new (DelayedProperty);
 305               property->object = g_strdup (object_name);
 306               property->name = g_strdup (prop->name);
 307               property->value = g_strdup (prop->data);
 308               builder->priv->delayed_properties =
 309                 g_slist_prepend (builder->priv->delayed_properties, property);
 310
 311               continue;
 312             }
 313         }
 314       else if (!gtk_builder_value_from_string (builder, pspec,
 315                                                prop->data, &parameter.value, &error))
 316         {
 317           g_warning ("Failed to set property %s.%s to %s: %s",
 318                      g_type_name (object_type), prop->name, prop->data,
 319                      error->message);
 320           g_error_free (error);
 321           error = NULL;
 322           continue;
 323         }
 324
 325       if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
 326         g_array_append_val (*construct_parameters, parameter);
 327       else
 328         g_array_append_val (*parameters, parameter);
 329     }
 330
 331   g_type_class_unref (oclass);
 332 }
 333
 334 static GObject *
 335 gtk_builder_get_internal_child (GtkBuilder  *builder,
 336                                 ObjectInfo  *info,
 337                                 const gchar *childname)
 338 {
 339   GObject *obj = NULL;
 340
 341   while (!obj)
 342     {
 343       if (!info->parent)
 344         break;
 345
 346       info = (ObjectInfo*)((ChildInfo*)info->parent)->parent;
 347       if (!info)
 348         break;
 349
 350       GTK_NOTE (BUILDER,
 351                 g_print ("Trying to get internal child %s from %s\n",
 352                          childname,
 353                          gtk_buildable_get_name (GTK_BUILDABLE (info->object))));
 354
 355       if (GTK_IS_BUILDABLE (info->object))
 356           obj = gtk_buildable_get_internal_child (GTK_BUILDABLE (info->object),
 357                                                   builder,
 358                                                   childname);
 359     };
 360
 361   if (!obj)
 362     g_error ("Unknown internal child: %s\n", childname);
 363
 364   return obj;
 365 }
 366
 367 GObject *
 368 _gtk_builder_construct (GtkBuilder *builder,
 369                         ObjectInfo *info)
 370 {
 371   GArray *parameters, *construct_parameters;
 372   GType object_type;
 373   GObject *obj;
 374   int i;
 375   GtkBuildableIface *iface;
 376   gboolean custom_set_property;
 377   GtkBuildable *buildable;
 378
 379   g_assert (info->class_name != NULL);
 380   object_type = gtk_builder_get_type_from_name (builder, info->class_name);
 381   if (object_type == G_TYPE_INVALID)
 382     g_error ("Invalid type: %s", info->class_name);
 383
 384   gtk_builder_get_parameters (builder, object_type,
 385                               info->id,
 386                               info->properties,
 387                               &parameters,
 388                               &construct_parameters);
 389
 390   if (info->constructor)
 391     {
 392       GObject *constructor;
 393
 394       constructor = gtk_builder_get_object (builder, info->constructor);
 395       if (constructor == NULL)
 396         g_error ("Unknown constructor for %s: %s\n", info->id,
 397                  info->constructor);
 398
 399       obj = gtk_buildable_construct_child (GTK_BUILDABLE (constructor),
 400                                            builder,
 401                                            info->id);
 402       g_assert (obj != NULL);
 403       if (construct_parameters->len)
 404         g_warning ("Can't pass in construct-only parameters to %s", info->id);
 405     }
 406   else if (info->parent && ((ChildInfo*)info->parent)->internal_child != NULL)
 407     {
 408       gchar *childname = ((ChildInfo*)info->parent)->internal_child;
 409       obj = gtk_builder_get_internal_child (builder, info, childname);
 410       if (construct_parameters->len)
 411         g_warning ("Can't pass in construct-only parameters to %s", childname);
 412       g_object_ref (obj);
 413     }
 414   else
 415     {
 416       obj = g_object_newv (object_type,
 417                            construct_parameters->len,
 418                            (GParameter *)construct_parameters->data);
 419
 420       /* No matter what, make sure we have a reference.
 421        *
 422        * If it's an initially unowned object, sink it.
 423        * If it's not initially unowned then we have the reference already.
 424        *
 425        * In the case that this is a window it will be sunk already and
 426        * this is effectively a call to g_object_ref().  That's what
 427        * we want.
 428        */
 429       if (G_IS_INITIALLY_UNOWNED (obj))
 430         g_object_ref_sink (obj);
 431
 432       GTK_NOTE (BUILDER,
 433                 g_print ("created %s of type %s\n", info->id, info->class_name));
 434
 435       for (i = 0; i < construct_parameters->len; i++)
 436         {
 437           GParameter *param = &g_array_index (construct_parameters,
 438                                               GParameter, i);
 439           g_value_unset (&param->value);
 440         }
 441     }
 442   g_array_free (construct_parameters, TRUE);
 443
 444   custom_set_property = FALSE;
 445   buildable = NULL;
 446   iface = NULL;
 447   if (GTK_IS_BUILDABLE (obj))
 448     {
 449       buildable = GTK_BUILDABLE (obj);
 450       iface = GTK_BUILDABLE_GET_IFACE (obj);
 451       if (iface->set_buildable_property)
 452         custom_set_property = TRUE;
 453     }
 454
 455   for (i = 0; i < parameters->len; i++)
 456     {
 457       GParameter *param = &g_array_index (parameters, GParameter, i);
 458       if (custom_set_property)
 459         iface->set_buildable_property (buildable, builder, param->name, &param->value);
 460       else
 461         g_object_set_property (obj, param->name, &param->value);
 462
 463 #if G_ENABLE_DEBUG
 464       if (gtk_debug_flags & GTK_DEBUG_BUILDER)
 465         {
 466           gchar *str = g_strdup_value_contents ((const GValue*)&param->value);
 467           g_print ("set %s: %s = %s\n", info->id, param->name, str);
 468           g_free (str);
 469         }
 470 #endif
 471       g_value_unset (&param->value);
 472     }
 473   g_array_free (parameters, TRUE);
 474
 475   if (GTK_IS_BUILDABLE (obj))
 476     gtk_buildable_set_name (buildable, info->id);
 477   else
 478     g_object_set_data_full (obj,
 479                             "gtk-builder-name",
 480                             g_strdup (info->id),
 481                             g_free);
 482
 483   /* we already own a reference to obj.  put it in the hash table. */
 484   g_hash_table_insert (builder->priv->objects, g_strdup (info->id), obj);
 485
 486   return obj;
 487 }
 488
 489
 490 void
 491 _gtk_builder_add (GtkBuilder *builder,
 492                   ChildInfo  *child_info)
 493 {
 494   GObject *object;
 495   GObject *parent;
 496
 497   /* Internal children are already added
 498    * Also prevent us from being called twice.
 499    */
 500   if (!child_info ||
 501       child_info->internal_child ||
 502       child_info->added)
 503     return;
 504
 505   object = child_info->object;
 506   if (!object)
 507     return;
 508
 509   if (!child_info->parent)
 510     {
 511       g_warning ("%s: Not adding, No parent",
 512                  gtk_buildable_get_name (GTK_BUILDABLE (object)));
 513       return;
 514     }
 515
 516   g_assert (object != NULL);
 517
 518   parent = ((ObjectInfo*)child_info->parent)->object;
 519   g_assert (GTK_IS_BUILDABLE (parent));
 520
 521   GTK_NOTE (BUILDER,
 522             g_print ("adding %s to %s\n",
 523                      gtk_buildable_get_name (GTK_BUILDABLE (object)),
 524                      gtk_buildable_get_name (GTK_BUILDABLE (parent))));
 525
 526   gtk_buildable_add_child (GTK_BUILDABLE (parent), builder, object,
 527                            child_info->type);
 528
 529   child_info->added = TRUE;
 530 }
 531
 532 void
 533 _gtk_builder_add_signals (GtkBuilder *builder,
 534                           GSList     *signals)
 535 {
 536   builder->priv->signals = g_slist_concat (builder->priv->signals,
 537                                            g_slist_copy (signals));
 538 }
 539
 540 static void
 541 gtk_builder_apply_delayed_properties (GtkBuilder *builder)
 542 {
 543   GSList *l, *props;
 544   DelayedProperty *property;
 545   GObject *object;
 546   GType object_type;
 547   GObjectClass *oclass;
 548   GParamSpec *pspec;
 549
 550   /* take the list over from the builder->priv.
 551    *
 552    * g_slist_reverse does not copy the list, so the list now
 553    * belongs to us (and we free it at the end of this function).
 554    */
 555   props = g_slist_reverse (builder->priv->delayed_properties);
 556   builder->priv->delayed_properties = NULL;
 557
 558   for (l = props; l; l = l->next)
 559     {
 560       property = (DelayedProperty*)l->data;
 561       object = g_hash_table_lookup (builder->priv->objects, property->object);
 562       g_assert (object != NULL);
 563
 564       object_type = G_OBJECT_TYPE (object);
 565       g_assert (object_type != G_TYPE_INVALID);
 566
 567       oclass = g_type_class_ref (object_type);
 568       g_assert (oclass != NULL);
 569
 570       pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
 571                                             property->name);
 572       if (!pspec)
 573         g_warning ("Unknown property: %s.%s", g_type_name (object_type),
 574                    property->name);
 575       else
 576         {
 577           GObject *obj;
 578
 579           obj = g_hash_table_lookup (builder->priv->objects, property->value);
 580           if (!obj)
 581             g_warning ("No object called: %s", property->value);
 582           else
 583             g_object_set (object, property->name, obj, NULL);
 584         }
 585       g_free (property->value);
 586       g_free (property->object);
 587       g_free (property->name);
 588       g_slice_free (DelayedProperty, property);
 589       g_type_class_unref (oclass);
 590     }
 591   g_slist_free (props);
 592 }
 593
 594 void
 595 _gtk_builder_finish (GtkBuilder *builder)
 596 {
 597   gtk_builder_apply_delayed_properties (builder);
 598 }
 599
 600 /**
 601  * gtk_builder_new:
 602  *
 603  * Creates a new builder object.
 604  *
 605  * Return value: a new #GtkBuilder object
 606  *
 607  * Since: 2.12
 608  **/
 609 GtkBuilder *
 610 gtk_builder_new (void)
 611 {
 612   return g_object_new (GTK_TYPE_BUILDER, NULL);
 613 }
 614
 615 /**
 616  * gtk_builder_add_from_file:
 617  * @builder: a #GtkBuilder
 618  * @filename: the name of the file to parse
 619  * @error: return location for an error, or %NULL
 620  *
 621  * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
 622  * UI definition</link> and merges it with the current contents of @builder.
 623  *
 624  * Returns: A positive value on success, 0 if an error occurred
 625  *
 626  * Since: 2.12
 627  **/
 628 guint
 629 gtk_builder_add_from_file (GtkBuilder   *builder,
 630                            const gchar  *filename,
 631                            GError      **error)
 632 {
 633   gchar *buffer;
 634   gsize length;
 635   GError *tmp_error;
 636
 637   g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
 638   g_return_val_if_fail (filename != NULL, 0);
 639
 640   tmp_error = NULL;
 641
 642   if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
 643     {
 644       g_propagate_error (error, tmp_error);
 645       return 0;
 646     }
 647
 648   g_free (builder->priv->filename);
 649   builder->priv->filename = g_strdup (filename);
 650
 651   _gtk_builder_parser_parse_buffer (builder, filename,
 652                                     buffer, length,
 653                                     &tmp_error);
 654
 655   g_free (buffer);
 656
 657   if (tmp_error != NULL)
 658     {
 659       g_propagate_error (error, tmp_error);
 660       return 0;
 661     }
 662
 663   return 1;
 664 }
 665
 666 /**
 667  * gtk_builder_add_from_string:
 668  * @builder: a #GtkBuilder
 669  * @buffer: the string to parse
 670  * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
 671  * @error: return location for an error, or %NULL
 672  *
 673  * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
 674  * UI definition</link> and merges it with the current contents of @builder.
 675  *
 676  * Returns: A positive value on success, 0 if an error occurred
 677  *
 678  * Since: 2.12
 679  **/
 680 guint
 681 gtk_builder_add_from_string (GtkBuilder   *builder,
 682                              const gchar  *buffer,
 683                              gsize         length,
 684                              GError      **error)
 685 {
 686   GError *tmp_error;
 687
 688   g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
 689   g_return_val_if_fail (buffer != NULL, 0);
 690
 691   tmp_error = NULL;
 692
 693   g_free (builder->priv->filename);
 694   builder->priv->filename = g_strdup (".");
 695
 696   _gtk_builder_parser_parse_buffer (builder, "<input>",
 697                                     buffer, length,
 698                                     &tmp_error);
 699   if (tmp_error != NULL)
 700     {
 701       g_propagate_error (error, tmp_error);
 702       return 0;
 703     }
 704
 705   return 1;
 706 }
 707
 708 /**
 709  * gtk_builder_get_object:
 710  * @builder: a #GtkBuilder
 711  * @name: name of object to get
 712  *
 713  * Gets the object named @name. Note that this function does not
 714  * increment the reference count of the returned object.
 715  *
 716  * Return value: the object named @name or %NULL if it could not be
 717  *    found in the object tree.
 718  *
 719  * Since: 2.12
 720  **/
 721 GObject *
 722 gtk_builder_get_object (GtkBuilder  *builder,
 723                         const gchar *name)
 724 {
 725   g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
 726   g_return_val_if_fail (name != NULL, NULL);
 727
 728   return g_hash_table_lookup (builder->priv->objects, name);
 729 }
 730
 731 static void
 732 object_add_to_list (gchar    *object_id,
 733                     GObject  *object,
 734                     GSList  **list)
 735 {
 736   *list = g_slist_prepend (*list, object);
 737 }
 738
 739 /**
 740  * gtk_builder_get_objects:
 741  * @builder: a #GtkBuilder
 742  *
 743  * Gets all objects that have been constructed by @builder. Note that
 744  * this function does not increment the reference counts of the returned
 745  * objects.
 746  *
 747  * Return value: a newly-allocated #GSList containing all the objects
 748  *   constructed by the #GtkBuilder instance. It should be freed by
 749  *   g_slist_free()
 750  *
 751  * Since: 2.12
 752  **/
 753 GSList *
 754 gtk_builder_get_objects (GtkBuilder *builder)
 755 {
 756   GSList *objects = NULL;
 757
 758   g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
 759
 760   g_hash_table_foreach (builder->priv->objects, (GHFunc)object_add_to_list, &objects);
 761
 762   return g_slist_reverse (objects);
 763 }
 764
 765 /**
 766  * gtk_builder_set_translation_domain:
 767  * @builder: a #GtkBuilder
 768  * @domain: the translation domain or %NULL
 769  *
 770  * Sets the translation domain of @builder.
 771  * See #GtkBuilder:translation-domain.
 772  *
 773  * Since: 2.12
 774  **/
 775 void
 776 gtk_builder_set_translation_domain (GtkBuilder  *builder,
 777                                     const gchar *domain)
 778 {
 779   gchar *new_domain;
 780
 781   g_return_if_fail (GTK_IS_BUILDER (builder));
 782
 783   new_domain = g_strdup (domain);
 784   g_free (builder->priv->domain);
 785   builder->priv->domain = new_domain;
 786
 787   g_object_notify (G_OBJECT (builder), "translation-domain");
 788 }
 789
 790 /**
 791  * gtk_builder_get_translation_domain:
 792  * @builder: a #GtkBuilder
 793  *
 794  * Gets the translation domain of @builder.
 795  *
 796  * Return value: the translation domain. This string is owned
 797  * by the builder object and must not be modified or freed.
 798  *
 799  * Since: 2.12
 800  **/
 801 const gchar *
 802 gtk_builder_get_translation_domain (GtkBuilder *builder)
 803 {
 804   g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
 805
 806   return builder->priv->domain;
 807 }
 808
 809 typedef struct {
 810   GModule *module;
 811   gpointer data;
 812 } connect_args;
 813
 814 static void
 815 gtk_builder_connect_signals_default (GtkBuilder    *builder,
 816                                      GObject       *object,
 817                                      const gchar   *signal_name,
 818                                      const gchar   *handler_name,
 819                                      GObject       *connect_object,
 820                                      GConnectFlags  flags,
 821                                      gpointer       user_data)
 822 {
 823   GCallback func;
 824   connect_args *args = (connect_args*)user_data;
 825
 826   if (!g_module_symbol (args->module, handler_name, (gpointer)&func))
 827     {
 828       g_warning ("Could not find signal handler '%s'", handler_name);
 829       return;
 830     }
 831
 832   if (connect_object)
 833     g_signal_connect_object (object, signal_name, func, connect_object, flags);
 834   else
 835     g_signal_connect_data (object, signal_name, func, args->data, NULL, flags);
 836 }
 837
 838
 839 /**
 840  * gtk_builder_connect_signals:
 841  * @builder: a #GtkBuilder
 842  * @user_data: a pointer to a structure sent in as user data to all signals
 843  *
 844  * This method is a simpler variation of gtk_builder_connect_signals_full().
 845  * It uses #GModule's introspective features (by opening the module %NULL)
 846  * to look at the application's symbol table. From here it tries to match
 847  * the signal handler names given in the interface description with
 848  * symbols in the application and connects the signals.
 849  *
 850  * Note that this function will not work correctly if #GModule is not
 851  * supported on the platform.
 852  *
 853  * Since: 2.12
 854  **/
 855 void
 856 gtk_builder_connect_signals (GtkBuilder *builder,
 857                              gpointer    user_data)
 858 {
 859   connect_args *args;
 860
 861   g_return_if_fail (GTK_IS_BUILDER (builder));
 862
 863   if (!g_module_supported ())
 864     g_error ("gtk_builder_connect_signals() requires working GModule");
 865
 866   args = g_slice_new0 (connect_args);
 867   args->module = g_module_open (NULL, G_MODULE_BIND_LAZY);
 868   args->data = user_data;
 869
 870   gtk_builder_connect_signals_full (builder,
 871                                     gtk_builder_connect_signals_default,
 872                                     args);
 873   g_module_close (args->module);
 874
 875   g_slice_free (connect_args, args);
 876 }
 877
 878 /**
 879  * GtkBuilderConnectFunc:
 880  * @builder: a #GtkBuilder
 881  * @object: object to connect a signal to
 882  * @signal_name: name of the signal
 883  * @handler_name: name of the handler
 884  * @connect_object: a #GObject, if non-%NULL, use g_signal_connect_object()
 885  * @flags: #GConnectFlags to use
 886  * @user_data: user data
 887  *
 888  * This is the signature of a function used to connect signals.  It is used
 889  * by the gtk_builder_connect_signals() and gtk_builder_connect_signals_full()
 890  * methods.  It is mainly intended for interpreted language bindings, but
 891  * could be useful where the programmer wants more control over the signal
 892  * connection process.
 893  *
 894  * Since: 2.12
 895  */
 896
 897 /**
 898  * gtk_builder_connect_signals_full:
 899  * @builder: a #GtkBuilder
 900  * @func: the function used to connect the signals
 901  * @user_data: arbitrary data that will be passed to the connection function
 902  *
 903  * This function can be thought of the interpreted language binding
 904  * version of gtk_builder_connect_signals(), except that it does not
 905  * require GModule to function correctly.
 906  *
 907  * Since: 2.12
 908  */
 909 void
 910 gtk_builder_connect_signals_full (GtkBuilder            *builder,
 911                                   GtkBuilderConnectFunc  func,
 912                                   gpointer               user_data)
 913 {
 914   GSList *l;
 915   GObject *object;
 916   GObject *connect_object;
 917
 918   g_return_if_fail (GTK_IS_BUILDER (builder));
 919   g_return_if_fail (func != NULL);
 920
 921   if (!builder->priv->signals)
 922     return;
 923
 924   builder->priv->signals = g_slist_reverse (builder->priv->signals);
 925   for (l = builder->priv->signals; l; l = l->next)
 926     {
 927       SignalInfo *signal = (SignalInfo*)l->data;
 928
 929       g_assert (signal != NULL);
 930       g_assert (signal->name != NULL);
 931
 932       object = g_hash_table_lookup (builder->priv->objects,
 933                                     signal->object_name);
 934       g_assert (object != NULL);
 935
 936       connect_object = NULL;
 937
 938       if (signal->connect_object_name)
 939         {
 940           connect_object = g_hash_table_lookup (builder->priv->objects,
 941                                                 signal->connect_object_name);
 942           if (!connect_object)
 943               g_warning ("Could not lookup object %s on signal %s of object %s",
 944                          signal->connect_object_name, signal->name,
 945                          signal->object_name);
 946         }
 947
 948       func (builder, object, signal->name, signal->handler,
 949             connect_object, signal->flags, user_data);
 950     }
 951
 952   g_slist_foreach (builder->priv->signals, (GFunc)_free_signal_info, NULL);
 953   g_slist_free (builder->priv->signals);
 954   builder->priv->signals = NULL;
 955 }
 956
 957 /**
 958  * gtk_builder_value_from_string:
 959  * @builder: a #GtkBuilder
 960  * @pspec: the #GParamSpec for the property
 961  * @string: the string representation of the value
 962  * @value: the #GValue to store the result in
 963  * @error: return location for an error, or %NULL
 964  *
 965  * This function demarshals a value from a string. This function
 966  * calls g_value_init() on the @value argument, so it need not be
 967  * initialised beforehand.
 968  *
 969  * This function can handle char, uchar, boolean, int, uint, long,
 970  * ulong, enum, flags, float, double, string, #GdkColor and
 971  * #GtkAdjustment type values. Support for #GtkWidget type values is
 972  * still to come.
 973  *
 974  * Returns: %TRUE on success
 975  *
 976  * Since: 2.12
 977  */
 978 gboolean
 979 gtk_builder_value_from_string (GtkBuilder   *builder,
 980                                GParamSpec   *pspec,
 981                                const gchar  *string,
 982                                GValue       *value,
 983                                GError      **error)
 984 {
 985   /*
 986    * GParamSpecUnichar has the internal type G_TYPE_UINT,
 987    * so we cannot handle this in the switch, do it separately
 988    */
 989   if (G_IS_PARAM_SPEC_UNICHAR (pspec))
 990     {
 991       gunichar c;
 992       g_value_init (value, G_TYPE_UINT);
 993       c = g_utf8_get_char_validated (string, strlen (string));
 994       if (c > 0)
 995         g_value_set_uint (value, c);
 996       return TRUE;
 997     }
 998
 999   return gtk_builder_value_from_string_type (builder,
1000                                              G_PARAM_SPEC_VALUE_TYPE (pspec),
1001                                              string, value, error);
1002 }
1003
1004 /**
1005  * gtk_builder_value_from_string_type:
1006  * @builder: a #GtkBuilder
1007  * @type: the #GType of the value
1008  * @string: the string representation of the value
1009  * @value: the #GValue to store the result in
1010  * @error: return location for an error, or %NULL
1011  *
1012  * Like gtk_builder_value_from_string(), this function demarshals
1013  * a value from a string, but takes a #GType instead of #GParamSpec.
1014  * This function calls g_value_init() on the @value argument, so it
1015  * need not be initialised beforehand.
1016  *
1017  * Returns: %TRUE on success
1018  *
1019  * Since: 2.12
1020  */
1021 gboolean
1022 gtk_builder_value_from_string_type (GtkBuilder   *builder,
1023                                     GType         type,
1024                                     const gchar  *string,
1025                                     GValue       *value,
1026                                     GError      **error)
1027 {
1028   gboolean ret = TRUE;
1029
1030   g_return_val_if_fail (type != G_TYPE_INVALID, FALSE);
1031   g_return_val_if_fail (string != NULL, FALSE);
1032
1033   g_value_init (value, type);
1034
1035   switch (G_TYPE_FUNDAMENTAL (type))
1036     {
1037     case G_TYPE_CHAR:
1038       g_value_set_char (value, string[0]);
1039       break;
1040     case G_TYPE_UCHAR:
1041       g_value_set_uchar (value, (guchar)string[0]);
1042       break;
1043     case G_TYPE_BOOLEAN:
1044       {
1045         gboolean b;
1046
1047         if (!_gtk_builder_boolean_from_string (string, &b, error))
1048           {
1049             ret = FALSE;
1050             break;
1051           }
1052         g_value_set_boolean (value, b);
1053         break;
1054       }
1055     case G_TYPE_INT:
1056     case G_TYPE_LONG:
1057       {
1058         long l;
1059         gchar *endptr;
1060         errno = 0;
1061         l = strtol (string, &endptr, 0);
1062         if (errno || endptr == string)
1063           {
1064             g_set_error (error,
1065                          GTK_BUILDER_ERROR,
1066                          GTK_BUILDER_ERROR_INVALID_VALUE,
1067                          "Could not parse integer `%s'",
1068                          string);
1069             ret = FALSE;
1070             break;
1071           }
1072         if (G_VALUE_HOLDS_INT (value))
1073           g_value_set_int (value, l);
1074         else
1075           g_value_set_long (value, l);
1076         break;
1077       }
1078     case G_TYPE_UINT:
1079     case G_TYPE_ULONG:
1080       {
1081         gulong ul;
1082         gchar *endptr;
1083         errno = 0;
1084         ul = strtoul (string, &endptr, 0);
1085         if (errno || endptr == string)
1086           {
1087             g_set_error (error,
1088                          GTK_BUILDER_ERROR,
1089                          GTK_BUILDER_ERROR_INVALID_VALUE,
1090                          "Could not parse unsigned integer `%s'",
1091                          string);
1092             ret = FALSE;
1093             break;
1094           }
1095         if (G_VALUE_HOLDS_UINT (value))
1096           g_value_set_uint (value, ul);
1097         else
1098           g_value_set_ulong (value, ul);
1099         break;
1100       }
1101     case G_TYPE_ENUM:
1102       {
1103         gint enum_value;
1104         if (!_gtk_builder_enum_from_string (type, string, &enum_value, error))
1105           {
1106             ret = FALSE;
1107             break;
1108           }
1109         g_value_set_enum (value, enum_value);
1110         break;
1111       }
1112     case G_TYPE_FLAGS:
1113       {
1114         guint flags_value;
1115
1116         if (!_gtk_builder_flags_from_string (type, string, &flags_value, error))
1117           {
1118             ret = FALSE;
1119             break;
1120           }
1121         g_value_set_flags (value, flags_value);
1122         break;
1123       }
1124     case G_TYPE_FLOAT:
1125     case G_TYPE_DOUBLE:
1126       {
1127         gdouble d;
1128         gchar *endptr;
1129         errno = 0;
1130         d = g_ascii_strtod (string, &endptr);
1131         if (errno || endptr == string)
1132           {
1133             g_set_error (error,
1134                          GTK_BUILDER_ERROR,
1135                          GTK_BUILDER_ERROR_INVALID_VALUE,
1136                          "Could not parse double `%s'",
1137                          string);
1138             ret = FALSE;
1139             break;
1140           }
1141         if (G_VALUE_HOLDS_FLOAT (value))
1142           g_value_set_float (value, d);
1143         else
1144           g_value_set_double (value, d);
1145         break;
1146       }
1147     case G_TYPE_STRING:
1148       g_value_set_string (value, string);
1149       break;
1150     case G_TYPE_BOXED:
1151       if (G_VALUE_HOLDS (value, GDK_TYPE_COLOR))
1152         {
1153           GdkColor colour = { 0, };
1154
1155           if (gdk_color_parse (string, &colour) &&
1156               gdk_colormap_alloc_color (gtk_widget_get_default_colormap (),
1157                                         &colour, FALSE, TRUE))
1158             g_value_set_boxed (value, &colour);
1159           else
1160             {
1161               g_set_error (error,
1162                            GTK_BUILDER_ERROR,
1163                            GTK_BUILDER_ERROR_INVALID_VALUE,
1164                            "Could not parse color `%s'",
1165                            string);
1166               ret = FALSE;
1167             }
1168         }
1169       else if (G_VALUE_HOLDS (value, G_TYPE_STRV))
1170         {
1171           gchar **vector = g_strsplit (string, "\n", 0);
1172           g_value_take_boxed (value, vector);
1173         }
1174       else
1175         ret = FALSE;
1176       break;
1177     case G_TYPE_OBJECT:
1178       if (G_VALUE_HOLDS (value, GDK_TYPE_PIXBUF))
1179         {
1180           gchar *filename;
1181           GError *tmp_error = NULL;
1182           GdkPixbuf *pixbuf;
1183
1184           if (gtk_builder_get_object (builder, string))
1185             {
1186               g_set_error (error,
1187                            GTK_BUILDER_ERROR,
1188                            GTK_BUILDER_ERROR_INVALID_VALUE,
1189                            "Could not load image '%s': "
1190                            " '%s' is already used as object id",
1191                            string, string);
1192               return FALSE;
1193             }
1194
1195           if (g_path_is_absolute (string))
1196             filename = g_strdup (string);
1197           else
1198             {
1199               gchar *dirname;
1200
1201               dirname = g_path_get_dirname (builder->priv->filename);
1202               filename = g_build_filename (dirname, string, NULL);
1203
1204               g_free (dirname);
1205             }
1206
1207           pixbuf = gdk_pixbuf_new_from_file (filename, &tmp_error);
1208
1209           if (pixbuf == NULL)
1210             {
1211               GtkIconTheme *theme;
1212
1213               g_warning ("Could not load image '%s': %s",
1214                          string, tmp_error->message);
1215               g_error_free (tmp_error);
1216
1217               /* fall back to a missing image */
1218               theme = gtk_icon_theme_get_default ();
1219               pixbuf = gtk_icon_theme_load_icon (theme,
1220                                                  GTK_STOCK_MISSING_IMAGE,
1221                                                  16,
1222                                                  GTK_ICON_LOOKUP_USE_BUILTIN,
1223                                                  NULL);
1224             }
1225
1226           if (pixbuf)
1227             {
1228               g_value_set_object (value, pixbuf);
1229               g_object_unref (G_OBJECT (pixbuf));
1230             }
1231
1232           g_free (filename);
1233
1234           ret = TRUE;
1235         }
1236       else
1237         ret = FALSE;
1238       break;
1239     default:
1240       g_set_error (error,
1241                    GTK_BUILDER_ERROR,
1242                    GTK_BUILDER_ERROR_INVALID_VALUE,
1243                    "Unsupported GType `%s'",
1244                    g_type_name (type));
1245       ret = FALSE;
1246       break;
1247     }
1248
1249   return ret;
1250 }
1251
1252 static gboolean
1253 _gtk_builder_enum_from_string (GType         type,
1254                                const gchar  *string,
1255                                gint         *enum_value,
1256                                GError      **error)
1257 {
1258   GEnumClass *eclass;
1259   GEnumValue *ev;
1260   gchar *endptr;
1261   gint value;
1262
1263   g_return_val_if_fail (G_TYPE_IS_ENUM (type), 0);
1264   g_return_val_if_fail (string != NULL, 0);
1265
1266   value = strtoul (string, &endptr, 0);
1267   if (endptr != string) /* parsed a number */
1268     *enum_value = value;
1269   else
1270     {
1271       eclass = g_type_class_ref (type);
1272       ev = g_enum_get_value_by_name (eclass, string);
1273       if (!ev)
1274         ev = g_enum_get_value_by_nick (eclass, string);
1275
1276       if (ev)
1277         *enum_value = ev->value;
1278       else
1279         {
1280           g_set_error (error,
1281                        GTK_BUILDER_ERROR,
1282                        GTK_BUILDER_ERROR_INVALID_VALUE,
1283                        "Could not parse enum: `%s'",
1284                        string);
1285           return FALSE;
1286         }
1287
1288       g_type_class_unref (eclass);
1289     }
1290
1291   return TRUE;
1292 }
1293
1294 gboolean
1295 _gtk_builder_flags_from_string (GType         type,
1296                                 const gchar  *string,
1297                                 guint        *flags_value,
1298                                 GError      **error)
1299 {
1300   GFlagsClass *fclass;
1301   gchar *endptr, *prevptr;
1302   guint i, j, ret, value;
1303   gchar *flagstr;
1304   GFlagsValue *fv;
1305   const gchar *flag;
1306   gunichar ch;
1307   gboolean eos;
1308
1309   g_return_val_if_fail (G_TYPE_IS_FLAGS (type), 0);
1310   g_return_val_if_fail (string != 0, 0);
1311
1312   ret = TRUE;
1313
1314   value = strtoul (string, &endptr, 0);
1315   if (endptr != string) /* parsed a number */
1316     *flags_value = value;
1317   else
1318     {
1319       fclass = g_type_class_ref (type);
1320
1321       flagstr = g_strdup (string);
1322       for (value = i = j = 0; ; i++)
1323         {
1324
1325           eos = flagstr[i] == '\0';
1326
1327           if (!eos && flagstr[i] != '|')
1328             continue;
1329
1330           flag = &flagstr[j];
1331           endptr = &flagstr[i];
1332
1333           if (!eos)
1334             {
1335               flagstr[i++] = '\0';
1336               j = i;
1337             }
1338
1339           /* trim spaces */
1340           for (;;)
1341             {
1342               ch = g_utf8_get_char (flag);
1343               if (!g_unichar_isspace (ch))
1344                 break;
1345               flag = g_utf8_next_char (flag);
1346             }
1347
1348           while (endptr > flag)
1349             {
1350               prevptr = g_utf8_prev_char (endptr);
1351               ch = g_utf8_get_char (prevptr);
1352               if (!g_unichar_isspace (ch))
1353                 break;
1354               endptr = prevptr;
1355             }
1356
1357           if (endptr > flag)
1358             {
1359               *endptr = '\0';
1360               fv = g_flags_get_value_by_name (fclass, flag);
1361
1362               if (!fv)
1363                 fv = g_flags_get_value_by_nick (fclass, flag);
1364
1365               if (fv)
1366                 value |= fv->value;
1367               else
1368                 {
1369                   g_set_error (error,
1370                                GTK_BUILDER_ERROR,
1371                                GTK_BUILDER_ERROR_INVALID_VALUE,
1372                                "Unknown flag: `%s'",
1373                                flag);
1374                   ret = FALSE;
1375                   break;
1376                 }
1377             }
1378
1379           if (eos)
1380             {
1381               *flags_value = value;
1382               break;
1383             }
1384         }
1385
1386       g_free (flagstr);
1387
1388       g_type_class_unref (fclass);
1389     }
1390
1391   return ret;
1392 }
1393
1394 /**
1395  * gtk_builder_get_type_from_name:
1396  * @builder: a #GtkBuilder
1397  * @type_name: type name to lookup
1398  *
1399  * Looks up a type by name, using the virtual function that
1400  * #GtkBuilder has for that purpose. This is mainly used when
1401  * implementing the #GtkBuildable interface on a type.
1402  *
1403  * Returns: the #GType found for @type_name or #G_TYPE_INVALID
1404  *   if no type was found
1405  *
1406  * Since: 2.12
1407  */
1408 GType
1409 gtk_builder_get_type_from_name (GtkBuilder  *builder,
1410                                 const gchar *type_name)
1411 {
1412   g_return_val_if_fail (GTK_IS_BUILDER (builder), G_TYPE_INVALID);
1413   g_return_val_if_fail (type_name != NULL, G_TYPE_INVALID);
1414
1415   return GTK_BUILDER_GET_CLASS (builder)->get_type_from_name (builder, type_name);
1416 }
1417
1418 GQuark
1419 gtk_builder_error_quark (void)
1420 {
1421   return g_quark_from_static_string ("gtk-builder-error-quark");
1422 }
1423
1424
1425 #define __GTK_BUILDER_C__
1426 #include "gtkaliasdef.c"