gtkbuilder.c 86.6 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
 * Copyright (C) 1998-2002 James Henstridge <james@daa.com.au>
 * Copyright (C) 2006-2007 Async Open Source,
 *                         Johan Dahlin <jdahlin@async.com.br>,
 *                         Henrique Romano <henrique@async.com.br>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 20
 */

21 22 23 24 25 26
/**
 * SECTION:gtkbuilder
 * @Short_description: Build an interface from an XML UI definition
 * @Title: GtkBuilder
 *
 * A GtkBuilder is an auxiliary object that reads textual descriptions
27 28 29 30 31 32 33 34 35 36
 * of a user interface and instantiates the described objects. To create
 * a GtkBuilder from a user interface description, call
 * gtk_builder_new_from_file(), gtk_builder_new_from_resource() or
 * gtk_builder_new_from_string().
 *
 * In the (unusual) case that you want to add user interface
 * descriptions from multiple sources to the same GtkBuilder you can
 * call gtk_builder_new() to get an empty builder and populate it by
 * (multiple) calls to gtk_builder_add_from_file(),
 * gtk_builder_add_from_resource() or gtk_builder_add_from_string().
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
 *
 * A GtkBuilder holds a reference to all objects that it has constructed
 * and drops these references when it is finalized. This finalization can
 * cause the destruction of non-widget objects or widgets which are not
 * contained in a toplevel window. For toplevel windows constructed by a
 * builder, it is the responsibility of the user to call gtk_widget_destroy()
 * to get rid of them and all the widgets they contain.
 *
 * The functions gtk_builder_get_object() and gtk_builder_get_objects()
 * can be used to access the widgets in the interface by the names assigned
 * to them inside the UI description. Toplevel windows returned by these
 * functions will stay around until the user explicitly destroys them
 * with gtk_widget_destroy(). Other widgets will either be part of a
 * larger hierarchy constructed by the builder (in which case you should
 * not have to worry about their lifecycle), or without a parent, in which
 * case they have to be added to some container to make use of them.
 * Non-widget objects need to be reffed with g_object_ref() to keep them
 * beyond the lifespan of the builder.
 *
 * The function gtk_builder_connect_signals() and variants thereof can be
 * used to connect handlers to the named signals in the description.
 *
59
 * # GtkBuilder UI Definitions # {#BUILDER-UI}
60 61 62
 *
 * GtkBuilder parses textual descriptions of user interfaces which are
 * specified in an XML format which can be roughly described by the
63 64
 * RELAX NG schema below. We refer to these descriptions as “GtkBuilder
 * UI definitions” or just “UI definitions” if the context is clear.
65
 * Do not confuse GtkBuilder UI Definitions with
66 67 68
 * [GtkUIManager UI Definitions][XML-UI], which are more limited in scope.
 * It is common to use `.ui` as the filename extension for files containing
 * GtkBuilder UI definitions.
69
 *
70
 * [RELAX NG Compact Syntax](https://git.gnome.org/browse/gtk+/tree/gtk/gtkbuilder.rnc)
71
 *
72 73 74 75 76 77 78 79 80 81 82 83 84 85
 * The toplevel element is <interface>. It optionally takes a “domain”
 * attribute, which will make the builder look for translated strings
 * using dgettext() in the domain specified. This can also be done by
 * calling gtk_builder_set_translation_domain() on the builder.
 * Objects are described by <object> elements, which can contain
 * <property> elements to set properties, <signal> elements which
 * connect signals to handlers, and <child> elements, which describe
 * child objects (most often widgets inside a container, but also e.g.
 * actions in an action group, or columns in a tree model). A <child>
 * element contains an <object> element which describes the child object.
 * The target toolkit version(s) are described by <requires> elements,
 * the “lib” attribute specifies the widget library in question (currently
 * the only supported value is “gtk+”) and the “version” attribute specifies
 * the target version in the form “<major>.<minor>”. The builder will error
86
 * out if the version requirements are not met.
87
 *
88 89 90 91 92 93 94 95 96 97
 * Typically, the specific kind of object represented by an <object>
 * element is specified by the “class” attribute. If the type has not
 * been loaded yet, GTK+ tries to find the get_type() function from the
 * class name by applying heuristics. This works in most cases, but if
 * necessary, it is possible to specify the name of the get_type() function
 * explictly with the "type-func" attribute. As a special case, GtkBuilder
 * allows to use an object that has been constructed by a #GtkUIManager in
 * another part of the UI definition by specifying the id of the #GtkUIManager
 * in the “constructor” attribute and the name of the object in the “id”
 * attribute.
98
 *
99
 * Objects may be given a name with the “id” attribute, which allows the
100
 * application to retrieve them from the builder with gtk_builder_get_object().
101 102 103 104
 * An id is also necessary to use the object as property value in other
 * parts of the UI definition. GTK+ reserves ids starting and ending
 * with ___ (3 underscores) for its own purposes.
 *
105
 * Setting properties of objects is pretty straightforward with the
106 107
 * <property> element: the “name” attribute specifies the name of the
 * property, and the content of the element specifies the value.
108
 * If the “translatable” attribute is set to a true value, GTK+ uses
109 110 111 112 113 114 115 116 117
 * gettext() (or dgettext() if the builder has a translation domain set)
 * to find a translation for the value. This happens before the value
 * is parsed, so it can be used for properties of any type, but it is
 * probably most useful for string properties. It is also possible to
 * specify a context to disambiguate short strings, and comments which
 * may help the translators.
 *
 * GtkBuilder can parse textual representations for the most common
 * property types: characters, strings, integers, floating-point numbers,
118 119
 * booleans (strings like “TRUE”, “t”, “yes”, “y”, “1” are interpreted
 * as %TRUE, strings like “FALSE”, “f”, “no”, “n”, “0” are interpreted
120 121
 * as %FALSE), enumerations (can be specified by their name, nick or
 * integer value), flags (can be specified by their name, nick, integer
122
 * value, optionally combined with “|”, e.g. “GTK_VISIBLE|GTK_REALIZED”)
Matthias Clasen's avatar
Matthias Clasen committed
123
 * and colors (in a format understood by gdk_rgba_parse()). Pixbufs can
124 125 126 127
 * be specified as a filename of an image file to load. Objects can be
 * referred to by their name and by default refer to objects declared
 * in the local xml fragment and objects exposed via
 * gtk_builder_expose_object().
Matthias Clasen's avatar
Matthias Clasen committed
128
 *
129
 * In general, GtkBuilder allows forward references to objects —
130
 * declared in the local xml; an object doesn’t have to be constructed
131 132 133 134
 * before it can be referred to. The exception to this rule is that an
 * object has to be constructed before it can be used as the value of
 * a construct-only property.
 *
135 136 137 138
 * It is also possible to bind a property value to another object's
 * property value using the attributes
 * "bind-source" to specify the source object of the binding,
 * "bind-property" to specify the source property and optionally
Matthias Clasen's avatar
Matthias Clasen committed
139
 * "bind-flags" to specify the binding flags
140 141
 * Internally builder implement this using GBinding objects.
 * For more information see g_object_bind_property()
Matthias Clasen's avatar
Matthias Clasen committed
142
 *
143 144 145 146 147
 * Signal handlers are set up with the <signal> element. The “name”
 * attribute specifies the name of the signal, and the “handler” attribute
 * specifies the function to connect to the signal. By default, GTK+ tries
 * to find the handler using g_module_symbol(), but this can be changed by
 * passing a custom #GtkBuilderConnectFunc to
148 149
 * gtk_builder_connect_signals_full(). The remaining attributes, “after”,
 * “swapped” and “object”, have the same meaning as the corresponding
150
 * parameters of the g_signal_connect_object() or
151
 * g_signal_connect_data() functions. A “last_modification_time”
152 153 154 155 156 157
 * attribute is also allowed, but it does not have a meaning to the
 * builder.
 *
 * Sometimes it is necessary to refer to widgets which have implicitly
 * been constructed by GTK+ as part of a composite widget, to set
 * properties on them or to add further children (e.g. the @vbox of
158
 * a #GtkDialog). This can be achieved by setting the “internal-child”
159 160 161
 * propery of the <child> element to a true value. Note that GtkBuilder
 * still requires an <object> element for the internal child, even if it
 * has already been constructed.
162 163 164
 *
 * A number of widgets have different places where a child can be added
 * (e.g. tabs vs. page content in notebooks). This can be reflected in
165
 * a UI definition by specifying the “type” attribute on a <child>
166
 * The possible values for the “type” attribute are described in the
167 168
 * sections describing the widget-specific portions of UI definitions.
 *
169
 * # A GtkBuilder UI Definition
170
 *
171
 * |[
172 173 174
 * <interface>
 *   <object class="GtkDialog" id="dialog1">
 *     <child internal-child="vbox">
175
 *       <object class="GtkBox" id="vbox1">
176 177
 *         <property name="border-width">10</property>
 *         <child internal-child="action_area">
178
 *           <object class="GtkButtonBox" id="hbuttonbox1">
179 180 181 182 183 184 185 186 187 188 189 190 191 192
 *             <property name="border-width">20</property>
 *             <child>
 *               <object class="GtkButton" id="ok_button">
 *                 <property name="label">gtk-ok</property>
 *                 <property name="use-stock">TRUE</property>
 *                 <signal name="clicked" handler="ok_button_clicked"/>
 *               </object>
 *             </child>
 *           </object>
 *         </child>
 *       </object>
 *     </child>
 *   </object>
 * </interface>
193
 * ]|
194 195 196
 *
 * Beyond this general structure, several object classes define their
 * own XML DTD fragments for filling in the ANY placeholders in the DTD
197 198 199
 * above. Note that a custom element in a <child> element gets parsed by
 * the custom tag handler of the parent object, while a custom element in
 * an <object> element gets parsed by the custom tag handler of the object.
200 201 202 203
 *
 * These XML fragments are explained in the documentation of the
 * respective objects.
 *
204 205
 * Additionally, since 3.10 a special <template> tag has been added
 * to the format allowing one to define a widget class’s components.
206
 * See the [GtkWidget documentation][composite-templates] for details.
207 208
 */

