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