gtkbuilder.c 57.2 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Johan Dahlin's avatar
Johan Dahlin committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * 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
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
/**
 * SECTION:gtkbuilder
 * @Short_description: Build an interface from an XML UI definition
 * @Title: GtkBuilder
 *
 * A GtkBuilder is an auxiliary object that reads textual descriptions
 * of a user interface and instantiates the described objects. To pass a
 * description to a GtkBuilder, call gtk_builder_add_from_file() or
 * gtk_builder_add_from_string(). These functions can be called multiple
 * times; the builder merges the content of all descriptions.
 *
 * 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.
 *
 * <refsect2 id="BUILDER-UI">
 * <title>GtkBuilder UI Definitions</title>
 * <para>
 * GtkBuilder parses textual descriptions of user interfaces which are specified
 * in an XML format which can be roughly described by the DTD below. We refer to
 * these descriptions as <firstterm>GtkBuilder UI definitions</firstterm> or
 * just <firstterm>UI definitions</firstterm> if the context is clear. Do not
 * confuse GtkBuilder UI Definitions with
 * <link linkend="XML-UI">GtkUIManager UI Definitions</link>, which are more
 * limited in scope.
 * </para>
 * <programlisting><![CDATA[
 * <!ELEMENT interface (requires|object)* >
 * <!ELEMENT object    (property|signal|child|ANY)* >
 * <!ELEMENT property  PCDATA >
 * <!ELEMENT signal    EMPTY >
 * <!ELEMENT requires  EMPTY >
 * <!ELEMENT child     (object|ANY*) >
 *
 * <!ATTLIST interface  domain         	    #IMPLIED >
 * <!ATTLIST object     id             	    #REQUIRED
 *                      class          	    #REQUIRED
 *                      type-func      	    #IMPLIED
 *                      constructor    	    #IMPLIED >
 * <!ATTLIST requires   lib             	    #REQUIRED
 *                      version          	    #REQUIRED >
 * <!ATTLIST property   name           	    #REQUIRED
 *                      translatable   	    #IMPLIED
 *                      comments               #IMPLIED
 *                      context                #IMPLIED >
 * <!ATTLIST signal     name           	    #REQUIRED
 *                      handler        	    #REQUIRED
 *                      after          	    #IMPLIED
 *                      swapped        	    #IMPLIED
 *                      object         	    #IMPLIED
 *                      last_modification_time #IMPLIED >
 * <!ATTLIST child      type           	    #IMPLIED
 *                      internal-child 	    #IMPLIED >
 * ]]></programlisting>
 * <para>
 * The toplevel element is &lt;interface&gt;. 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
 * &lt;object&gt; elements, which can contain &lt;property&gt; elements to set
 * properties, &lt;signal&gt; elements which connect signals to handlers, and
 * &lt;child&gt; 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 &lt;child&gt; element contains an &lt;object&gt; element which
 * describes the child object. The target toolkit version(s) are described by
 * &lt;requires&gt; 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
 * "&lt;major&gt;.&lt;minor&gt;". The builder will error out if the version
 * requirements are not met.
 *
 * Typically, the specific kind of object represented by an &lt;object&gt;
 * element is specified by the "class" attribute. If the type has not been
 * loaded yet, GTK+ tries to find the <function>_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
 * <function>_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.
 *
 * Objects must be given a name with the "id" attribute, which allows the
 * application to retrieve them from the builder with gtk_builder_get_object().
 * An id is also necessary to use the object as property value in other parts of
 * the UI definition.
 * </para>
 * <note><para>
 * Prior to 2.20, GtkBuilder was setting the "name" property of constructed widgets to the
 * "id" attribute. In GTK+ 2.20 or newer, you have to use gtk_buildable_get_name() instead
 * of gtk_widget_get_name() to obtain the "id", or set the "name" property in your UI
 * definition.
 * </para></note>
 * <para>
 * Setting properties of objects is pretty straightforward with the
 * &lt;property&gt; element: the "name" attribute specifies the name of the
 * property, and the content of the element specifies the value. If the
 * "translatable" attribute is set to a true value, GTK+ uses 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, booleans
 * (strings like "TRUE", "t", "yes", "y", "1" are interpreted as %TRUE, strings
 * like "FALSE, "f", "no", "n", "0" are interpreted as %FALSE), enumerations
 * (can be specified by their name, nick or integer value), flags (can be
 * specified by their name, nick, integer value, optionally combined with "|",
 * e.g. "GTK_VISIBLE|GTK_REALIZED")  and colors (in a format understood by
 * gdk_color_parse()). Objects can be referred to by their name. Pixbufs can be
 * specified as a filename of an image file to load. In general, GtkBuilder
 * allows forward references to objects &mdash; an object doesn't have to be
 * constructed 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.
 *
 * Signal handlers are set up with the &lt;signal&gt; 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 gtk_builder_connect_signals_full(). The
 * remaining attributes, "after", "swapped" and "object", have the same meaning
 * as the corresponding parameters of the g_signal_connect_object() or
 * g_signal_connect_data() functions. A "last_modification_time" 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 a #GtkDialog). This can be
 * achieved by setting the "internal-child" propery of the &lt;child&gt; element
 * to a true value. Note that GtkBuilder still requires an &lt;object&gt;
 * element for the internal child, even if it has already been constructed.
 *
 * 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 a UI definition
 * by specifying the "type" attribute on a &lt;child&gt;. The possible values
 * for the "type" attribute are described in the sections describing the
 * widget-specific portions of UI definitions.
 * </para>
 * <example>
 * <title>A GtkBuilder UI Definition</title>
 * <programlisting><![CDATA[
 * <interface>
 *   <object class="GtkDialog" id="dialog1">
 *     <child internal-child="vbox">
 *       <object class="GtkVBox" id="vbox1">
 *         <property name="border-width">10</property>
 *         <child internal-child="action_area">
 *           <object class="GtkHButtonBox" id="hbuttonbox1">
 *             <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>
 * ]]></programlisting>
 * </example>
 * <para>
 * Beyond this general structure, several object classes define their own XML
 * DTD fragments for filling in the ANY placeholders in the DTD above. Note that
 * a custom element in a &lt;child&gt; element gets parsed by the custom tag
 * handler of the parent object, while a custom element in an &lt;object&gt;
 * element gets parsed by the custom tag handler of the object.
 *
 * These XML fragments are explained in the documentation of the respective
 * objects, see
 * <link linkend="GtkWidget-BUILDER-UI">GtkWidget</link>,
 * <link linkend="GtkLabel-BUILDER-UI">GtkLabel</link>,
 * <link linkend="GtkWindow-BUILDER-UI">GtkWindow</link>,
 * <link linkend="GtkContainer-BUILDER-UI">GtkContainer</link>,
 * <link linkend="GtkDialog-BUILDER-UI">GtkDialog</link>,
 * <link linkend="GtkCellLayout-BUILDER-UI">GtkCellLayout</link>,
 * <link linkend="GtkColorSelectionDialog-BUILDER-UI">GtkColorSelectionDialog</link>,
 * <link linkend="GtkFontSelectionDialog-BUILDER-UI">GtkFontSelectionDialog</link>,
 * <link linkend="GtkExpander-BUILDER-UI">GtkExpander</link>,
 * <link linkend="GtkFrame-BUILDER-UI">GtkFrame</link>,
 * <link linkend="GtkListStore-BUILDER-UI">GtkListStore</link>,
 * <link linkend="GtkTreeStore-BUILDER-UI">GtkTreeStore</link>,
 * <link linkend="GtkNotebook-BUILDER-UI">GtkNotebook</link>,
 * <link linkend="GtkSizeGroup-BUILDER-UI">GtkSizeGroup</link>,
 * <link linkend="GtkTreeView-BUILDER-UI">GtkTreeView</link>,
 * <link linkend="GtkUIManager-BUILDER-UI">GtkUIManager</link>,
 * <link linkend="GtkActionGroup-BUILDER-UI">GtkActionGroup</link>.
 * <link linkend="GtkMenuItem-BUILDER-UI">GtkMenuItem</link>,
 * <link linkend="GtkAssistant-BUILDER-UI">GtkAssistant</link>,
 * <link linkend="GtkScale-BUILDER-UI">GtkScale</link>.
 * </para>
 * </refsect2>
 */

