Merge branch 'variant-literal' into 'main'

Draft: Syntax for variants

See merge request jwestman/blueprint-compiler!224

blueprintcompiler/language/__init__.py

@@ -52,6 +52,7 @@ from .values import (
     Translated,
     TypeLiteral,
     Value,
+    VariantValue,
 )
 
 OBJECT_CONTENT_HOOKS.children = [

blueprintcompiler/language/gobject_property.py

@@ -22,12 +22,14 @@ from .binding import Binding
 from .common import *
 from .contexts import ValueTypeCtx
 from .gtkbuilder_template import Template
-from .values import ArrayValue, ObjectValue, Value
+from .values import ArrayValue, ObjectValue, Value, VariantValue
 
 
 class Property(AstNode):
     grammar = Statement(
-        UseIdent("name"), ":", AnyOf(Binding, ObjectValue, Value, ArrayValue)
+        UseIdent("name"),
+        ":",
+        AnyOf(Binding, VariantValue, ObjectValue, Value, ArrayValue),
     )
 
     @property
@@ -35,7 +37,7 @@ class Property(AstNode):
         return self.tokens["name"]
 
     @property
-    def value(self) -> T.Union[Binding, ObjectValue, Value, ArrayValue]:
+    def value(self) -> T.Union[Binding, VariantValue, ObjectValue, Value, ArrayValue]:
         return self.children[0]
 
     @property

blueprintcompiler/language/gtk_menu.py

@@ -19,7 +19,7 @@
 
 import typing as T
 
-from blueprintcompiler.language.values import StringValue
+from blueprintcompiler.language.values import StringValue, VariantValue
 
 from .common import *
 from .contexts import ValueTypeCtx
@@ -98,8 +98,12 @@ class MenuAttribute(AstNode):
         return self.tokens["name"]
 
     @property
-    def value(self) -> StringValue:
-        return self.children[StringValue][0]
+    def value(self) -> T.Union[StringValue, VariantValue]:
+        if len(self.children[StringValue]) > 0:
+            return self.children[StringValue][0]
+        elif len(self.children[VariantValue]) > 0:
+            return self.children[VariantValue][0]
+        raise CompilerBugError()
 
     @property
     def document_symbol(self) -> DocumentSymbol:
@@ -133,7 +137,10 @@ menu_attribute = Group(
     [
         UseIdent("name"),
         ":",
-        Err(StringValue, "Expected string or translated string"),
+        Err(
+            AnyOf(StringValue, VariantValue),
+            "Expected string, translated string, or variant",
+        ),
         Match(";").expected(),
     ],
 )

blueprintcompiler/language/values.py

@@ -19,6 +19,8 @@
 
 import typing as T
 
+import gi
+
 from blueprintcompiler.gir import ArrayType
 from blueprintcompiler.lsp_utils import SemanticToken
 
@@ -26,6 +28,10 @@ from .common import *
 from .contexts import ScopeCtx, ValueTypeCtx
 from .gobject_object import Object
 from .types import TypeName
+from .variant import VarContent
+
+gi.require_version("GLib", "2.0")
+from gi.repository import GLib
 
 
 class Translated(AstNode):
@@ -372,6 +378,67 @@ class IdentLiteral(AstNode):
             return None
 
 
+class VariantValue(AstNode):
+    grammar = [
+        "variant",
+        "<",
+        UseQuoted("type"),
+        ">",
+        "(",
+        Err(VarContent, "Invalid variant content!"),
+        ")",
+    ]
+
+    @property
+    def var_type(self) -> str:
+        return self.tokens["type"]
+
+    @property
+    def var_value(self) -> str:
+        return self.children[0].content
+
+    @validate()
+    def validate_for_type(self) -> None:
+        expected_type = self.context[ValueTypeCtx].value_type
+        if expected_type is None:
+            pass
+        elif (
+            isinstance(expected_type, gir.IntType)
+            or isinstance(expected_type, gir.UIntType)
+            or isinstance(expected_type, gir.FloatType)
+            or isinstance(expected_type, gir.FloatType)
+        ):
+            raise CompileError(f"Cannot convert variant to number")
+        elif isinstance(expected_type, gir.StringType):
+            raise CompileError("Cannot convert variant to string")
+        elif (
+            isinstance(expected_type, gir.Boxed)
+            and expected_type.full_name == "GLib.Variant"
+        ):
+            pass
+        else:
+            raise CompileError(f"Cannot convert variant into {expected_type.full_name}")
+        pass
+
+    @validate("type")
+    def validate_type(self):
+        if not GLib.VariantType.string_is_valid(self.var_type):
+            raise CompileError(f"`{self.var_type}` is not a valid variant type")
+
+    @validate()
+    def validate_content(self):
+        if not GLib.VariantType.string_is_valid(self.var_type):
+            return
+
+        try:
+            var_ty = GLib.VariantType.new(self.var_type)
+            var_val = GLib.Variant.parse(var_ty, self.var_value)
+        except GLib.GError as error:
+            raise CompileError(f"Variant did not match specified type: {error}")
+
+        pass
+
+
 class Literal(AstNode):
     grammar = AnyOf(
         TypeLiteral,

blueprintcompiler/language/variant.py

@@ -0,0 +1,122 @@
+import typing as T
+
+from blueprintcompiler.gir import ArrayType
+from blueprintcompiler.lsp_utils import SemanticToken
+
+from .common import *
+from .contexts import ScopeCtx, ValueTypeCtx
+from .gobject_object import Object
+from .types import TypeName
+
+VAR_CONTENT_HOOKS: list[T.Any] = []
+
+
+class VarContent(AstNode):
+    grammar = AnyOf(*VAR_CONTENT_HOOKS)
+
+    @property
+    def content(self) -> str:
+        return self.children[0].content
+
+
+class VarContentBool(AstNode):
+    grammar = AnyOf(
+        [Keyword("true"), UseLiteral("value", True)],
+        [Keyword("false"), UseLiteral("value", False)],
+    )
+
+    @property
+    def content(self) -> str:
+        if self.tokens["value"]:
+            return "true"
+        else:
+            return "false"
+
+
+class VarContentString(AstNode):
+    grammar = UseQuoted("value")
+
+    @property
+    def content(self) -> str:
+        return utils.escape_quote(self.tokens["value"])
+
+
+class VarContentNumber(AstNode):
+    grammar = UseNumberText("value")
+
+    @property
+    def content(self) -> str:
+        return self.tokens["value"]
+
+
+class VarContentTuple(AstNode):
+    grammar = ["(", Delimited(VarContent, ","), ")"]
+
+    @property
+    def content(self) -> str:
+        inner = ", ".join(child.content for child in self.children)
+        return f"({inner})"
+
+
+class VarContentArray(AstNode):
+    grammar = ["[", Delimited(VarContent, ","), "]"]
+
+    @property
+    def content(self) -> str:
+        inner = ", ".join(child.content for child in self.children)
+        return f"[{inner}]"
+
+
+class VarContentDictEntry(AstNode):
+    grammar = ["{", VarContent, ",", VarContent, "}"]
+
+    @property
+    def content(self):
+        return f"{{{self.children[0].content}, {self.children[1].content}}}"
+
+
+class VarContentDict(AstNode):
+    grammar = ["{", Delimited([VarContent, ":", VarContent], ","), "}"]
+
+    @property
+    def content(self) -> str:
+        inner = ", ".join(
+            f"{key.content}: {value.content}"
+            for (key, value) in utils.iter_batched(self.children, 2, strict=True)
+        )
+        return f"{{{inner}}}"
+
+
+class VarContentVariant(AstNode):
+    grammar = ["<", VarContent, ">"]
+
+    @property
+    def content(self) -> str:
+        return f"<{self.children[0].content}>"
+
+
+class VarContentMaybe(AstNode):
+    grammar = AnyOf(
+        [Keyword("just"), VarContent],
+        [Keyword("nothing")],
+    )
+
+    @property
+    def content(self) -> str:
+        if self.children[0] is not None:
+            return f"just {self.children[0].content}"
+        else:
+            return "nothing"
+
+
+VarContent.grammar.children = [
+    VarContentString,
+    VarContentNumber,
+    VarContentBool,
+    VarContentMaybe,
+    VarContentTuple,
+    VarContentDict,
+    VarContentDictEntry,
+    VarContentArray,
+    VarContentVariant,
+]