209
#include "config.h"
210
#include <errno.h> /* errno */
211
#include <stdlib.h>
212 213 214 215 216
#include <string.h> /* strlen */

#include "gtkbuilder.h"
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
217
#include "gtkdebug.h"
218 219 220 221
#include "gtkmain.h"
#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtktypebuiltins.h"
222
#include "gtkwindow.h"
Matthias Clasen's avatar
Matthias Clasen committed
223
#include "gtkicontheme.h"
224
#include "gtktestutils.h"
225
#include "deprecated/gtkstock.h"
226

227 228 229 230 231 232 233 234 235 236 237 238

static void gtk_builder_class_init     (GtkBuilderClass *klass);
static void gtk_builder_init           (GtkBuilder      *builder);
static void gtk_builder_finalize       (GObject         *object);
static void gtk_builder_set_property   (GObject         *object,
                                        guint            prop_id,
                                        const GValue    *value,
                                        GParamSpec      *pspec);
static void gtk_builder_get_property   (GObject         *object,
                                        guint            prop_id,
                                        GValue          *value,
                                        GParamSpec      *pspec);
Matthias Clasen's avatar
Matthias Clasen committed
239 240
static GType gtk_builder_real_get_type_from_name (GtkBuilder  *builder,
                                                  const gchar *type_name);
241 242 243 244

enum {
  PROP_0,
  PROP_TRANSLATION_DOMAIN,
245
  LAST_PROP
246 247
};

248 249
static GParamSpec *builder_props[LAST_PROP];

250 251 252 253
struct _GtkBuilderPrivate
{
  gchar *domain;
  GHashTable *objects;
254
  GHashTable *callbacks;
255
  GSList *delayed_properties;
256
  GSList *signals;
257
  GSList *bindings;
258
  gchar *filename;
259
  gchar *resource_prefix;
260
  GType template_type;
261
  GtkApplication *application;
262 263
};

264
G_DEFINE_TYPE_WITH_PRIVATE (GtkBuilder, gtk_builder, G_TYPE_OBJECT)
265 266 267 268 269 270 271 272 273 274 275 276 277 278

static void
gtk_builder_class_init (GtkBuilderClass *klass)
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);

  gobject_class->finalize = gtk_builder_finalize;
  gobject_class->set_property = gtk_builder_set_property;
  gobject_class->get_property = gtk_builder_get_property;

  klass->get_type_from_name = gtk_builder_real_get_type_from_name;

Matthias Clasen's avatar
Matthias Clasen committed
279
 /**
Matthias Clasen's avatar
Matthias Clasen committed
280 281 282 283 284
  * GtkBuilder:translation-domain:
  *
  * The translation domain used when translating property values that
  * have been marked as translatable in interface descriptions.
  * If the translation domain is %NULL, #GtkBuilder uses gettext(),
285
  * otherwise g_dgettext().
Matthias Clasen's avatar
Matthias Clasen committed
286 287 288
  *
  * Since: 2.12
  */
289 290 291 292 293 294 295 296
  builder_props[PROP_TRANSLATION_DOMAIN] =
      g_param_spec_string ("translation-domain",
                           P_("Translation Domain"),
                           P_("The translation domain used by gettext"),
                           NULL,
                           GTK_PARAM_READWRITE);

  g_object_class_install_properties (gobject_class, LAST_PROP, builder_props);
297 298 299 300 301
}

static void
gtk_builder_init (GtkBuilder *builder)
{
302
  builder->priv = gtk_builder_get_instance_private (builder);
303 304
  builder->priv->domain = NULL;
  builder->priv->objects = g_hash_table_new_full (g_str_hash, g_str_equal,
305
                                                  g_free, g_object_unref);
306 307 308 309 310 311 312 313 314 315
}


/*
 * GObject virtual methods
 */

static void
gtk_builder_finalize (GObject *object)
{
316
  GtkBuilderPrivate *priv = GTK_BUILDER (object)->priv;
317

318 319
  g_free (priv->domain);
  g_free (priv->filename);
320
  g_free (priv->resource_prefix);
321

322
  g_hash_table_destroy (priv->objects);
323 324
  if (priv->callbacks)
    g_hash_table_destroy (priv->callbacks);
325

Matthias Clasen's avatar
Matthias Clasen committed
326
  g_slist_free_full (priv->signals, (GDestroyNotify)_free_signal_info);
327

328
  G_OBJECT_CLASS (gtk_builder_parent_class)->finalize (object);
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
}