240
#include "config.h"
Johan Dahlin's avatar
Johan Dahlin committed
241
#include <errno.h> /* errno */
242
#include <stdlib.h>
Johan Dahlin's avatar
Johan Dahlin committed
243 244 245 246 247
#include <string.h> /* strlen */

#include "gtkbuilder.h"
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
248
#include "gtkdebug.h"
Johan Dahlin's avatar
Johan Dahlin committed
249 250 251 252
#include "gtkmain.h"
#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtktypebuiltins.h"
253
#include "gtkwindow.h"
Matthias Clasen's avatar
Matthias Clasen committed
254 255
#include "gtkicontheme.h"
#include "gtkstock.h"
256

Johan Dahlin's avatar
Johan Dahlin committed
257 258 259 260 261 262 263 264 265 266 267 268

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
269 270
static GType gtk_builder_real_get_type_from_name (GtkBuilder  *builder,
                                                  const gchar *type_name);
Johan Dahlin's avatar
Johan Dahlin committed
271 272 273 274 275 276 277 278 279 280

enum {
  PROP_0,
  PROP_TRANSLATION_DOMAIN,
};

struct _GtkBuilderPrivate
{
  gchar *domain;
  GHashTable *objects;
281
  GSList *delayed_properties;
Johan Dahlin's avatar
Johan Dahlin committed
282
  GSList *signals;
283
  gchar *filename;
Johan Dahlin's avatar
Johan Dahlin committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
};

G_DEFINE_TYPE (GtkBuilder, gtk_builder, G_TYPE_OBJECT)

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
301 302 303 304 305 306
 /** 
  * 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(),
307
  * otherwise g_dgettext().
Matthias Clasen's avatar
Matthias Clasen committed
308 309 310
  *
  * Since: 2.12
  */
Johan Dahlin's avatar
Johan Dahlin committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
  g_object_class_install_property (gobject_class,
                                   PROP_TRANSLATION_DOMAIN,
                                   g_param_spec_string ("translation-domain",
                                                        P_("Translation Domain"),
                                                        P_("The translation domain used by gettext"),
                                                        NULL,
                                                        GTK_PARAM_READWRITE));

  g_type_class_add_private (gobject_class, sizeof (GtkBuilderPrivate));
}

static void
gtk_builder_init (GtkBuilder *builder)
{
  builder->priv = G_TYPE_INSTANCE_GET_PRIVATE (builder, GTK_TYPE_BUILDER,
                                               GtkBuilderPrivate);
  builder->priv->domain = NULL;
  builder->priv->objects = g_hash_table_new_full (g_str_hash, g_str_equal,
329
                                                  g_free, g_object_unref);
Johan Dahlin's avatar
Johan Dahlin committed
330 331 332 333 334 335 336 337 338 339
}


/*
 * GObject virtual methods
 */

static void
gtk_builder_finalize (GObject *object)
{
340
  GtkBuilderPrivate *priv = GTK_BUILDER (object)->priv;
Johan Dahlin's avatar
Johan Dahlin committed
341
  
342 343 344 345 346 347 348 349 350
  g_free (priv->domain);
  g_free (priv->filename);
  
  g_hash_table_destroy (priv->objects);

  g_slist_foreach (priv->signals, (GFunc) _free_signal_info, NULL);
  g_slist_free (priv->signals);
  
  G_OBJECT_CLASS (gtk_builder_parent_class)->finalize (object);
Johan Dahlin's avatar
Johan Dahlin committed
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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
}

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
 *
 */
static GType
_gtk_builder_resolve_type_lazily (const gchar *name)
{
  static GModule *module = NULL;
  GTypeGetFunc func;
  GString *symbol_name = g_string_new ("");
  char c, *symbol;
  int i;
  GType gtype = G_TYPE_INVALID;

  if (!module)
    module = g_module_open (NULL, 0);
  
  for (i = 0; name[i] != '\0'; i++)
    {
      c = name[i];
      /* skip if uppercase, first or previous is uppercase */
418 419 420 421 422
      if ((c == g_ascii_toupper (c) &&
           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])))
Johan Dahlin's avatar
Johan Dahlin committed
423
        g_string_append_c (symbol_name, '_');
424
      g_string_append_c (symbol_name, g_ascii_tolower (c));
Johan Dahlin's avatar
Johan Dahlin committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    }
  g_string_append (symbol_name, "_get_type");
  
  symbol = g_string_free (symbol_name, FALSE);

  if (g_module_symbol (module, symbol, (gpointer)&func))
    gtype = func ();
  
  g_free (symbol);

  return gtype;
}

/*
 * GtkBuilder virtual methods
 */

static GType
Matthias Clasen's avatar
Matthias Clasen committed
443 444
gtk_builder_real_get_type_from_name (GtkBuilder  *builder, 
                                     const gchar *type_name)
Johan Dahlin's avatar
Johan Dahlin committed
445 446 447
{
  GType gtype;

448
  gtype = g_type_from_name (type_name);
Johan Dahlin's avatar
Johan Dahlin committed
449 450 451
  if (gtype != G_TYPE_INVALID)
    return gtype;

452
  return _gtk_builder_resolve_type_lazily (type_name);
Johan Dahlin's avatar
Johan Dahlin committed
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
}

typedef struct
{
  gchar *object;
  gchar *name;
  gchar *value;
} DelayedProperty;

static void
gtk_builder_get_parameters (GtkBuilder  *builder,
                            GType        object_type,
                            const gchar *object_name,
                            GSList      *properties,
                            GArray      **parameters,
                            GArray      **construct_parameters)
{
  GSList *l;
  GParamSpec *pspec;
  GObjectClass *oclass;
  DelayedProperty *property;
474 475
  GError *error = NULL;
  
Johan Dahlin's avatar
Johan Dahlin committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
  oclass = g_type_class_ref (object_type);
  g_assert (oclass != NULL);

  *parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));
  *construct_parameters = g_array_new (FALSE, FALSE, sizeof (GParameter));

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

      pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
                                            prop->name);
      if (!pspec)
        {
491
          g_warning ("Unknown property: %s.%s",
Johan Dahlin's avatar
Johan Dahlin committed
492 493 494 495 496 497
                     g_type_name (object_type), prop->name);
          continue;
        }

      parameter.name = prop->name;

