Allow for multiple a11y properties

blueprintcompiler/language/gtk_a11y.py

@@ -17,6 +17,8 @@
 #
 # SPDX-License-Identifier: LGPL-3.0-or-later
 
+import typing as T
+
 from ..decompiler import escape_quote
 from .attributes import BaseAttribute
 from .common import *
@@ -97,6 +99,16 @@ def get_types(gir):
     }
 
 
+allow_duplicates = [
+    "controls",
+    "described-by",
+    "details",
+    "flow-to",
+    "labelled-by",
+    "owns",
+]
+
+
 def _get_docs(gir, name):
     name = name.replace("-", "_")
     if gir_type := (
@@ -111,7 +123,7 @@ class A11yProperty(BaseAttribute):
     grammar = Statement(
         UseIdent("name"),
         ":",
-        Value,
+        AnyOf(Value, ["[", UseLiteral("list_form", True), Delimited(Value, ","), "]"]),
     )
 
     @property
@@ -132,8 +144,8 @@ class A11yProperty(BaseAttribute):
         return self.tokens["name"].replace("_", "-")
 
     @property
-    def value(self) -> Value:
+    def values(self) -> T.List[Value]:
-        return self.children[0]
+        return list(self.children)
 
     @context(ValueTypeCtx)
     def value_type(self) -> ValueTypeCtx:
@@ -146,7 +158,7 @@ class A11yProperty(BaseAttribute):
             SymbolKind.Field,
             self.range,
             self.group.tokens["name"].range,
-            self.value.range.text,
+            ", ".join(v.range.text for v in self.values),
         )
 
     @validate("name")
@@ -165,6 +177,20 @@ class A11yProperty(BaseAttribute):
             check=lambda child: child.tokens["name"] == self.tokens["name"],
         )
 
+    @validate("name")
+    def list_only_allowed_for_subset(self):
+        if self.tokens["list_form"] and self.tokens["name"] not in allow_duplicates:
+            raise CompileError(
+                f"'{self.tokens['name']}' does not allow a list of values",
+            )
+
+    @validate("name")
+    def list_non_empty(self):
+        if len(self.values) == 0:
+            raise CompileError(
+                f"'{self.tokens['name']}' may not be empty",
+            )
+
     @docs("name")
     def prop_docs(self):
         if self.tokens["name"] in get_types(self.root.gir):

blueprintcompiler/outputs/xml/__init__.py

@@ -292,8 +292,11 @@ class XmlOutput(OutputFormat):
     def _emit_extensions(self, extension, xml: XmlEmitter):
         if isinstance(extension, ExtAccessibility):
             xml.start_tag("accessibility")
-            for prop in extension.properties:
+            for property in extension.properties:
-                self._emit_attribute(prop.tag_name, "name", prop.name, prop.value, xml)
+                for val in property.values:
+                    self._emit_attribute(
+                        property.tag_name, "name", property.name, val, xml
+                    )
             xml.end_tag()
 
         elif isinstance(extension, AdwBreakpointCondition):

docs/reference/extensions.rst

@@ -37,12 +37,15 @@ Accessibility Properties
 .. rst-class:: grammar-block
 
    ExtAccessibility = 'accessibility' '{' ExtAccessibilityProp* '}'
-   ExtAccessibilityProp = <name::ref:`IDENT<Syntax IDENT>`> ':' :ref:`Value <Syntax Value>` ';'
+   ExtAccessibilityProp = <name::ref:`IDENT<Syntax IDENT>`> ':' (:ref:`Value <Syntax Value>` | ('[' (:ref: Value <Syntax Value>),* ']') ) ';'
 
 Valid in any `Gtk.Widget <https://docs.gtk.org/gtk4/class.Widget.html>`_.
 
 The ``accessibility`` block defines values relevant to accessibility software. The property names and acceptable values are described in the `Gtk.AccessibleRelation <https://docs.gtk.org/gtk4/enum.AccessibleRelation.html>`_, `Gtk.AccessibleState <https://docs.gtk.org/gtk4/enum.AccessibleState.html>`_, and `Gtk.AccessibleProperty <https://docs.gtk.org/gtk4/enum.AccessibleProperty.html>`_ enums.
 
+.. note::
+
+   Relations which allow for a list of values, for example `labelled-by`, must be given as a single relation with a list of values instead of duplicating the relation like done in Gtk.Builder.
 
 .. _Syntax ExtAdwBreakpoint:
 

tests/sample_errors/a11y_list_empty.blp

@@ -0,0 +1,9 @@
+using Gtk 4.0;
+
+Box {
+  accessibility {
+    label: _("Hello, world!");
+    labelled-by: [];
+    checked: true;
+  }
+}

tests/sample_errors/a11y_list_empty.err

@@ -0,0 +1 @@
+6,5,11,'labelled-by' may not be empty

tests/sample_errors/a11y_non_list_property.blp

@@ -0,0 +1,15 @@
+using Gtk 4.0;
+
+Box {
+  accessibility {
+    label: _("Hello, world!");
+    active-descendant: [my_label1, my_label2, my_label3];
+    checked: true;
+  }
+}
+
+Label my_label1 {}
+
+Label my_label2 {}
+
+Label my_label3 {}

tests/sample_errors/a11y_non_list_property.err

@@ -0,0 +1 @@
+6,5,17,'active-descendant' does not allow a list of values

tests/samples/accessibility_multiple_labelled_by.blp

@@ -0,0 +1,15 @@
+using Gtk 4.0;
+
+Box {
+  accessibility {
+    label: _("Hello, world!");
+    labelled-by: [my_label1, my_label2, my_label3];
+    checked: true;
+  }
+}
+
+Label my_label1 {}
+
+Label my_label2 {}
+
+Label my_label3 {}

tests/samples/accessibility_multiple_labelled_by.ui

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
+<interface>
+  <requires lib="gtk" version="4.0"/>
+  <object class="GtkBox">
+    <accessibility>
+      <property name="label" translatable="yes">Hello, world!</property>
+      <relation name="labelled-by">my_label1</relation>
+      <relation name="labelled-by">my_label2</relation>
+      <relation name="labelled-by">my_label3</relation>
+      <state name="checked">1</state>
+    </accessibility>
+  </object>
+  <object class="GtkLabel" id="my_label1"></object>
+  <object class="GtkLabel" id="my_label2"></object>
+  <object class="GtkLabel" id="my_label3"></object>
+</interface>

tests/test_samples.py

@@ -221,6 +221,8 @@ class TestSamples(unittest.TestCase):
                 "list_factory",
                 # Not implemented yet
                 "subscope",
+                # Not implemented yet
+                "accessibility_multiple_labelled_by",
             ]
 
             if sample in REQUIRE_ADW_1_4 and not self.have_adw_1_4: