language: Fix some issues with menus

Blueprint's handling of menus didn't line up with how GtkBuilder handles
them. The root <menu> element must have an ID and may not have
attributes, and menus may not be used inline in a property.

blueprintcompiler/language/__init__.py

@@ -21,11 +21,6 @@ from .values import IdentValue, TranslatedStringValue, FlagsValue, LiteralValue
 
 from .common import *
 
-OBJECT_HOOKS.children = [
-    menu,
-    Object,
-]
-
 OBJECT_CONTENT_HOOKS.children = [
     Signal,
     Property,

blueprintcompiler/language/common.py

@@ -31,6 +31,5 @@ from ..parser_utils import *
 from ..xml_emitter import XmlEmitter
 
 
-OBJECT_HOOKS = AnyOf()
 OBJECT_CONTENT_HOOKS = AnyOf()
 VALUE_HOOKS = AnyOf()

blueprintcompiler/language/gobject_property.py

@@ -44,7 +44,7 @@ class Property(AstNode):
             UseIdent("name"),
             ":",
             AnyOf(
-                OBJECT_HOOKS,
+                Object,
                 VALUE_HOOKS,
             ).expected("a value"),
         ),

blueprintcompiler/language/gtk_menu.py

@@ -20,7 +20,6 @@
 
 from .attributes import BaseAttribute
 from .gobject_object import Object, ObjectContent
-from .ui import UI
 from .common import *
 
 
@@ -31,6 +30,11 @@ class Menu(Object):
             child.emit_xml(xml)
         xml.end_tag()
 
+    @validate("menu")
+    def has_id(self):
+        if self.tokens["tag"] == "menu" and self.tokens["id"] is None:
+            raise CompileError("Menu requires an ID")
+
     @property
     def gir_class(self):
         return self.root.gir.namespaces["Gtk"].lookup_type("Gio.MenuModel")
@@ -39,6 +43,11 @@ class Menu(Object):
 class MenuAttribute(BaseAttribute):
     tag_name = "attribute"
 
+    @validate()
+    def not_in_menu(self):
+        if self.parent.tokens["tag"] == "menu":
+            raise CompileError("Menu root may not have attributes")
+
     @property
     def value_type(self):
         return None
@@ -128,16 +137,17 @@ menu_contents.children = [
     ), "}"),
 ]
 