Matthias Clasen's avatar
Matthias Clasen committed
498 499
      if (G_IS_PARAM_SPEC_OBJECT (pspec) &&
          (G_PARAM_SPEC_VALUE_TYPE (pspec) != GDK_TYPE_PIXBUF))
Johan Dahlin's avatar
Johan Dahlin committed
500 501 502 503 504 505 506
        {
          if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
            {
              GObject *object;
              object = gtk_builder_get_object (builder, prop->data);
              if (!object)
                {
Matthias Clasen's avatar
Matthias Clasen committed
507 508
                  g_warning ("Failed to get constuct only property "
                             "%s of %s with value `%s'",
Johan Dahlin's avatar
Johan Dahlin committed
509 510 511 512
                             prop->name, object_name, prop->data);
                  continue;
                }
              g_value_init (&parameter.value, G_OBJECT_TYPE (object));
513
              g_value_set_object (&parameter.value, object);
Johan Dahlin's avatar
Johan Dahlin committed
514 515 516 517 518 519 520
            }
          else
            {
              property = g_slice_new (DelayedProperty);
              property->object = g_strdup (object_name);
              property->name = g_strdup (prop->name);
              property->value = g_strdup (prop->data);
521 522 523
              builder->priv->delayed_properties =
                g_slist_prepend (builder->priv->delayed_properties, property);

Johan Dahlin's avatar
Johan Dahlin committed
524 525 526
              continue;
            }
        }
527 528
      else if (!gtk_builder_value_from_string (builder, pspec,
					       prop->data, &parameter.value, &error))
Johan Dahlin's avatar
Johan Dahlin committed
529
        {
Matthias Clasen's avatar
Matthias Clasen committed
530
          g_warning ("Failed to set property %s.%s to %s: %s",
531 532 533 534
                     g_type_name (object_type), prop->name, prop->data,
		     error->message);
	  g_error_free (error);
	  error = NULL;
Johan Dahlin's avatar
Johan Dahlin committed
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
          continue;
        }

      if (pspec->flags & G_PARAM_CONSTRUCT_ONLY)
        g_array_append_val (*construct_parameters, parameter);
      else
        g_array_append_val (*parameters, parameter);
    }

  g_type_class_unref (oclass);
}

static GObject *
gtk_builder_get_internal_child (GtkBuilder  *builder,
                                ObjectInfo  *info,
550 551
                                const gchar *childname,
				GError      **error)
Johan Dahlin's avatar
Johan Dahlin committed
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
{
  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)
576 577 578 579 580 581
    {
      g_set_error (error,
		   GTK_BUILDER_ERROR,
		   GTK_BUILDER_ERROR_INVALID_VALUE,
		   "Unknown internal child: %s", childname);
    }
Johan Dahlin's avatar
Johan Dahlin committed
582 583 584 585 586
  return obj;
}

GObject *
_gtk_builder_construct (GtkBuilder *builder,
587 588
                        ObjectInfo *info,
			GError **error)
Johan Dahlin's avatar
Johan Dahlin committed
589 590 591 592 593 594 595 596 597 598 599 600
{
  GArray *parameters, *construct_parameters;
  GType object_type;
  GObject *obj;
  int i;
  GtkBuildableIface *iface;
  gboolean custom_set_property;
  GtkBuildable *buildable;

  g_assert (info->class_name != NULL);
  object_type = gtk_builder_get_type_from_name (builder, info->class_name);
  if (object_type == G_TYPE_INVALID)
601 602 603 604 605 606 607 608
    {
      g_set_error (error,
		   GTK_BUILDER_ERROR,
		   GTK_BUILDER_ERROR_INVALID_VALUE,
		   "Invalid object type `%s'",
		   info->class_name);
      return NULL;
    }
Johan Dahlin's avatar
Johan Dahlin committed
609 610 611 612 613 614 615 616 617 618 619 620 621

  gtk_builder_get_parameters (builder, object_type,
                              info->id,
                              info->properties,
                              &parameters,
                              &construct_parameters);

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

      constructor = gtk_builder_get_object (builder, info->constructor);
      if (constructor == NULL)
622 623 624 625 626 627 628 629 630 631 632
	{
	  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;
	}
Johan Dahlin's avatar
Johan Dahlin committed
633 634 635 636 637 638 639 640 641 642
      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;
643 644 645 646 647 648 649
      obj = gtk_builder_get_internal_child (builder, info, childname, error);
      if (!obj)
	{
	  g_array_free (parameters, TRUE);
	  g_array_free (construct_parameters, TRUE);
	  return NULL;
	}
Johan Dahlin's avatar
Johan Dahlin committed
650 651
      if (construct_parameters->len)
        g_warning ("Can't pass in construct-only parameters to %s", childname);
652
      g_object_ref (obj);
Johan Dahlin's avatar
Johan Dahlin committed
653 654 655 656 657 658 659
    }
  else
    {
      obj = g_object_newv (object_type,
                           construct_parameters->len,
                           (GParameter *)construct_parameters->data);

660 661 662 663 664 665 666 667 668 669 670 671
      /* 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);

Johan Dahlin's avatar
Johan Dahlin committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
      GTK_NOTE (BUILDER,
                g_print ("created %s of type %s\n", info->id, info->class_name));

      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);
691
      if (iface->set_buildable_property)
Johan Dahlin's avatar
Johan Dahlin committed
692 693 694 695 696 697 698
        custom_set_property = TRUE;
    }

  for (i = 0; i < parameters->len; i++)
    {
      GParameter *param = &g_array_index (parameters, GParameter, i);
      if (custom_set_property)
699
        iface->set_buildable_property (buildable, builder, param->name, &param->value);
Johan Dahlin's avatar
Johan Dahlin committed
700 701 702 703
      else
        g_object_set_property (obj, param->name, &param->value);

#if G_ENABLE_DEBUG
704
      if (gtk_get_debug_flags () & GTK_DEBUG_BUILDER)
Johan Dahlin's avatar
Johan Dahlin committed
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
        {
          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);
        }
#endif      
      g_value_unset (&param->value);
    }
  g_array_free (parameters, TRUE);
  
  if (GTK_IS_BUILDABLE (obj))
    gtk_buildable_set_name (buildable, info->id);
  else
    g_object_set_data_full (obj,
                            "gtk-builder-name",
                            g_strdup (info->id),
                            g_free);

723
  /* we already own a reference to obj.  put it in the hash table. */
Johan Dahlin's avatar
Johan Dahlin committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
  g_hash_table_insert (builder->priv->objects, g_strdup (info->id), obj);
  
  return obj;
}


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)
    {
751
      g_warning ("%s: Not adding, No parent",
Johan Dahlin's avatar
Johan Dahlin committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765
                 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))));
  
766 767
  gtk_buildable_add_child (GTK_BUILDABLE (parent), builder, object,
			   child_info->type);
Johan Dahlin's avatar
Johan Dahlin committed
768 769 770 771

  child_info->added = TRUE;
}