static void
gtk_builder_set_property (GObject      *object,
                          guint         prop_id,
                          const GValue *value,
                          GParamSpec   *pspec)
{
  GtkBuilder *builder = GTK_BUILDER (object);

  switch (prop_id)
    {
    case PROP_TRANSLATION_DOMAIN:
      gtk_builder_set_translation_domain (builder, g_value_get_string (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_builder_get_property (GObject    *object,
                          guint       prop_id,
                          GValue     *value,
                          GParamSpec *pspec)
{
  GtkBuilder *builder = GTK_BUILDER (object);

  switch (prop_id)
    {
    case PROP_TRANSLATION_DOMAIN:
      g_value_set_string (value, builder->priv->domain);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}


/*
 * Try to map a type name to a _get_type function
 * and call it, eg:
 *
 * GtkWindow -> gtk_window_get_type
 * GtkHBox -> gtk_hbox_get_type
 * GtkUIManager -> gtk_ui_manager_get_type
377 378 379
 * GWeatherLocation -> gweather_location_get_type
 *
 * Keep in sync with testsuite/gtk/typename.c !
380
 */
Matthias Clasen's avatar
Matthias Clasen committed
381 382
static gchar *
type_name_mangle (const gchar *name)
383 384
{
  GString *symbol_name = g_string_new ("");
385
  gint i;
386 387 388 389

  for (i = 0; name[i] != '\0'; i++)
    {
      /* skip if uppercase, first or previous is uppercase */
390 391 392 393 394
      if ((name[i] == g_ascii_toupper (name[i]) &&
           i > 0 && name[i-1] != g_ascii_toupper (name[i-1])) ||
           (i > 2 && name[i]   == g_ascii_toupper (name[i]) &&
           name[i-1] == g_ascii_toupper (name[i-1]) &&
           name[i-2] == g_ascii_toupper (name[i-2])))
395
        g_string_append_c (symbol_name, '_');
Matthias Clasen's avatar
Matthias Clasen committed
396
      g_string_append_c (symbol_name, g_ascii_tolower (name[i]));
397 398
    }
  g_string_append (symbol_name, "_get_type");
Matthias Clasen's avatar
Matthias Clasen committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412

  return g_string_free (symbol_name, FALSE);
}

static GType
_gtk_builder_resolve_type_lazily (const gchar *name)
{
  static GModule *module = NULL;
  GTypeGetFunc func;
  gchar *symbol;
  GType gtype = G_TYPE_INVALID;

  if (!module)
    module = g_module_open (NULL, 0);
Matthias Clasen's avatar
Matthias Clasen committed
413

Matthias Clasen's avatar
Matthias Clasen committed
414
  symbol = type_name_mangle (name);
415 416 417

  if (g_module_symbol (module, symbol, (gpointer)&func))
    gtype = func ();
Matthias Clasen's avatar
Matthias Clasen committed
418

419 420 421 422 423 424 425 426 427 428
  g_free (symbol);

  return gtype;
}

/*
 * GtkBuilder virtual methods
 */

static GType
Matthias Clasen's avatar
Matthias Clasen committed
429
gtk_builder_real_get_type_from_name (GtkBuilder  *builder,
Matthias Clasen's avatar
Matthias Clasen committed
430
                                     const gchar *type_name)
431 432 433
{
  GType gtype;

434
  gtype = g_type_from_name (type_name);
435 436 437
  if (gtype != G_TYPE_INVALID)
    return gtype;

438 439 440 441 442 443
  gtype = _gtk_builder_resolve_type_lazily (type_name);
  if (gtype != G_TYPE_INVALID)
    return gtype;

  gtk_test_register_all_types ();
  return g_type_from_name (type_name);
444 445 446 447 448
}

typedef struct
{
  gchar *object;
449
  GParamSpec *pspec;
450
  gchar *value;
451 452
  gint line;
  gint col;
453 454 455 456 457 458 459
} DelayedProperty;

static void
gtk_builder_get_parameters (GtkBuilder  *builder,
                            GType        object_type,
                            const gchar *object_name,
                            GSList      *properties,
Matthias Clasen's avatar
Matthias Clasen committed
460
                            GParamFlags  filter_flags,
461
                            GArray      **parameters,
462
                            GArray      **filtered_parameters)
463 464 465
{
  GSList *l;
  DelayedProperty *property;
466
  GError *error = NULL;
467

468 469 470 471
  if (parameters)
    *parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
  if (filtered_parameters)
    *filtered_parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
472 473 474 475 476 477

  for (l = properties; l; l = l->next)
    {
      PropertyInfo *prop = (PropertyInfo*)l->data;
      GParameter parameter = { NULL };

478
      parameter.name = prop->pspec->name;
479

480 481
      if (G_IS_PARAM_SPEC_OBJECT (prop->pspec) &&
          (G_PARAM_SPEC_VALUE_TYPE (prop->pspec) != GDK_TYPE_PIXBUF))
482
        {
483 484
          GObject *object = g_hash_table_lookup (builder->priv->objects,
                                                 prop->text->str);
485 486 487 488 489 490

          if (object)
            {
              g_value_init (&parameter.value, G_OBJECT_TYPE (object));
              g_value_set_object (&parameter.value, object);
            }
Matthias Clasen's avatar
Matthias Clasen committed
491
          else
492
            {
493
              if (prop->pspec->flags & G_PARAM_CONSTRUCT_ONLY)
494
                {
Matthias Clasen's avatar
Matthias Clasen committed
495
                  g_warning ("Failed to get construct only property "
Matthias Clasen's avatar
Matthias Clasen committed
496
                             "%s of %s with value `%s'",
497
                             prop->pspec->name, object_name, prop->text->str);
498 499
                  continue;
                }
500
              /* Delay setting property */
501
              property = g_slice_new (DelayedProperty);
502
              property->pspec = prop->pspec;
503
              property->object = g_strdup (object_name);
504
              property->value = g_strdup (prop->text->str);
505 506
              property->line = prop->line;
              property->col = prop->col;
507 508
              builder->priv->delayed_properties =
                g_slist_prepend (builder->priv->delayed_properties, property);
509 510 511
              continue;
            }
        }
512
      else if (prop->bound && (!prop->text || prop->text->len == 0))
513 514 515 516 517 518
        {
          /* Ignore properties with a binding and no value since they are
           * only there for to express the binding.
           */
          continue;
        }
519
      else if (!gtk_builder_value_from_string (builder, prop->pspec,
520
                                               prop->text->str, &parameter.value, &error))
521
        {
Matthias Clasen's avatar
Matthias Clasen committed
522
          g_warning ("Failed to set property %s.%s to %s: %s",
523
                     g_type_name (object_type), prop->pspec->name, prop->text->str,
Matthias Clasen's avatar
Matthias Clasen committed
524 525 526
                     error->message);
          g_error_free (error);
          error = NULL;
527 528 529
          continue;
        }

530
      if (prop->pspec->flags & filter_flags)
Matthias Clasen's avatar
Matthias Clasen committed
531 532 533 534
        {
          if (filtered_parameters)
            g_array_append_val (*filtered_parameters, parameter);
        }
535
      else
Matthias Clasen's avatar
Matthias Clasen committed
536 537 538 539
        {
          if (parameters)
            g_array_append_val (*parameters, parameter);
        }
540 541 542 543
    }
}

static GObject *
Matthias Clasen's avatar
Matthias Clasen committed
544 545 546 547
gtk_builder_get_internal_child (GtkBuilder   *builder,
                                ObjectInfo   *info,
                                const gchar  *childname,
                                GError      **error)
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
{
  GObject *obj = NULL;

  while (!obj)
    {
      if (!info->parent)
        break;

      info = (ObjectInfo*)((ChildInfo*)info->parent)->parent;
      if (!info)
        break;

      GTK_NOTE (BUILDER,
                g_print ("Trying to get internal child %s from %s\n",
                         childname,
                         gtk_buildable_get_name (GTK_BUILDABLE (info->object))));

      if (GTK_IS_BUILDABLE (info->object))
          obj = gtk_buildable_get_internal_child (GTK_BUILDABLE (info->object),
                                                  builder,
                                                  childname);
    };

  if (!obj)
572 573
    {
      g_set_error (error,
Matthias Clasen's avatar
Matthias Clasen committed
574 575 576
                   GTK_BUILDER_ERROR,
                   GTK_BUILDER_ERROR_INVALID_VALUE,
                   "Unknown internal child: %s", childname);
577
    }
578 579 580
  return obj;
}

581
static inline void
Matthias Clasen's avatar
Matthias Clasen committed
582 583
object_set_name (GObject     *object,
                 const gchar *name)
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
{
  if (GTK_IS_BUILDABLE (object))
    gtk_buildable_set_name (GTK_BUILDABLE (object), name);
  else
    g_object_set_data_full (object, "gtk-builder-name", g_strdup (name), g_free);
}

void
_gtk_builder_add_object (GtkBuilder  *builder,
                         const gchar *id,
                         GObject     *object)
{
  object_set_name (object, id);
  g_hash_table_insert (builder->priv->objects, g_strdup (id), g_object_ref (object));
}

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
static inline void
gtk_builder_take_bindings (GtkBuilder *builder,
                           GObject    *target,
                           GSList     *bindings)
{
  GSList *l;

  for (l = bindings; l; l = g_slist_next (l))
    {
      BindingInfo *info = l->data;
      info->target = target;
    }

  builder->priv->bindings = g_slist_concat (builder->priv->bindings, bindings);
}

616
GObject *
Matthias Clasen's avatar
Matthias Clasen committed
617 618 619
_gtk_builder_construct (GtkBuilder  *builder,
                        ObjectInfo  *info,
                        GError     **error)
620 621 622 623 624 625 626
{
  GArray *parameters, *construct_parameters;
  GObject *obj;
  int i;
  GtkBuildableIface *iface;
  gboolean custom_set_property;
  GtkBuildable *buildable;
627
  GParamFlags param_filter_flags;
628

629 630 631 632
  g_assert (info->type != G_TYPE_INVALID);

  if (builder->priv->template_type != 0 &&
      g_type_is_a (info->type, builder->priv->template_type))
633 634
    {
      g_set_error (error,
Matthias Clasen's avatar
Matthias Clasen committed
635 636 637 638 639
                   GTK_BUILDER_ERROR,
                   GTK_BUILDER_ERROR_OBJECT_TYPE_REFUSED,
                   "Refused to build object of type `%s' because it "
                   "conforms to the template type `%s', avoiding infinite recursion.",
                   g_type_name (info->type), g_type_name (builder->priv->template_type));
640 641
      return NULL;
    }
642

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
  /* If there is a manual constructor (like UIManager), or if this is a
   * reference to an internal child, then we filter out construct-only
   * and warn that they cannot be set.
   *
   * Otherwise if we are calling g_object_newv(), we want to pass
   * both G_PARAM_CONSTRUCT and G_PARAM_CONSTRUCT_ONLY to the
   * object's constructor.
   *
   * Passing all construct properties to g_object_newv() slightly
   * improves performance as the construct properties will only be set once.
   */
  if (info->constructor ||
      (info->parent && ((ChildInfo*)info->parent)->internal_child != NULL))
    param_filter_flags = G_PARAM_CONSTRUCT_ONLY;
  else
    param_filter_flags = G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY;

660
  gtk_builder_get_parameters (builder, info->type,
661 662
                              info->id,
                              info->properties,
Matthias Clasen's avatar
Matthias Clasen committed
663
                              param_filter_flags,
664 665 666 667 668 669 670
                              &parameters,
                              &construct_parameters);

  if (info->constructor)
    {
      GObject *constructor;

671
      constructor = g_hash_table_lookup (builder->priv->objects, info->constructor);
672
      if (constructor == NULL)
Matthias Clasen's avatar
Matthias Clasen committed
673 674 675 676 677 678 679 680 681 682 683
        {
          g_set_error (error,
                       GTK_BUILDER_ERROR,
                       GTK_BUILDER_ERROR_INVALID_VALUE,
                       "Unknown object constructor for %s: %s",
                       info->id,
                       info->constructor);
          g_array_free (parameters, TRUE);
          g_array_free (construct_parameters, TRUE);
          return NULL;
        }
684 685 686 687 688 689 690 691 692 693
      obj = gtk_buildable_construct_child (GTK_BUILDABLE (constructor),
                                           builder,
                                           info->id);
      g_assert (obj != NULL);
      if (construct_parameters->len)
        g_warning ("Can't pass in construct-only parameters to %s", info->id);
    }
  else if (info->parent && ((ChildInfo*)info->parent)->internal_child != NULL)
    {
      gchar *childname = ((ChildInfo*)info->parent)->internal_child;
694 695
      obj = gtk_builder_get_internal_child (builder, info, childname, error);
      if (!obj)
Matthias Clasen's avatar
Matthias Clasen committed
696 697 698 699 700
        {
          g_array_free (parameters, TRUE);
          g_array_free (construct_parameters, TRUE);
          return NULL;
        }
701 702
      if (construct_parameters->len)
        g_warning ("Can't pass in construct-only parameters to %s", childname);
703
      g_object_ref (obj);
704 705 706
    }
  else
    {
707
      obj = g_object_newv (info->type,
708 709 710
                           construct_parameters->len,
                           (GParameter *)construct_parameters->data);

711 712 713 714 715 716 717 718 719 720 721 722
      /* No matter what, make sure we have a reference.
       *
       * If it's an initially unowned object, sink it.
       * If it's not initially unowned then we have the reference already.
       *
       * In the case that this is a window it will be sunk already and
       * this is effectively a call to g_object_ref().  That's what
       * we want.
       */
      if (G_IS_INITIALLY_UNOWNED (obj))
        g_object_ref_sink (obj);

723
      GTK_NOTE (BUILDER,
724
                g_print ("created %s of type %s\n", info->id, g_type_name (info->type)));
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741

      for (i = 0; i < construct_parameters->len; i++)
        {
          GParameter *param = &g_array_index (construct_parameters,
                                              GParameter, i);
          g_value_unset (&param->value);
        }
    }
  g_array_free (construct_parameters, TRUE);

  custom_set_property = FALSE;
  buildable = NULL;
  iface = NULL;
  if (GTK_IS_BUILDABLE (obj))
    {
      buildable = GTK_BUILDABLE (obj);
      iface = GTK_BUILDABLE_GET_IFACE (obj);
742
      if (iface->set_buildable_property)
743 744 745 746 747 748 749
        custom_set_property = TRUE;
    }

  for (i = 0; i < parameters->len; i++)
    {
      GParameter *param = &g_array_index (parameters, GParameter, i);
      if (custom_set_property)
750
        iface->set_buildable_property (buildable, builder, param->name, &param->value);
751 752 753 754
      else
        g_object_set_property (obj, param->name, &param->value);

#if G_ENABLE_DEBUG
755
      if (GTK_DEBUG_CHECK (BUILDER))
756 757 758 759 760
        {
          gchar *str = g_strdup_value_contents ((const GValue*)&param->value);
          g_print ("set %s: %s = %s\n", info->id, param->name, str);
          g_free (str);
        }
Matthias Clasen's avatar
Matthias Clasen committed
761
#endif
762 763 764 765
      g_value_unset (&param->value);
    }
  g_array_free (parameters, TRUE);

766 767 768
  if (info->bindings)
    gtk_builder_take_bindings (builder, obj, info->bindings);

769 770
  /* put it in the hash table. */
  _gtk_builder_add_object (builder, info->id, obj);
Matthias Clasen's avatar
Matthias Clasen committed
771 772

  /* we already own a reference to obj. */
773
  g_object_unref (obj);
Matthias Clasen's avatar
Matthias Clasen committed
774

775 776 777
  return obj;
}

778
void
Matthias Clasen's avatar
Matthias Clasen committed
779 780 781
_gtk_builder_apply_properties (GtkBuilder  *builder,
                               ObjectInfo  *info,
                               GError     **error)
782 783 784 785 786 787 788 789
{
  GArray *parameters;
  GtkBuildableIface *iface;
  GtkBuildable *buildable;
  gboolean custom_set_property;
  gint i;

  g_assert (info->object != NULL);
790
  g_assert (info->type != G_TYPE_INVALID);
791 792

  /* Fetch all properties that are not construct-only */
793
  gtk_builder_get_parameters (builder, info->type,
794 795
                              info->id,
                              info->properties,
Matthias Clasen's avatar
Matthias Clasen committed
796
                              G_PARAM_CONSTRUCT_ONLY,
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
                              &parameters, NULL);

  custom_set_property = FALSE;
  buildable = NULL;
  iface = NULL;
  if (GTK_IS_BUILDABLE (info->object))
    {
      buildable = GTK_BUILDABLE (info->object);
      iface = GTK_BUILDABLE_GET_IFACE (info->object);
      if (iface->set_buildable_property)
        custom_set_property = TRUE;
    }

  for (i = 0; i < parameters->len; i++)
    {
      GParameter *param = &g_array_index (parameters, GParameter, i);
      if (custom_set_property)
        iface->set_buildable_property (buildable, builder, param->name, &param->value);
      else
        g_object_set_property (info->object, param->name, &param->value);

#if G_ENABLE_DEBUG
819
      if (GTK_DEBUG_CHECK (BUILDER))
820 821 822 823 824
        {
          gchar *str = g_strdup_value_contents ((const GValue*)&param->value);
          g_print ("set %s: %s = %s\n", info->id, param->name, str);
          g_free (str);
        }
Matthias Clasen's avatar
Matthias Clasen committed
825
#endif
826 827 828 829 830
      g_value_unset (&param->value);
    }
  g_array_free (parameters, TRUE);
}

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
void
_gtk_builder_add (GtkBuilder *builder,
                  ChildInfo  *child_info)
{
  GObject *object;
  GObject *parent;

  /* Internal children are already added
   * Also prevent us from being called twice.
   */
  if (!child_info ||
      child_info->internal_child ||
      child_info->added)
    return;

  object = child_info->object;
  if (!object)
    return;

  if (!child_info->parent)
    {
852
      g_warning ("%s: Not adding, No parent",
853 854 855 856 857 858 859 860 861 862 863 864 865
                 gtk_buildable_get_name (GTK_BUILDABLE (object)));
      return;
    }

  g_assert (object != NULL);

  parent = ((ObjectInfo*)child_info->parent)->object;
  g_assert (GTK_IS_BUILDABLE (parent));

  GTK_NOTE (BUILDER,
            g_print ("adding %s to %s\n",
                     gtk_buildable_get_name (GTK_BUILDABLE (object)),
                     gtk_buildable_get_name (GTK_BUILDABLE (parent))));
Matthias Clasen's avatar
Matthias Clasen committed
866

867
  gtk_buildable_add_child (GTK_BUILDABLE (parent), builder, object,
Matthias Clasen's avatar
Matthias Clasen committed
868
                           child_info->type);
869 870 871 872

  child_info->added = TRUE;
}

873 874
void
_gtk_builder_add_signals (GtkBuilder *builder,
Matthias Clasen's avatar
Matthias Clasen committed
875
                          GSList     *signals)
876 877 878 879 880
{
  builder->priv->signals = g_slist_concat (builder->priv->signals,
                                           g_slist_copy (signals));
}

881
static void
882
gtk_builder_apply_delayed_properties (GtkBuilder *builder)
883
{
884
  GSList *l, *props;
885

886 887 888 889 890 891 892 893
  /* take the list over from the builder->priv.
   *
   * g_slist_reverse does not copy the list, so the list now
   * belongs to us (and we free it at the end of this function).
   */
  props = g_slist_reverse (builder->priv->delayed_properties);
  builder->priv->delayed_properties = NULL;

894 895
  for (l = props; l; l = l->next)
    {
896 897 898
      DelayedProperty *property = l->data;
      GObject *object, *obj;

899 900 901
      object = g_hash_table_lookup (builder->priv->objects, property->object);
      g_assert (object != NULL);

902
      obj = _gtk_builder_lookup_object (builder, property->value, property->line, property->col);
903 904
      if (obj)
        g_object_set (object, property->pspec->name, obj, NULL);
905 906 907 908 909 910 911 912

      g_free (property->value);
      g_free (property->object);
      g_slice_free (DelayedProperty, property);
    }
  g_slist_free (props);
}

913
static inline void
Matthias Clasen's avatar
Matthias Clasen committed
914 915
free_binding_info (gpointer data,
                   gpointer user)
916 917
{
  BindingInfo *info = data;
918

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
  g_free (info->source);
  g_free (info->source_property);
  g_slice_free (BindingInfo, data);
}

static inline void
gtk_builder_create_bindings (GtkBuilder *builder)
{
  GSList *l;

  for (l = builder->priv->bindings; l; l = g_slist_next (l))
    {
      BindingInfo *info = l->data;
      GObject *source;

934 935
      source = _gtk_builder_lookup_object (builder, info->source, info->line, info->col);
      if (source)
936
        g_object_bind_property (source, info->source_property,
937
                                info->target, info->target_pspec->name,
938 939 940 941 942 943 944 945 946
                                info->flags);

      free_binding_info (info, NULL);
    }

  g_slist_free (builder->priv->bindings);
  builder->priv->bindings = NULL;
}

947
void
948
_gtk_builder_finish (GtkBuilder *builder)
949
{
950
  gtk_builder_apply_delayed_properties (builder);
951
  gtk_builder_create_bindings (builder);
952 953 954 955 956
}

/**
 * gtk_builder_new:
 *
957 958
 * Creates a new empty builder object.
 *
959 960 961
 * This function is only useful if you intend to make multiple calls
 * to gtk_builder_add_from_file(), gtk_builder_add_from_resource()
 * or gtk_builder_add_from_string() in order to merge multiple UI
962
 * descriptions into a single builder.
963
 *
964 965 966
 * Most users will probably want to use gtk_builder_new_from_file(),
 * gtk_builder_new_from_resource() or gtk_builder_new_from_string().
 *
967
 * Returns: a new (empty) #GtkBuilder object
968 969 970 971 972 973 974 975 976 977 978 979 980
 *
 * Since: 2.12
 **/
GtkBuilder *
gtk_builder_new (void)
{
  return g_object_new (GTK_TYPE_BUILDER, NULL);
}

/**
 * gtk_builder_add_from_file:
 * @builder: a #GtkBuilder
 * @filename: the name of the file to parse
981
 * @error: (allow-none): return location for an error, or %NULL
982
 *
983 984
 * Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
 * and merges it with the current contents of @builder.
985 986
 *
 * Most users will probably want to use gtk_builder_new_from_file().
987
 *
988
 * If an error occurs, 0 will be returned and @error will be assigned a
Matthias Clasen's avatar
Matthias Clasen committed
989
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
990 991
 * domain.
 *
992
 * It’s not really reasonable to attempt to handle failures of this
993 994
 * call. You should not use this function with untrusted files (ie:
 * files that are not part of your application). Broken #GtkBuilder
995
 * files can easily crash your program, and it’s possible that memory
996
 * was leaked leading up to the reported failure. The only reasonable
997 998
 * thing to do when an error is detected is to call g_error().
 *
999 1000 1001 1002 1003 1004 1005 1006 1007
 * Returns: A positive value on success, 0 if an error occurred
 *
 * Since: 2.12
 **/
guint
gtk_builder_add_from_file (GtkBuilder   *builder,
                           const gchar  *filename,
                           GError      **error)
{
Matthias Clasen's avatar
Matthias Clasen committed
1008
  gchar *buffer;
1009
  gsize length;
1010 1011 1012 1013
  GError *tmp_error;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (filename != NULL, 0);
1014
  g_return_val_if_fail (error == NULL || *error == NULL, 0);
1015 1016 1017 1018 1019 1020 1021 1022

  tmp_error = NULL;

  if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }
Matthias Clasen's avatar
Matthias Clasen committed
1023

1024
  g_free (builder->priv->filename);
1025
  g_free (builder->priv->resource_prefix);
1026
  builder->priv->filename = g_strdup (filename);
1027
  builder->priv->resource_prefix = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
1028

1029 1030
  _gtk_builder_parser_parse_buffer (builder, filename,
                                    buffer, length,
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
                                    NULL,
                                    &tmp_error);

  g_free (buffer);

  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

/**
 * gtk_builder_add_objects_from_file:
 * @builder: a #GtkBuilder
 * @filename: the name of the file to parse
1049
 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
1050
 * @error: (allow-none): return location for an error, or %NULL
1051
 *
1052 1053 1054
 * Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
 * building only the requested objects and merges
 * them with the current contents of @builder.
1055
 *
1056
 * Upon errors 0 will be returned and @error will be assigned a
Matthias Clasen's avatar
Matthias Clasen committed
1057
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
1058 1059
 * domain.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1060
 * If you are adding an object that depends on an object that is not
1061
 * its child (for instance a #GtkTreeView that depends on its
Matthias Clasen's avatar
Matthias Clasen committed
1062
 * #GtkTreeModel), you have to explicitly list all of them in @object_ids.
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
 *
 * Returns: A positive value on success, 0 if an error occurred
 *
 * Since: 2.14
 **/
guint
gtk_builder_add_objects_from_file (GtkBuilder   *builder,
                                   const gchar  *filename,
                                   gchar       **object_ids,
                                   GError      **error)
{
  gchar *buffer;
  gsize length;
  GError *tmp_error;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (filename != NULL, 0);
  g_return_val_if_fail (object_ids != NULL && object_ids[0] != NULL, 0);
  g_return_val_if_fail (error == NULL || *error == NULL, 0);

  tmp_error = NULL;

  if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }
Matthias Clasen's avatar
Matthias Clasen committed
1090

1091
  g_free (builder->priv->filename);
1092
  g_free (builder->priv->resource_prefix);
1093
  builder->priv->filename = g_strdup (filename);
1094
  builder->priv->resource_prefix = NULL;
1095 1096 1097 1098

  _gtk_builder_parser_parse_buffer (builder, filename,
                                    buffer, length,
                                    object_ids,
1099 1100
                                    &tmp_error);

1101 1102
  g_free (buffer);

1103 1104 1105 1106 1107 1108 1109 1110 1111
  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

1112
/* Main private entry point for building composite container
1113 1114 1115
 * components from template XML.
 * This is exported purely to let gtk-builder-tool validate
 * templates, applications have no need to call this function.
1116 1117
 */
guint
1118 1119 1120 1121 1122 1123
gtk_builder_extend_with_template (GtkBuilder   *builder,
                                  GtkWidget    *widget,
                                  GType         template_type,
                                  const gchar  *buffer,
                                  gsize         length,
                                  GError      **error)
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
{
  GError *tmp_error;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (GTK_IS_WIDGET (widget), 0);
  g_return_val_if_fail (g_type_name (template_type) != NULL, 0);
  g_return_val_if_fail (g_type_is_a (G_OBJECT_TYPE (widget), template_type), 0);
  g_return_val_if_fail (buffer && buffer[0], 0);

  tmp_error = NULL;

  g_free (builder->priv->filename);
  g_free (builder->priv->resource_prefix);
  builder->priv->filename = g_strdup (".");
  builder->priv->resource_prefix = NULL;
  builder->priv->template_type = template_type;

  gtk_builder_expose_object (builder, g_type_name (template_type), G_OBJECT (widget));
  _gtk_builder_parser_parse_buffer (builder, "<input>",
                                    buffer, length,
                                    NULL,
                                    &tmp_error);

  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

1156 1157 1158 1159 1160 1161
/**
 * gtk_builder_add_from_resource:
 * @builder: a #GtkBuilder
 * @resource_path: the path of the resource file to parse
 * @error: (allow-none): return location for an error, or %NULL
 *
1162 1163
 * Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
 * and merges it with the current contents of @builder.
1164
 *
1165 1166
 * Most users will probably want to use gtk_builder_new_from_resource().
 *
1167
 * If an error occurs, 0 will be returned and @error will be assigned a
1168 1169 1170
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
 * domain.
 *
1171
 * It’s not really reasonable to attempt to handle failures of this
1172 1173 1174
 * call.  The only reasonable thing to do when an error is detected is
 * to call g_error().
 *
1175 1176 1177 1178 1179 1180
 * Returns: A positive value on success, 0 if an error occurred
 *
 * Since: 3.4
 **/
guint
gtk_builder_add_from_resource (GtkBuilder   *builder,
Matthias Clasen's avatar
Matthias Clasen committed
1181 1182
                               const gchar  *resource_path,
                               GError      **error)
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
{
  GError *tmp_error;
  GBytes *data;
  char *filename_for_errors;
  char *slash;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (resource_path != NULL, 0);
  g_return_val_if_fail (error == NULL || *error == NULL, 0);

  tmp_error = NULL;

  data = g_resources_lookup_data (resource_path, 0, &tmp_error);
  if (data == NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  g_free (builder->priv->filename);
  g_free (builder->priv->resource_prefix);
  builder->priv->filename = g_strdup (".");

  slash = strrchr (resource_path, '/');
  if (slash != NULL)
    builder->priv->resource_prefix =
      g_strndup (resource_path, slash - resource_path + 1);
  else
    builder->priv->resource_prefix =
      g_strdup ("/");

  filename_for_errors = g_strconcat ("<resource>", resource_path, NULL);

  _gtk_builder_parser_parse_buffer (builder, filename_for_errors,
                                    g_bytes_get_data (data, NULL), g_bytes_get_size (data),
                                    NULL,
                                    &tmp_error);

  g_free (filename_for_errors);
  g_bytes_unref (data);

  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

/**
 * gtk_builder_add_objects_from_resource:
 * @builder: a #GtkBuilder
 * @resource_path: the path of the resource file to parse
 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
 * @error: (allow-none): return location for an error, or %NULL
 *
1240 1241
 * Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
 * building only the requested objects and merges
1242 1243 1244 1245 1246 1247 1248 1249
 * them with the current contents of @builder.
 *
 * Upon errors 0 will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
 * domain.
 *
 * If you are adding an object that depends on an object that is not
 * its child (for instance a #GtkTreeView that depends on its
1250
 * #GtkTreeModel), you have to explicitly list all of them in @object_ids.
1251 1252 1253 1254 1255 1256 1257
 *
 * Returns: A positive value on success, 0 if an error occurred
 *
 * Since: 3.4
 **/
guint
gtk_builder_add_objects_from_resource (GtkBuilder   *builder,
Matthias Clasen's avatar
Matthias Clasen committed
1258 1259 1260
                                       const gchar  *resource_path,
                                       gchar       **object_ids,
                                       GError      **error)
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
{
  GError *tmp_error;
  GBytes *data;
  char *filename_for_errors;
  char *slash;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (resource_path != NULL, 0);
  g_return_val_if_fail (object_ids != NULL && object_ids[0] != NULL, 0);
  g_return_val_if_fail (error == NULL || *error == NULL, 0);

  tmp_error = NULL;

  data = g_resources_lookup_data (resource_path, 0, &tmp_error);
  if (data == NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  g_free (builder->priv->filename);
  g_free (builder->priv->resource_prefix);
  builder->priv->filename = g_strdup (".");

  slash = strrchr (resource_path, '/');
  if (slash != NULL)
    builder->priv->resource_prefix =
      g_strndup (resource_path, slash - resource_path + 1);
  else
    builder->priv->resource_prefix =
      g_strdup ("/");

  filename_for_errors = g_strconcat ("<resource>", resource_path, NULL);

  _gtk_builder_parser_parse_buffer (builder, filename_for_errors,
                                    g_bytes_get_data (data, NULL), g_bytes_get_size (data),
                                    object_ids,
                                    &tmp_error);
  g_free (filename_for_errors);
  g_bytes_unref (data);

  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

1311 1312 1313 1314 1315
/**
 * gtk_builder_add_from_string:
 * @builder: a #GtkBuilder
 * @buffer: the string to parse
 * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
1316
 * @error: (allow-none): return location for an error, or %NULL
1317
 *
1318 1319
 * Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
 * and merges it with the current contents of @builder.
1320
 *
1321 1322
 * Most users will probably want to use gtk_builder_new_from_string().
 *
1323
 * Upon errors 0 will be returned and @error will be assigned a
1324 1325
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or
 * #G_VARIANT_PARSE_ERROR domain.
1326
 *
1327
 * It’s not really reasonable to attempt to handle failures of this
1328 1329 1330
 * call.  The only reasonable thing to do when an error is detected is
 * to call g_error().
 *
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
 * Returns: A positive value on success, 0 if an error occurred
 *
 * Since: 2.12
 **/
guint
gtk_builder_add_from_string (GtkBuilder   *builder,
                             const gchar  *buffer,
                             gsize         length,
                             GError      **error)
{
  GError *tmp_error;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (buffer != NULL, 0);
1345 1346 1347 1348 1349
  g_return_val_if_fail (error == NULL || *error == NULL, 0);

  tmp_error = NULL;

  g_free (builder->priv->filename);
1350
  g_free (builder->priv->resource_prefix);
1351
  builder->priv->filename = g_strdup (".");
1352
  builder->priv->resource_prefix = NULL;
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371

  _gtk_builder_parser_parse_buffer (builder, "<input>",
                                    buffer, length,
                                    NULL,
                                    &tmp_error);
  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

/**
 * gtk_builder_add_objects_from_string:
 * @builder: a #GtkBuilder
 * @buffer: the string to parse
 * @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
1372
 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
1373
 * @error: (allow-none): return location for an error, or %NULL
1374
 *
1375 1376
 * Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
 * building only the requested objects and merges
Matthias Clasen's avatar
Matthias Clasen committed
1377
 * them with the current contents of @builder.
1378 1379 1380
 *
 * Upon errors 0 will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
Matthias Clasen's avatar
Matthias Clasen committed
1381 1382
 *
 * If you are adding an object that depends on an object that is not
1383
 * its child (for instance a #GtkTreeView that depends on its
Matthias Clasen's avatar
Matthias Clasen committed
1384
 * #GtkTreeModel), you have to explicitly list all of them in @object_ids.
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
 *
 * Returns: A positive value on success, 0 if an error occurred
 *
 * Since: 2.14
 **/
guint
gtk_builder_add_objects_from_string (GtkBuilder   *builder,
                                     const gchar  *buffer,
                                     gsize         length,
                                     gchar       **object_ids,
                                     GError      **error)
{
  GError *tmp_error;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (buffer != NULL, 0);
  g_return_val_if_fail (object_ids != NULL && object_ids[0] != NULL, 0);
  g_return_val_if_fail (error == NULL || *error == NULL, 0);
1403 1404 1405

  tmp_error = NULL;

1406
  g_free (builder->priv->filename);
1407
  g_free (builder->priv->resource_prefix);
Matthias Clasen's avatar
Matthias Clasen committed
1408
  builder->priv->filename = g_strdup (".");
1409
  builder->priv->resource_prefix = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
1410

1411 1412
  _gtk_builder_parser_parse_buffer (builder, "<input>",
                                    buffer, length,
1413
                                    object_ids,
1414
                                    &tmp_error);
1415

1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

/**
 * gtk_builder_get_object:
 * @builder: a #GtkBuilder
 * @name: name of object to get
 *
Matthias Clasen's avatar
Matthias Clasen committed
1430
 * Gets the object named @name. Note that this function does not
Matthias Clasen's avatar
Matthias Clasen committed
1431
 * increment the reference count of the returned object.
Matthias Clasen's avatar
Matthias Clasen committed
1432
 *
1433
 * Returns: (transfer none): the object named @name or %NULL if
1434
 *    it could not be found in the object tree.
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
 *
 * Since: 2.12
 **/
GObject *
gtk_builder_get_object (GtkBuilder  *builder,
                        const gchar *name)
{
  g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
  g_return_val_if_fail (name != NULL, NULL);

  return g_hash_table_lookup (builder->priv->objects, name);
}

static void
Matthias Clasen's avatar
Matthias Clasen committed
1449 1450 1451
object_add_to_list (gchar    *object_id,
                    GObject  *object,
                    GSList  **list)
1452 1453 1454 1455 1456 1457 1458 1459
{
  *list = g_slist_prepend (*list, object);
}

/**
 * gtk_builder_get_objects:
 * @builder: a #GtkBuilder
 *
Matthias Clasen's avatar
Matthias Clasen committed
1460
 * Gets all objects that have been constructed by @builder. Note that
Matthias Clasen's avatar
Matthias Clasen committed
1461 1462
 * this function does not increment the reference counts of the returned
 * objects.
Matthias Clasen's avatar
Matthias Clasen committed
1463
 *
1464
 * Returns: (element-type GObject) (transfer container): a newly-allocated #GSList containing all the objects
Matthias Clasen's avatar
Matthias Clasen committed
1465 1466
 *   constructed by the #GtkBuilder instance. It should be freed by
 *   g_slist_free()
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
 *
 * Since: 2.12
 **/
GSList *
gtk_builder_get_objects (GtkBuilder *builder)
{
  GSList *objects = NULL;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);

  g_hash_table_foreach (builder->priv->objects, (GHFunc)object_add_to_list, &objects);

  return g_slist_reverse (objects);
}

/**
 * gtk_builder_set_translation_domain:
 * @builder: a #GtkBuilder
1485
 * @domain: (allow-none): the translation domain or %NULL
1486
 *
Matthias Clasen's avatar
Matthias Clasen committed
1487
 * Sets the translation domain of @builder.
Matthias Clasen's avatar
Matthias Clasen committed
1488
 * See #GtkBuilder:translation-domain.
1489 1490 1491 1492 1493 1494 1495 1496
 *
 * Since: 2.12
 **/
void
gtk_builder_set_translation_domain (GtkBuilder  *builder,
                                    const gchar *domain)
{
  gchar *new_domain;
Matthias Clasen's avatar
Matthias Clasen committed
1497

1498 1499 1500 1501 1502 1503
  g_return_if_fail (GTK_IS_BUILDER (builder));

  new_domain = g_strdup (domain);
  g_free (builder->priv->domain);
  builder->priv->domain = new_domain;

1504
  g_object_notify_by_pspec (G_OBJECT (builder), builder_props[PROP_TRANSLATION_DOMAIN]);
1505 1506 1507 1508 1509 1510
}

/**
 * gtk_builder_get_translation_domain:
 * @builder: a #GtkBuilder
 *
Matthias Clasen's avatar
Matthias Clasen committed
1511
 * Gets the translation domain of @builder.
Matthias Clasen's avatar
Matthias Clasen committed
1512
 *
1513
 * Returns: the translation domain. This string is owned
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
 * by the builder object and must not be modified or freed.
 *
 * Since: 2.12
 **/
const gchar *
gtk_builder_get_translation_domain (GtkBuilder *builder)
{
  g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);

  return builder->priv->domain;
}

1526 1527 1528 1529 1530 1531 1532 1533
/**
 * gtk_builder_expose_object:
 * @builder: a #GtkBuilder
 * @name: the name of the object exposed to the builder
 * @object: the object to expose
 *
 * Add @object to the @builder object pool so it can be referenced just like any
 * other object built by builder.
Matthias Clasen's avatar
Matthias Clasen committed
1534
 *
1535 1536 1537 1538 1539 1540 1541 1542 1543
 * Since: 3.8
 **/
void
gtk_builder_expose_object (GtkBuilder    *builder,
                           const gchar   *name,
                           GObject       *object)
{
  g_return_if_fail (GTK_IS_BUILDER (builder));
  g_return_if_fail (name && name[0]);
1544
  g_return_if_fail (!g_hash_table_contains (builder->priv->objects, name));
1545 1546 1547 1548 1549 1550 1551 1552

  object_set_name (object, name);
  g_hash_table_insert (builder->priv->objects,
                       g_strdup (name),
                       g_object_ref (object));
}


1553 1554 1555
typedef struct {
  GModule *module;
  gpointer data;
Benjamin Otte's avatar
Benjamin Otte committed
1556
} ConnectArgs;
1557 1558 1559

static void
gtk_builder_connect_signals_default (GtkBuilder    *builder,
Matthias Clasen's avatar
Matthias Clasen committed
1560 1561 1562 1563 1564 1565
                                     GObject       *object,
                                     const gchar   *signal_name,
                                     const gchar   *handler_name,
                                     GObject       *connect_object,
                                     GConnectFlags  flags,
                                     gpointer       user_data)
1566 1567
{
  GCallback func;
Benjamin Otte's avatar
Benjamin Otte committed
1568
  ConnectArgs *args = (ConnectArgs*) user_data;
1569 1570 1571 1572

  func = gtk_builder_lookup_callback_symbol (builder, handler_name);

  if (!func)
1573
    {
1574 1575 1576 1577
      /* Only error out for missing GModule support if we've not
       * found the symbols explicitly added with gtk_builder_add_callback_symbol()
       */
      if (args->module == NULL)
Matthias Clasen's avatar
Matthias Clasen committed
1578 1579
        g_error ("gtk_builder_connect_signals() requires working GModule");

1580
      if (!g_module_symbol (args->module, handler_name, (gpointer)&func))
Matthias Clasen's avatar
Matthias Clasen committed
1581 1582 1583 1584
        {
          g_warning ("Could not find signal handler '%s'.  Did you compile with -rdynamic?", handler_name);
          return;
        }
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
    }

  if (connect_object)
    g_signal_connect_object (object, signal_name, func, connect_object, flags);
  else
    g_signal_connect_data (object, signal_name, func, args->data, NULL, flags);
}


/**
 * gtk_builder_connect_signals:
 * @builder: a #GtkBuilder
1597
 * @user_data: user data to pass back with all signals
1598 1599
 *
 * This method is a simpler variation of gtk_builder_connect_signals_full().
1600 1601
 * It uses symbols explicitly added to @builder with prior calls to
 * gtk_builder_add_callback_symbol(). In the case that symbols are not
Matthias Clasen's avatar
Matthias Clasen committed
1602
 * explicitly added; it uses #GModule’s introspective features (by opening the module %NULL)
1603
 * to look at the application’s symbol table. From here it tries to match
1604
 * the signal handler names given in the interface description with
1605 1606
 * symbols in the application and connects the signals. Note that this
 * function can only be called once, subsequent calls will do nothing.
Matthias Clasen's avatar
Matthias Clasen committed
1607
 *
1608
 * Note that unless gtk_builder_add_callback_symbol() is called for
Matthias Clasen's avatar
Matthias Clasen committed
1609
 * all signal callbacks which are referenced by the loaded XML, this
1610
 * function will require that #GModule be supported on the platform.
Matthias Clasen's avatar
Matthias Clasen committed
1611
 *
1612 1613
 * If you rely on #GModule support to lookup callbacks in the symbol table,
 * the following details should be noted:
1614
 *
1615 1616 1617 1618 1619 1620
 * When compiling applications for Windows, you must declare signal callbacks
 * with #G_MODULE_EXPORT, or they will not be put in the symbol table.
 * On Linux and Unices, this is not necessary; applications should instead
 * be compiled with the -Wl,--export-dynamic CFLAGS, and linked against
 * gmodule-export-2.0.
 *
1621 1622 1623 1624
 * Since: 2.12
 **/
void
gtk_builder_connect_signals (GtkBuilder *builder,
Matthias Clasen's avatar
Matthias Clasen committed
1625
                             gpointer    user_data)
1626
{