Merge branch 'wip/exalm/buildable' into 'main'

builderparser: Don't exit too early on nested custom tags

See merge request GNOME/gtk!5566

gtk/gtkbuilderparser.c

@@ -1608,6 +1608,7 @@ create_subparser (GObject       *object,
   subparser->object = object;
   subparser->child = child;
   subparser->tagname = g_strdup (element_name);
+  subparser->level = 1;
   subparser->start = element_name;
   subparser->parser = g_memdup2 (parser, sizeof (GtkBuildableParser));
   subparser->data = user_data;
@@ -1638,6 +1639,8 @@ subparser_start (GtkBuildableParseContext  *context,
 
   if (subparser->start)
     {
+      subparser->level++;
+
       if (subparser->parser->start_element)
         subparser->parser->start_element (context,
                                           element_name, names, values,
@@ -1653,6 +1656,8 @@ subparser_end (GtkBuildableParseContext  *context,
                ParserData                *data,
                GError                   **error)
 {
+  data->subparser->level--;
+
   if (data->subparser->parser->end_element)
     data->subparser->parser->end_element (context, element_name,
                                           data->subparser->data, error);
@@ -1660,9 +1665,11 @@ subparser_end (GtkBuildableParseContext  *context,
   if (*error)
     return;
 
-  if (strcmp (data->subparser->start, element_name) != 0)
+  if (data->subparser->level > 0)
     return;
 
+  g_assert (strcmp (data->subparser->start, element_name) == 0);
+
   gtk_buildable_custom_tag_end (GTK_BUILDABLE (data->subparser->object),
                                 data->builder,
                                 data->subparser->child,

gtk/gtkbuilderprivate.h

@@ -165,6 +165,7 @@ struct _GtkBuildableParseContext {
 typedef struct {
   GtkBuildableParser *parser;
   char *tagname;
+  int level;
   const char *start;
   gpointer data;
   GObject *object;

testsuite/gtk/builder.c

@@ -2796,6 +2796,110 @@ test_child_dispose_order (void)
   g_assert_cmpuint (data.destroy_count, ==, 2);
 }
 
+#define MY_GTK_BUILDABLE_TEMPLATE "\
+<interface>\n\
+ <template class=\"MyGtkBuildable\" parent=\"GtkWidget\">\n\
+  <custom/>\n\
+  <custom>\n\
+    <custom/>\n\
+  </custom>\n\
+ </template>\n\
+</interface>\n"
+
+#define MY_TYPE_GTK_BUILDABLE (my_gtk_buildable_get_type ())
+G_DECLARE_FINAL_TYPE          (MyGtkBuildable, my_gtk_buildable, MY, GTK_BUILDABLE, GtkWidget)
+
+struct _MyGtkBuildable
+{
+  GtkWidget parent_instance;
+};
+
+static void my_gtk_buildable_buildable_init (GtkBuildableIface *iface);
+static GtkBuildableIface *parent_buildable_iface;
+
+G_DEFINE_TYPE_WITH_CODE (MyGtkBuildable, my_gtk_buildable, GTK_TYPE_WIDGET,
+                         G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
+                                                my_gtk_buildable_buildable_init));
+
+static void
+my_gtk_buildable_init (MyGtkBuildable *buildable)
+{
+  gtk_widget_init_template (GTK_WIDGET (buildable));
+}
+
+static void
+my_gtk_buildable_class_init (MyGtkBuildableClass *klass)
+{
+  GBytes *template = g_bytes_new_static (MY_GTK_BUILDABLE_TEMPLATE, strlen (MY_GTK_BUILDABLE_TEMPLATE));
+  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
+
+  gtk_widget_class_set_template (widget_class, template);
+}
+
+static const GtkBuildableParser custom_parser = {
+  NULL,
+  NULL,
+  NULL,
+  NULL
+};
+
+static gboolean
+my_gtk_buildable_custom_tag_start (GtkBuildable       *buildable,
+                                   GtkBuilder         *builder,
+                                   GObject            *child,
+                                   const char         *tagname,
+                                   GtkBuildableParser *parser,
+                                   gpointer           *parser_data)
+{
+  if (strcmp (tagname, "custom") == 0) {
+    *parser = custom_parser;
+    *parser_data = NULL;
+
+    return TRUE;
+  }
+
+  return FALSE;
+}
+
+static void
+my_gtk_buildable_custom_finished (GtkBuildable *buildable,
+                                  GtkBuilder   *builder,
+                                  GObject      *child,
+                                  const char   *tagname,
+                                  gpointer      user_data)
+{
+  if (strcmp (tagname, "custom") == 0)
+    return;
+
+  parent_buildable_iface->custom_finished (buildable, builder, child,
+                                           tagname, user_data);
+}
+
+static void
+my_gtk_buildable_buildable_init (GtkBuildableIface *iface)
+{
+  parent_buildable_iface = g_type_interface_peek_parent (iface);
+
+  iface->custom_tag_start = my_gtk_buildable_custom_tag_start;
+  iface->custom_finished = my_gtk_buildable_custom_finished;
+}
+
+static void
+test_buildable (void)
+{
+  MyGtkBuildable *my_gtk_buildable;
+
+  /* make sure the type we are trying to register does not exist */
+  g_assert_false (g_type_from_name ("MyGtkBuildable"));
+
+  /* create the template object */
+  my_gtk_buildable = g_object_new (MY_TYPE_GTK_BUILDABLE, NULL);
+
+  /* Check everything is fine */
+  g_assert_true (g_type_from_name ("MyGtkBuildable"));
+  g_assert_true (MY_IS_GTK_BUILDABLE (my_gtk_buildable));
+}
+
 int
 main (int argc, char **argv)
 {
@@ -2844,6 +2948,7 @@ main (int argc, char **argv)
   g_test_add_func ("/Builder/Transforms", test_transforms);
   g_test_add_func ("/Builder/Expressions", test_expressions);
   g_test_add_func ("/Builder/Child Dispose Order", test_child_dispose_order);
+  g_test_add_func ("/Builder/Buildable", test_buildable);
 
   return g_test_run();
 }