772 773 774 775 776 777 778 779
void
_gtk_builder_add_signals (GtkBuilder *builder,
			  GSList     *signals)
{
  builder->priv->signals = g_slist_concat (builder->priv->signals,
                                           g_slist_copy (signals));
}

Johan Dahlin's avatar
Johan Dahlin committed
780
static void
781
gtk_builder_apply_delayed_properties (GtkBuilder *builder)
Johan Dahlin's avatar
Johan Dahlin committed
782
{
783
  GSList *l, *props;
Johan Dahlin's avatar
Johan Dahlin committed
784 785 786 787 788 789
  DelayedProperty *property;
  GObject *object;
  GType object_type;
  GObjectClass *oclass;
  GParamSpec *pspec;

790 791 792 793 794 795 796 797
  /* 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;

Johan Dahlin's avatar
Johan Dahlin committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
  for (l = props; l; l = l->next)
    {
      property = (DelayedProperty*)l->data;
      object = g_hash_table_lookup (builder->priv->objects, property->object);
      g_assert (object != NULL);

      object_type = G_OBJECT_TYPE (object);
      g_assert (object_type != G_TYPE_INVALID);

      oclass = g_type_class_ref (object_type);
      g_assert (oclass != NULL);

      pspec = g_object_class_find_property (G_OBJECT_CLASS (oclass),
                                            property->name);
      if (!pspec)
813
        g_warning ("Unknown property: %s.%s", g_type_name (object_type),
Johan Dahlin's avatar
Johan Dahlin committed
814 815 816 817 818 819 820
                   property->name);
      else
        {
          GObject *obj;

          obj = g_hash_table_lookup (builder->priv->objects, property->value);
          if (!obj)
821
            g_warning ("No object called: %s", property->value);
Johan Dahlin's avatar
Johan Dahlin committed
822 823 824 825 826 827 828 829 830 831 832 833 834
          else
            g_object_set (object, property->name, obj, NULL);
        }
      g_free (property->value);
      g_free (property->object);
      g_free (property->name);
      g_slice_free (DelayedProperty, property);
      g_type_class_unref (oclass);
    }
  g_slist_free (props);
}

void
835
_gtk_builder_finish (GtkBuilder *builder)
Johan Dahlin's avatar
Johan Dahlin committed
836
{
837
  gtk_builder_apply_delayed_properties (builder);
Johan Dahlin's avatar
Johan Dahlin committed
838 839 840 841 842 843 844
}

/**
 * gtk_builder_new:
 *
 * Creates a new builder object.
 *
Matthias Clasen's avatar
Matthias Clasen committed
845
 * Return value: a new #GtkBuilder object
Johan Dahlin's avatar
Johan Dahlin committed
846 847 848 849 850 851 852 853 854 855 856 857 858
 *
 * 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
Johan Dahlin's avatar
Johan Dahlin committed
859
 * @error: (allow-none): return location for an error, or %NULL
Johan Dahlin's avatar
Johan Dahlin committed
860
 *
Matthias Clasen's avatar
Matthias Clasen committed
861
 * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder 
Matthias Clasen's avatar
Matthias Clasen committed
862
 * UI definition</link> and merges it with the current contents of @builder. 
Johan Dahlin's avatar
Johan Dahlin committed
863
 * 
864 865 866 867
 * Upon errors 0 will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR 
 * domain.
 *
Johan Dahlin's avatar
Johan Dahlin committed
868 869 870 871 872 873 874 875 876
 * 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
877
  gchar *buffer;
878
  gsize length;
Johan Dahlin's avatar
Johan Dahlin committed
879 880 881 882
  GError *tmp_error;

  g_return_val_if_fail (GTK_IS_BUILDER (builder), 0);
  g_return_val_if_fail (filename != NULL, 0);
883
  g_return_val_if_fail (error == NULL || *error == NULL, 0);
Johan Dahlin's avatar
Johan Dahlin committed
884 885 886 887 888 889 890 891 892

  tmp_error = NULL;

  if (!g_file_get_contents (filename, &buffer, &length, &tmp_error))
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }
  
893
  g_free (builder->priv->filename);
894
  builder->priv->filename = g_strdup (filename);
Matthias Clasen's avatar
Matthias Clasen committed
895

Johan Dahlin's avatar
Johan Dahlin committed
896 897
  _gtk_builder_parser_parse_buffer (builder, filename,
                                    buffer, length,
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
                                    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
 * @object_ids: nul-terminated array of objects to build
Johan Dahlin's avatar
Johan Dahlin committed
917
 * @error: (allow-none): return location for an error, or %NULL
918 919 920 921 922
 *
 * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder 
 * UI definition</link> building only the requested objects and merges
 * them with the current contents of @builder. 
 *
923 924 925 926
 * Upon errors 0 will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR 
 * domain.
 *
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
 * <note><para>
 * If you are adding an object that depends on an object that is not 
 * its child (for instance a #GtkTreeView that depends on its
 * #GtkTreeModel), you have to explicitely list all of them in @object_ids. 
 * </para></note>
 *
 * 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;
    }
  
  g_free (builder->priv->filename);
  builder->priv->filename = g_strdup (filename);

  _gtk_builder_parser_parse_buffer (builder, filename,
                                    buffer, length,
                                    object_ids,
Johan Dahlin's avatar
Johan Dahlin committed
966 967
                                    &tmp_error);

968 969
  g_free (buffer);

Johan Dahlin's avatar
Johan Dahlin committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983
  if (tmp_error != NULL)
    {
      g_propagate_error (error, tmp_error);
      return 0;
    }

  return 1;
}

/**
 * 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)
Johan Dahlin's avatar
Johan Dahlin committed
984
 * @error: (allow-none): return location for an error, or %NULL
Johan Dahlin's avatar
Johan Dahlin committed
985
 *
Matthias Clasen's avatar
Matthias Clasen committed
986 987
 * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder 
 * UI definition</link> and merges it with the current contents of @builder. 
988
 *
989 990 991
 * Upon errors 0 will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
 *
Johan Dahlin's avatar
Johan Dahlin committed
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
 * 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);
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
  g_return_val_if_fail (error == NULL || *error == NULL, 0);

  tmp_error = NULL;

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

  _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)
1031
 * @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
Johan Dahlin's avatar
Johan Dahlin committed
1032
 * @error: (allow-none): return location for an error, or %NULL
1033 1034 1035 1036
 *
 * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder 
 * UI definition</link> building only the requested objects and merges
 * them with the current contents of @builder. 
1037 1038 1039
 *
 * Upon errors 0 will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
 * 
 * <note><para>
 * If you are adding an object that depends on an object that is not 
 * its child (for instance a #GtkTreeView that depends on its
 * #GtkTreeModel), you have to explicitely list all of them in @object_ids. 
 * </para></note>
 *
 * 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);
Johan Dahlin's avatar
Johan Dahlin committed
1064 1065 1066

  tmp_error = NULL;

1067
  g_free (builder->priv->filename);
Matthias Clasen's avatar
Matthias Clasen committed
1068
  builder->priv->filename = g_strdup (".");
Matthias Clasen's avatar
Matthias Clasen committed
1069

Johan Dahlin's avatar
Johan Dahlin committed
1070 1071
  _gtk_builder_parser_parse_buffer (builder, "<input>",
                                    buffer, length,
1072
                                    object_ids,
Johan Dahlin's avatar
Johan Dahlin committed
1073
                                    &tmp_error);
1074

Johan Dahlin's avatar
Johan Dahlin committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
  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
1089 1090
 * Gets the object named @name. Note that this function does not
 * increment the reference count of the returned object. 
Matthias Clasen's avatar
Matthias Clasen committed
1091
 *
1092 1093
 * Return value: (transfer none): the object named @name or %NULL if
 *    it could not be found in the object tree.
Johan Dahlin's avatar
Johan Dahlin committed
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
 *
 * 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
1108 1109 1110
object_add_to_list (gchar    *object_id,
                    GObject  *object,
                    GSList  **list)
Johan Dahlin's avatar
Johan Dahlin committed
1111 1112 1113 1114 1115 1116 1117 1118
{
  *list = g_slist_prepend (*list, object);
}

/**
 * gtk_builder_get_objects:
 * @builder: a #GtkBuilder
 *
Matthias Clasen's avatar
Matthias Clasen committed
1119 1120 1121
 * Gets all objects that have been constructed by @builder. Note that 
 * this function does not increment the reference counts of the returned
 * objects.
Matthias Clasen's avatar
Matthias Clasen committed
1122
 *
1123
 * Return value: (element-type GObject) (transfer container): a newly-allocated #GSList containing all the objects
Matthias Clasen's avatar
Matthias Clasen committed
1124 1125
 *   constructed by the #GtkBuilder instance. It should be freed by
 *   g_slist_free()
Johan Dahlin's avatar
Johan Dahlin committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
 *
 * 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
Johan Dahlin's avatar
Johan Dahlin committed
1144
 * @domain: (allow-none): the translation domain or %NULL
Johan Dahlin's avatar
Johan Dahlin committed
1145
 *
Matthias Clasen's avatar
Matthias Clasen committed
1146 1147
 * Sets the translation domain of @builder. 
 * See #GtkBuilder:translation-domain.
Johan Dahlin's avatar
Johan Dahlin committed
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
 *
 * Since: 2.12
 **/
void
gtk_builder_set_translation_domain (GtkBuilder  *builder,
                                    const gchar *domain)
{
  gchar *new_domain;
    
  g_return_if_fail (GTK_IS_BUILDER (builder));

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

  g_object_notify (G_OBJECT (builder), "translation-domain");
}

/**
 * gtk_builder_get_translation_domain:
 * @builder: a #GtkBuilder
 *
Matthias Clasen's avatar
Matthias Clasen committed
1170
 * Gets the translation domain of @builder.
Matthias Clasen's avatar
Matthias Clasen committed
1171 1172
 *
 * Return value: the translation domain. This string is owned
Johan Dahlin's avatar
Johan Dahlin committed
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
 * 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;
}

typedef struct {
  GModule *module;
  gpointer data;
} connect_args;

static void
gtk_builder_connect_signals_default (GtkBuilder    *builder,
				     GObject       *object,
				     const gchar   *signal_name,
				     const gchar   *handler_name,
				     GObject       *connect_object,
				     GConnectFlags  flags,
				     gpointer       user_data)
{
  GCallback func;
  connect_args *args = (connect_args*)user_data;
  
  if (!g_module_symbol (args->module, handler_name, (gpointer)&func))
    {
Matthias Clasen's avatar
Matthias Clasen committed
1204
      g_warning ("Could not find signal handler '%s'", handler_name);
Johan Dahlin's avatar
Johan Dahlin committed
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
      return;
    }

  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
 * @user_data: a pointer to a structure sent in as user data to all signals
 *
 * This method is a simpler variation of gtk_builder_connect_signals_full().
Matthias Clasen's avatar
Matthias Clasen committed
1221 1222
 * It uses #GModule's introspective features (by opening the module %NULL) 
 * to look at the application's symbol table. From here it tries to match
Johan Dahlin's avatar
Johan Dahlin committed
1223 1224 1225 1226 1227 1228
 * the signal handler names given in the interface description with
 * symbols in the application and connects the signals.
 * 
 * Note that this function will not work correctly if #GModule is not
 * supported on the platform.
 *
1229 1230 1231 1232 1233 1234
 * 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.
 *
Johan Dahlin's avatar
Johan Dahlin committed
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
 * Since: 2.12
 **/
void
gtk_builder_connect_signals (GtkBuilder *builder,
			     gpointer    user_data)
{
  connect_args *args;
  
  g_return_if_fail (GTK_IS_BUILDER (builder));
  
  if (!g_module_supported ())
Matthias Clasen's avatar
Matthias Clasen committed
1246
    g_error ("gtk_builder_connect_signals() requires working GModule");
Johan Dahlin's avatar
Johan Dahlin committed
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262

  args = g_slice_new0 (connect_args);
  args->module = g_module_open (NULL, G_MODULE_BIND_LAZY);
  args->data = user_data;
  
  gtk_builder_connect_signals_full (builder,
                                    gtk_builder_connect_signals_default,
                                    args);
  g_module_close (args->module);

  g_slice_free (connect_args, args);
}

/**
 * GtkBuilderConnectFunc:
 * @builder: a #GtkBuilder
Matthias Clasen's avatar
Matthias Clasen committed
1263
 * @object: object to connect a signal to
Johan Dahlin's avatar
Johan Dahlin committed
1264 1265
 * @signal_name: name of the signal
 * @handler_name: name of the handler
Matthias Clasen's avatar
Matthias Clasen committed
1266
 * @connect_object: a #GObject, if non-%NULL, use g_signal_connect_object()
Johan Dahlin's avatar
Johan Dahlin committed
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
 * @flags: #GConnectFlags to use
 * @user_data: user data
 *
 * This is the signature of a function used to connect signals.  It is used
 * by the gtk_builder_connect_signals() and gtk_builder_connect_signals_full()
 * methods.  It is mainly intended for interpreted language bindings, but
 * could be useful where the programmer wants more control over the signal
 * connection process.
 *
 * Since: 2.12
 */

/**
 * gtk_builder_connect_signals_full:
 * @builder: a #GtkBuilder
1282
 * @func: (scope call): the function used to connect the signals
Matthias Clasen's avatar
Matthias Clasen committed
1283
 * @user_data: arbitrary data that will be passed to the connection function
Johan Dahlin's avatar
Johan Dahlin committed
1284 1285
 *
 * This function can be thought of the interpreted language binding
Matthias Clasen's avatar
Matthias Clasen committed
1286 1287
 * version of gtk_builder_connect_signals(), except that it does not
 * require GModule to function correctly.
Johan Dahlin's avatar
Johan Dahlin committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
 *
 * Since: 2.12
 */
void
gtk_builder_connect_signals_full (GtkBuilder            *builder,
                                  GtkBuilderConnectFunc  func,
                                  gpointer               user_data)
{
  GSList *l;
  GObject *object;
  GObject *connect_object;
  
  g_return_if_fail (GTK_IS_BUILDER (builder));
  g_return_if_fail (func != NULL);
  
  if (!builder->priv->signals)
    return;

  builder->priv->signals = g_slist_reverse (builder->priv->signals);
  for (l = builder->priv->signals; l; l = l->next)
    {
      SignalInfo *signal = (SignalInfo*)l->data;

      g_assert (signal != NULL);
      g_assert (signal->name != NULL);

      object = g_hash_table_lookup (builder->priv->objects,
				    signal->object_name);
      g_assert (object != NULL);

      connect_object = NULL;
      
      if (signal->connect_object_name)
	{
	  connect_object = g_hash_table_lookup (builder->priv->objects,
						signal->connect_object_name);
	  if (!connect_object)
Matthias Clasen's avatar
Matthias Clasen committed
1325
	      g_warning ("Could not lookup object %s on signal %s of object %s",
Johan Dahlin's avatar
Johan Dahlin committed
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
			 signal->connect_object_name, signal->name,
			 signal->object_name);
	}
						  
      func (builder, object, signal->name, signal->handler, 
	    connect_object, signal->flags, user_data);
    }

  g_slist_foreach (builder->priv->signals, (GFunc)_free_signal_info, NULL);
  g_slist_free (builder->priv->signals);
  builder->priv->signals = NULL;
}

/**
Matthias Clasen's avatar
Matthias Clasen committed
1340
 * gtk_builder_value_from_string:
1341
 * @builder: a #GtkBuilder
Matthias Clasen's avatar
Matthias Clasen committed
1342 1343 1344
 * @pspec: the #GParamSpec for the property
 * @string: the string representation of the value
 * @value: the #GValue to store the result in
Johan Dahlin's avatar
Johan Dahlin committed
1345
 * @error: (allow-none): return location for an error, or %NULL
Johan Dahlin's avatar
Johan Dahlin committed
1346
 *
Matthias Clasen's avatar
Matthias Clasen committed
1347
 * This function demarshals a value from a string. This function
Johan Dahlin's avatar
Johan Dahlin committed
1348 1349 1350 1351
 * calls g_value_init() on the @value argument, so it need not be
 * initialised beforehand.
 *
 * This function can handle char, uchar, boolean, int, uint, long,
Matthias Clasen's avatar
Matthias Clasen committed
1352 1353
 * ulong, enum, flags, float, double, string, #GdkColor and
 * #GtkAdjustment type values. Support for #GtkWidget type values is
Johan Dahlin's avatar
Johan Dahlin committed
1354 1355
 * still to come.
 *
1356 1357 1358
 * Upon errors %FALSE will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR domain.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1359
 * Returns: %TRUE on success
Johan Dahlin's avatar
Johan Dahlin committed
1360 1361 1362 1363
 *
 * Since: 2.12
 */
gboolean
1364 1365 1366 1367 1368
gtk_builder_value_from_string (GtkBuilder   *builder,
			       GParamSpec   *pspec,
                               const gchar  *string,
                               GValue       *value,
			       GError      **error)
Johan Dahlin's avatar
Johan Dahlin committed
1369
{
1370 1371 1372 1373 1374 1375
  g_return_val_if_fail (GTK_IS_BUILDER (builder), FALSE);
  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
  g_return_val_if_fail (string != NULL, FALSE);
  g_return_val_if_fail (value != NULL, FALSE);
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);

Johan Dahlin's avatar
Johan Dahlin committed
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
  /*
   * GParamSpecUnichar has the internal type G_TYPE_UINT,
   * so we cannot handle this in the switch, do it separately
   */
  if (G_IS_PARAM_SPEC_UNICHAR (pspec))
    {
      gunichar c;
      g_value_init (value, G_TYPE_UINT);
      c = g_utf8_get_char_validated (string, strlen (string));
      if (c > 0)
        g_value_set_uint (value, c);
      return TRUE;
    }

1390 1391 1392
  return gtk_builder_value_from_string_type (builder,
					     G_PARAM_SPEC_VALUE_TYPE (pspec),
                                             string, value, error);
Johan Dahlin's avatar
Johan Dahlin committed
1393 1394 1395
}

