Builder list factory

.gitignore

@@ -12,3 +12,5 @@ coverage.xml
 
 /corpus
 /crashes
+
+.vscode

blueprintcompiler/language/__init__.py

@@ -1,3 +1,4 @@
+from .gtk_list_item_factory import ListItemFactory
 from .adw_message_dialog import Responses
 from .attributes import BaseAttribute, BaseTypedAttribute
 from .binding import Binding
@@ -57,6 +58,7 @@ OBJECT_CONTENT_HOOKS.children = [
     Widgets,
     Items,
     Strings,
+    ListItemFactory,
     Responses,
     Child,
 ]

blueprintcompiler/language/gtk_list_item_factory.py

@@ -0,0 +1,32 @@
+from .gobject_object import ObjectContent, validate_parent_type
+from ..parse_tree import Keyword
+from ..ast_utils import AstNode, validate
+
+
+class ListItemFactory(AstNode):
+    grammar = [Keyword("template"), ObjectContent]
+
+    @property
+    def gir_class(self):
+        return self.root.gir.get_type("ListItem", "Gtk")
+
+    @validate("template")
+    def container_is_builder_list(self):
+        validate_parent_type(
+            self,
+            "Gtk",
+            "BuilderListItemFactory",
+            "sub-templates",
+        )
+
+    @property
+    def content(self) -> ObjectContent:
+        return self.children[ObjectContent][0]
+
+    @property
+    def action_widgets(self):
+        """
+        The sub-template shouldn't have it`s own actions this is
+        just hear to satisfy XmlOutput._emit_object_or_template
+        """
+        return None

blueprintcompiler/outputs/xml/__init__.py

@@ -304,6 +304,16 @@ class XmlOutput(OutputFormat):
                     self._emit_value(value, xml)
                     xml.end_tag()
             xml.end_tag()
+        elif isinstance(extension, ListItemFactory):
+            child_xml = XmlEmitter()
+            child_xml.start_tag("interface")
+            child_xml.start_tag("template", **{"class": "GtkListItem"})
+            self._emit_object_or_template(extension, child_xml)
+            child_xml.end_tag()
+            child_xml.end_tag()
+            xml.start_tag("property", name="bytes")
+            xml.put_cdata(child_xml.result)
+            xml.end_tag()
 
         elif isinstance(extension, Styles):
             xml.start_tag("style")

blueprintcompiler/outputs/xml/xml_emitter.py

@@ -62,6 +62,10 @@ class XmlEmitter:
         self.result += saxutils.escape(str(text))
         self._needs_newline = False
 
+    def put_cdata(self, text: str):
+        self.result += f"<![CDATA[{text}]]>"
+        self._needs_newline = False
+
     def _indent(self):
         if self.indent is not None:
             self.result += "\n" + " " * (self.indent * len(self._tag_stack))

docs/examples.rst

@@ -414,6 +414,21 @@ Gtk.SizeGroup
    Gtk.Label label1 {}
    Gtk.Label label2 {}
 
+Gtk.BuilderListItemFactory
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block::
+
+    Gtk.ListView {
+      factory: Gtk.BuilderListItemFactory {
+          template {
+              child: Label {
+                  label: "Hello";
+              };
+          }
+      };
+    }
+
 Gtk.StringList
 ~~~~~~~~~~~~~~
 

tests/samples/list_factory.blp

@@ -0,0 +1,11 @@
+using Gtk 4.0;
+
+Gtk.ListView {
+    factory: Gtk.BuilderListItemFactory list_item_factory {
+        template {
+            child: Label {
+                label: "Hello";
+            };
+        }
+    };
+}

tests/samples/list_factory.ui

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <requires lib="gtk" version="4.0"/>
+  <object class="GtkListView">
+    <property name="factory">
+      <object class="GtkBuilderListItemFactory" id="list_item_factory">
+        <property name="bytes"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <template class="GtkListItem">
+    <property name="child">
+      <object class="GtkLabel">
+        <property name="label">Hello</property>
+      </object>
+    </property>
+  </template>
+</interface>]]></property>
+      </object>
+    </property>
+  </object>
+</interface>

tests/test_samples.py

@@ -169,6 +169,7 @@ class TestSamples(unittest.TestCase):
         self.assert_sample("flags")
         self.assert_sample("id_prop")
         self.assert_sample("layout")
+        self.assert_sample("list_factory")
         self.assert_sample("menu")
         self.assert_sample("numbers")
         self.assert_sample("object_prop")