-menu = Group(
+menu: Group = Group(
     Menu,
     [
-        "menu",
+        Keyword("menu"),
         UseLiteral("tag", "menu"),
         Optional(UseIdent("id")),
         menu_contents
     ],
 )
 
+from .ui import UI
 
 @completer(
     applies_in=[UI],

blueprintcompiler/language/ui.py

@@ -20,6 +20,8 @@
 
 from .. import gir
 from .imports import GtkDirective, Import
+from .gtk_menu import menu
+from .gobject_object import Object
 from .gtkbuilder_template import Template
 from .common import *
 
@@ -32,7 +34,8 @@ class UI(AstNode):
         ZeroOrMore(Import),
         Until(AnyOf(
             Template,
-            OBJECT_HOOKS,
+            menu,
+            Object,
         ), Eof()),
     ]
 

blueprintcompiler/parser.py

@@ -22,7 +22,7 @@ from .errors import MultipleErrors, PrintableError
 from .parse_tree import *
 from .parser_utils import *
 from .tokenizer import TokenType
-from .language import OBJECT_HOOKS, OBJECT_CONTENT_HOOKS, VALUE_HOOKS, Template, UI
+from .language import OBJECT_CONTENT_HOOKS, VALUE_HOOKS, Template, UI
 
 
 def parse(tokens) -> T.Tuple[UI, T.Optional[MultipleErrors], T.List[PrintableError]]:

tests/sample_errors/assign_inline_menu.blp

@@ -1,5 +0,0 @@
-using Gtk 4.0;
-
-Button {
-  label: menu {};
-}

tests/sample_errors/assign_inline_menu.err

@@ -1 +0,0 @@
-4,3,15,Cannot assign Gio.MenuModel to string

tests/sample_errors/assign_menu.blp

@@ -0,0 +1,7 @@
+using Gtk 4.0;
+
+Button {
+  label: my_menu;
+}
+
+menu my_menu {}

tests/sample_errors/assign_menu.err

@@ -0,0 +1 @@
+4,10,7,Cannot assign Gio.MenuModel to string

tests/sample_errors/menu_errors.blp

@@ -0,0 +1,5 @@
+using Gtk 4.0;
+
+menu {
+  label: "hi";
+}

tests/sample_errors/menu_errors.err

@@ -0,0 +1,2 @@
+3,1,4,Menu requires an ID
+4,3,12,Menu root may not have attributes

tests/samples/inline_menu.blp

@@ -1,5 +0,0 @@
-using Gtk 4.0;
-
-MenuButton {
-  menu-model: menu primary_menu {};
-}

tests/samples/inline_menu.ui

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<interface>
-  <requires lib="gtk" version="4.0"/>
-  <object class="GtkMenuButton">
-    <property name="menu-model">
-      <menu id="primary_menu"></menu>
-    </property>
-  </object>
-</interface>

tests/samples/menu.blp

@@ -1,13 +1,12 @@
 using Gtk 4.0;
 
-menu {
-  label: _("menu label");
-  test-custom-attribute: 3.1415;
+menu my_menu {
+  section {
+    label: "test section";
+  }
 
   submenu {
-    section {
-      label: "test section";
-    }
+    label: "test submenu";
 
     item {
       label: "test item";

tests/samples/menu.ui

@@ -1,13 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <interface>
   <requires lib="gtk" version="4.0"/>
-  <menu>
-    <attribute name="label" translatable="true">menu label</attribute>
-    <attribute name="test-custom-attribute">3.1415</attribute>
+  <menu id="my_menu">
+    <section>
+      <attribute name="label">test section</attribute>
+    </section>
     <submenu>
-      <section>
-        <attribute name="label">test section</attribute>
-      </section>
+      <attribute name="label">test submenu</attribute>
       <item>
         <attribute name="label">test item</attribute>
       </item>
@@ -25,4 +24,4 @@
       </item>
     </submenu>
   </menu>
-</interface>
+</interface>

tests/samples/menu_dec.blp

@@ -1,13 +1,12 @@
 using Gtk 4.0;
 
-menu {
-  label: _("menu label");
-  test-custom-attribute: "3.1415";
+menu my_menu {
+  section {
+    label: "test section";
+  }
 
   submenu {
-    section {
-      label: "test section";
-    }
+    label: "test submenu";
 
     item {
       label: "test item";

tests/test_samples.py

@@ -124,7 +124,6 @@ class TestSamples(unittest.TestCase):
         self.assert_sample("file_filter")
         self.assert_sample("flags")
         self.assert_sample("id_prop")
-        self.assert_sample("inline_menu")
         self.assert_sample("layout")
         self.assert_sample("menu")
         self.assert_sample("object_prop")
@@ -147,7 +146,7 @@ class TestSamples(unittest.TestCase):
         self.assert_sample_error("a11y_prop_dne")
         self.assert_sample_error("a11y_prop_obj_dne")
         self.assert_sample_error("a11y_prop_type")
-        self.assert_sample_error("assign_inline_menu")
+        self.assert_sample_error("assign_menu")
         self.assert_sample_error("action_widget_float_response")
         self.assert_sample_error("action_widget_have_no_id")
         self.assert_sample_error("action_widget_multiple_default")
@@ -165,6 +164,7 @@ class TestSamples(unittest.TestCase):
         self.assert_sample_error("filters_in_non_file_filter")
         self.assert_sample_error("invalid_bool")
         self.assert_sample_error("layout_in_non_widget")
+        self.assert_sample_error("menu_errors")
         self.assert_sample_error("ns_not_imported")
         self.assert_sample_error("not_a_class")
         self.assert_sample_error("object_dne")