/**
Matthias Clasen's avatar
Matthias Clasen committed
1396
 * gtk_builder_value_from_string_type:
1397
 * @builder: a #GtkBuilder
Matthias Clasen's avatar
Matthias Clasen committed
1398 1399 1400
 * @type: the #GType of the value
 * @string: the string representation of the value
 * @value: the #GValue to store the result in
Johan Dahlin's avatar
Johan Dahlin committed
1401
 * @error: (allow-none): return location for an error, or %NULL
Johan Dahlin's avatar
Johan Dahlin committed
1402
 *
Matthias Clasen's avatar
Matthias Clasen committed
1403 1404 1405 1406
 * Like gtk_builder_value_from_string(), this function demarshals 
 * a value from a string, but takes a #GType instead of #GParamSpec.
 * This function calls g_value_init() on the @value argument, so it 
 * need not be initialised beforehand.
Johan Dahlin's avatar
Johan Dahlin committed
1407
 *
1408 1409 1410
 * Upon errors %FALSE will be returned and @error will be assigned a
 * #GError from the #GTK_BUILDER_ERROR domain.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1411
 * Returns: %TRUE on success
Johan Dahlin's avatar
Johan Dahlin committed
1412 1413 1414 1415
 *
 * Since: 2.12
 */
gboolean
1416 1417 1418 1419 1420
gtk_builder_value_from_string_type (GtkBuilder   *builder,
				    GType         type,
                                    const gchar  *string,
                                    GValue       *value,
				    GError      **error)
Johan Dahlin's avatar
Johan Dahlin committed
1421 1422 1423 1424 1425
{
  gboolean ret = TRUE;

  g_return_val_if_fail (type != G_TYPE_INVALID, FALSE);
  g_return_val_if_fail (string != NULL, FALSE);
1426
  g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
Johan Dahlin's avatar
Johan Dahlin committed
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441

  g_value_init (value, type);

  switch (G_TYPE_FUNDAMENTAL (type))
    {
    case G_TYPE_CHAR:
      g_value_set_char (value, string[0]);
      break;
    case G_TYPE_UCHAR:
      g_value_set_uchar (value, (guchar)string[0]);
      break;
    case G_TYPE_BOOLEAN:
      {
        gboolean b;

1442
	if (!_gtk_builder_boolean_from_string (string, &b, error))
1443 1444 1445
	  {
	    ret = FALSE;
	    break;
Johan Dahlin's avatar
Johan Dahlin committed
1446 1447 1448 1449 1450 1451 1452 1453
          }
        g_value_set_boolean (value, b);
        break;
      }
    case G_TYPE_INT:
    case G_TYPE_LONG:
      {
        long l;
1454
        gchar *endptr = NULL;
Johan Dahlin's avatar
Johan Dahlin committed
1455
        errno = 0;
1456
        l = g_ascii_strtoll (string, &endptr, 0);
1457 1458
        if (errno || endptr == string)
          {
1459 1460 1461
	    g_set_error (error,
			 GTK_BUILDER_ERROR,
			 GTK_BUILDER_ERROR_INVALID_VALUE,
Matthias Clasen's avatar
Matthias Clasen committed
1462
			 "Could not parse integer `%s'",
1463
			 string);
1464 1465 1466
            ret = FALSE;
            break;
          }
Johan Dahlin's avatar
Johan Dahlin committed
1467 1468 1469 1470 1471 1472 1473 1474 1475
        if (G_VALUE_HOLDS_INT (value))
          g_value_set_int (value, l);
        else
          g_value_set_long (value, l);
        break;
      }
    case G_TYPE_UINT:
    case G_TYPE_ULONG:
      {
1476
        gulong ul;
1477
        gchar *endptr = NULL;
Johan Dahlin's avatar
Johan Dahlin committed
1478
        errno = 0;
1479
        ul = g_ascii_strtoull (string, &endptr, 0);
1480
        if (errno || endptr == string)
Johan Dahlin's avatar
Johan Dahlin committed
1481
          {
1482 1483 1484
	    g_set_error (error,
			 GTK_BUILDER_ERROR,
			 GTK_BUILDER_ERROR_INVALID_VALUE,
Matthias Clasen's avatar
Matthias Clasen committed
1485
			 "Could not parse unsigned integer `%s'",
1486
			 string);
1487
            ret = FALSE;
Johan Dahlin's avatar
Johan Dahlin committed
1488 1489 1490
            break;
          }
        if (G_VALUE_HOLDS_UINT (value))
1491
          g_value_set_uint (value, ul);
Johan Dahlin's avatar
Johan Dahlin committed
1492
        else 
1493
          g_value_set_ulong (value, ul);
Johan Dahlin's avatar
Johan Dahlin committed
1494 1495 1496
        break;
      }
    case G_TYPE_ENUM:
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
      {
	gint enum_value;
	if (!_gtk_builder_enum_from_string (type, string, &enum_value, error))
	  {
	    ret = FALSE;
	    break;
          }
	g_value_set_enum (value, enum_value);
	break;
      }
Johan Dahlin's avatar
Johan Dahlin committed
1507
    case G_TYPE_FLAGS:
1508
      {
1509 1510
	guint flags_value;

1511 1512 1513 1514 1515 1516 1517 1518
	if (!_gtk_builder_flags_from_string (type, string, &flags_value, error))
	  {
	    ret = FALSE;
	    break;
          }
	g_value_set_flags (value, flags_value);
	break;
      }
Johan Dahlin's avatar
Johan Dahlin committed
1519 1520 1521
    case G_TYPE_FLOAT:
    case G_TYPE_DOUBLE:
      {
Matthias Clasen's avatar
Matthias Clasen committed
1522
        gdouble d;
1523
        gchar *endptr = NULL;
Johan Dahlin's avatar
Johan Dahlin committed
1524
        errno = 0;
1525 1526
        d = g_ascii_strtod (string, &endptr);
        if (errno || endptr == string)
Johan Dahlin's avatar
Johan Dahlin committed
1527
          {
1528 1529 1530
	    g_set_error (error,
			 GTK_BUILDER_ERROR,
			 GTK_BUILDER_ERROR_INVALID_VALUE,
Matthias Clasen's avatar
Matthias Clasen committed
1531
			 "Could not parse double `%s'",
1532
			 string);
1533
            ret = FALSE;
Johan Dahlin's avatar
Johan Dahlin committed
1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
            break;
          }
        if (G_VALUE_HOLDS_FLOAT (value))
          g_value_set_float (value, d);
        else
          g_value_set_double (value, d);
        break;
      }
    case G_TYPE_STRING:
      g_value_set_string (value, string);
      break;
    case G_TYPE_BOXED:
      if (G_VALUE_HOLDS (value, GDK_TYPE_COLOR))
        {
1548
          GdkColor color = { 0, };
Johan Dahlin's avatar
Johan Dahlin committed
1549

1550 1551
          if (gdk_color_parse (string, &color))
            g_value_set_boxed (value, &color);
Johan Dahlin's avatar
Johan Dahlin committed
1552 1553
          else
            {
1554 1555 1556
	      g_set_error (error,
			   GTK_BUILDER_ERROR,
			   GTK_BUILDER_ERROR_INVALID_VALUE,
Matthias Clasen's avatar
Matthias Clasen committed
1557
			   "Could not parse color `%s'",
1558
			   string);
Johan Dahlin's avatar
Johan Dahlin committed
1559 1560 1561
              ret = FALSE;
            }
        }
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
      else if (G_VALUE_HOLDS (value, GDK_TYPE_RGBA))
        {
          GdkRGBA rgba = { 0 };

          if (gdk_rgba_parse (string, &rgba))
            g_value_set_boxed (value, &rgba);
          else
            {
              g_set_error (error,
                           GTK_BUILDER_ERROR,
                           GTK_BUILDER_ERROR_INVALID_VALUE,
                           "Could not parse RGBA color '%s'",
                           string);
              ret = FALSE;
            }
        }
Johan Dahlin's avatar
Johan Dahlin committed
1578 1579
      else if (G_VALUE_HOLDS (value, G_TYPE_STRV))
        {
Matthias Clasen's avatar
Matthias Clasen committed
1580
          gchar **vector = g_strsplit (string, "\n", 0);
Johan Dahlin's avatar
Johan Dahlin committed
1581 1582 1583
          g_value_take_boxed (value, vector);
        }
      else
Matthias Clasen's avatar
Matthias Clasen committed
1584 1585 1586 1587 1588 1589 1590 1591
        {
          g_set_error (error,
                       GTK_BUILDER_ERROR,
                       GTK_BUILDER_ERROR_INVALID_VALUE,
                       "Could not parse '%s' as a %s",
                       string, G_VALUE_TYPE_NAME (value));
          ret = FALSE;
        }
Johan Dahlin's avatar
Johan Dahlin committed
1592 1593
      break;
    case G_TYPE_OBJECT:
Matthias Clasen's avatar
Matthias Clasen committed
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
      if (G_VALUE_HOLDS (value, GDK_TYPE_PIXBUF))
        {
          gchar *filename;
          GError *tmp_error = NULL;
          GdkPixbuf *pixbuf;
       
          if (gtk_builder_get_object (builder, string))
            {
              g_set_error (error,
                           GTK_BUILDER_ERROR,
                           GTK_BUILDER_ERROR_INVALID_VALUE,
                           "Could not load image '%s': "
                           " '%s' is already used as object id",
                           string, string);
              return FALSE;
            }
Johan Dahlin's avatar
Johan Dahlin committed
1610

1611
	  filename = _gtk_builder_get_absolute_filename (builder, string);
Matthias Clasen's avatar
Matthias Clasen committed
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
          pixbuf = gdk_pixbuf_new_from_file (filename, &tmp_error);

          if (pixbuf == NULL)
            {
              GtkIconTheme *theme;

              g_warning ("Could not load image '%s': %s", 
                         string, tmp_error->message);
              g_error_free (tmp_error);

              /* fall back to a missing image */
              theme = gtk_icon_theme_get_default ();
              pixbuf = gtk_icon_theme_load_icon (theme, 
                                                 GTK_STOCK_MISSING_IMAGE,
                                                 16,
                                                 GTK_ICON_LOOKUP_USE_BUILTIN,
                                                 NULL);
            }
 
          if (pixbuf)
            {
              g_value_set_object (value, pixbuf);
              g_object_unref (G_OBJECT (pixbuf));
            }

          g_free (filename);

          ret = TRUE;
        }
      else
Matthias Clasen's avatar
Matthias Clasen committed
1642
        ret = FALSE;
Johan Dahlin's avatar
Johan Dahlin committed
1643 1644 1645 1646 1647
      break;
    default:
      ret = FALSE;
      break;
    }
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
 
  /* Catch unassigned error for object types as well as any unsupported types.
   * While parsing GtkBuilder; object types are deserialized
   * without calling gtk_builder_value_from_string_type().
   */
  if (!ret && error && *error == NULL) 
    g_set_error (error,
		 GTK_BUILDER_ERROR,
		 GTK_BUILDER_ERROR_INVALID_VALUE,
		 "Unsupported GType `%s'", g_type_name (type));
Johan Dahlin's avatar
Johan Dahlin committed
1658 1659 1660 1661

  return ret;
}

1662
gboolean
1663 1664 1665 1666
_gtk_builder_enum_from_string (GType         type, 
                               const gchar  *string,
			       gint         *enum_value,
			       GError      **error)
Johan Dahlin's avatar
Johan Dahlin committed
1667 1668 1669 1670
{
  GEnumClass *eclass;
  GEnumValue *ev;
  gchar *endptr;
1671
  gint value;
1672
  gboolean ret;
1673
  
1674 1675
  g_return_val_if_fail (G_TYPE_IS_ENUM (type), FALSE);
  g_return_val_if_fail (string != NULL, FALSE);
Johan Dahlin's avatar
Johan Dahlin committed
1676
  
1677 1678
  ret = TRUE;

1679 1680 1681 1682
  endptr = NULL;
  errno = 0;
  value = g_ascii_strtoull (string, &endptr, 0);
  if (errno == 0 && endptr != string) /* parsed a number */
1683 1684 1685 1686 1687 1688 1689
    *enum_value = value;
  else
    {
      eclass = g_type_class_ref (type);
      ev = g_enum_get_value_by_name (eclass, string);
      if (!ev)
	ev = g_enum_get_value_by_nick (eclass, string);
Johan Dahlin's avatar
Johan Dahlin committed
1690

1691 1692 1693 1694 1695 1696 1697 1698 1699
      if (ev)
	*enum_value = ev->value;
      else
	{
	  g_set_error (error,
		       GTK_BUILDER_ERROR,
		       GTK_BUILDER_ERROR_INVALID_VALUE,
		       "Could not parse enum: `%s'",
		       string);
1700
	  ret = FALSE;
1701 1702 1703 1704 1705
	}
      
      g_type_class_unref (eclass);
    }
  
1706
  return ret;
Johan Dahlin's avatar
Johan Dahlin committed
1707 1708
}

1709 1710 1711
gboolean
_gtk_builder_flags_from_string (GType         type, 
                                const gchar  *string,
1712
				guint        *flags_value,
1713
				GError      **error)
Johan Dahlin's avatar
Johan Dahlin committed
1714 1715 1716
{
  GFlagsClass *fclass;
  gchar *endptr, *prevptr;
1717
  guint i, j, value;
Matthias Clasen's avatar
Matthias Clasen committed
1718
  gchar *flagstr;
Johan Dahlin's avatar
Johan Dahlin committed
1719
  GFlagsValue *fv;
Matthias Clasen's avatar
Matthias Clasen committed
1720
  const gchar *flag;
Johan Dahlin's avatar
Johan Dahlin committed
1721
  gunichar ch;
1722
  gboolean eos, ret;
Johan Dahlin's avatar
Johan Dahlin committed
1723

1724 1725
  g_return_val_if_fail (G_TYPE_IS_FLAGS (type), FALSE);
  g_return_val_if_fail (string != 0, FALSE);
Johan Dahlin's avatar
Johan Dahlin committed
1726

1727
  ret = TRUE;
1728 1729 1730 1731 1732

  endptr = NULL;
  errno = 0;
  value = g_ascii_strtoull (string, &endptr, 0);
  if (errno == 0 && endptr != string) /* parsed a number */
1733 1734
    *flags_value = value;
  else
Johan Dahlin's avatar
Johan Dahlin committed
1735
    {
1736
      fclass = g_type_class_ref (type);
Johan Dahlin's avatar
Johan Dahlin committed
1737

1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
      flagstr = g_strdup (string);
      for (value = i = j = 0; ; i++)
	{
	  
	  eos = flagstr[i] == '\0';
	  
	  if (!eos && flagstr[i] != '|')
	    continue;
	  
	  flag = &flagstr[j];
	  endptr = &flagstr[i];
	  
	  if (!eos)
	    {
	      flagstr[i++] = '\0';
	      j = i;
	    }
	  
	  /* trim spaces */
	  for (;;)
	    {
	      ch = g_utf8_get_char (flag);
	      if (!g_unichar_isspace (ch))
		break;
	      flag = g_utf8_next_char (flag);
	    }
	  
	  while (endptr > flag)
	    {
	      prevptr = g_utf8_prev_char (endptr);
	      ch = g_utf8_get_char (prevptr);
	      if (!g_unichar_isspace (ch))
		break;
	      endptr = prevptr;
	    }
	  
	  if (endptr > flag)
	    {
	      *endptr = '\0';
	      fv = g_flags_get_value_by_name (fclass, flag);
	      
	      if (!fv)
		fv = g_flags_get_value_by_nick (fclass, flag);
	      
	      if (fv)
		value |= fv->value;
	      else
		{
		  g_set_error (error,
			       GTK_BUILDER_ERROR,
			       GTK_BUILDER_ERROR_INVALID_VALUE,
			       "Unknown flag: `%s'",
			       flag);
		  ret = FALSE;
		  break;
		}
	    }
	  
	  if (eos)
	    {
	      *flags_value = value;
	      break;
	    }
	}
      
      g_free (flagstr);
      
      g_type_class_unref (fclass);
Johan Dahlin's avatar
Johan Dahlin committed
1806 1807 1808 1809 1810 1811 1812 1813
    }

  return ret;
}

/**
 * gtk_builder_get_type_from_name:
 * @builder: a #GtkBuilder
Matthias Clasen's avatar
Matthias Clasen committed
1814
 * @type_name: type name to lookup
Matthias Clasen's avatar
Matthias Clasen committed
1815
 *
Matthias Clasen's avatar
Matthias Clasen committed
1816
 * Looks up a type by name, using the virtual function that 
1817 1818
 * #GtkBuilder has for that purpose. This is mainly used when
 * implementing the #GtkBuildable interface on a type.
Johan Dahlin's avatar
Johan Dahlin committed
1819
 *
Matthias Clasen's avatar
Matthias Clasen committed
1820 1821
 * Returns: the #GType found for @type_name or #G_TYPE_INVALID 
 *   if no type was found
Johan Dahlin's avatar
Johan Dahlin committed
1822
 *
1823
 * Since: 2.12
Johan Dahlin's avatar
Johan Dahlin committed
1824 1825
 */
GType
Matthias Clasen's avatar
Matthias Clasen committed
1826 1827
gtk_builder_get_type_from_name (GtkBuilder  *builder, 
                                const gchar *type_name)
Johan Dahlin's avatar
Johan Dahlin committed
1828