Merge branch 'main' of https://gitlab.gnome.org/jwestman/blueprint-compiler into formatter

blueprintcompiler/errors.py

@@ -128,6 +128,10 @@ class CompileWarning(CompileError):
     color = Colors.YELLOW
 
 
+class DeprecatedWarning(CompileWarning):
+    pass
+
+
 class UpgradeWarning(CompileWarning):
     category = "upgrade"
     color = Colors.PURPLE

blueprintcompiler/gir.py

@@ -136,6 +136,14 @@ class GirType:
     def incomplete(self) -> bool:
         return False
 
+    @property
+    def deprecated(self) -> bool:
+        return False
+
+    @property
+    def deprecated_doc(self) -> T.Optional[str]:
+        return None
+
 
 class ExternType(GirType):
     def __init__(self, name: str) -> None:
@@ -330,6 +338,13 @@ class GirNode:
     def type(self) -> GirType:
         raise NotImplementedError()
 
+    @property
+    def deprecated_doc(self) -> T.Optional[str]:
+        try:
+            return self.xml.get_elements("doc-deprecated")[0].cdata.strip()
+        except:
+            return None
+
 
 class Property(GirNode):
     xml_tag = "property"
@@ -365,6 +380,10 @@ class Property(GirNode):
         else:
             return None
 
+    @property
+    def deprecated(self) -> bool:
+        return self.tl.PROP_DEPRECATED == 1
+
 
 class Argument(GirNode):
     def __init__(self, container: GirNode, tl: typelib.Typelib) -> None:
@@ -427,6 +446,10 @@ class Signal(GirNode):
         else:
             return None
 
+    @property
+    def deprecated(self) -> bool:
+        return self.tl.SIGNAL_DEPRECATED == 1
+
 
 class Interface(GirNode, GirType):
     xml_tag = "interface"
@@ -488,6 +511,10 @@ class Interface(GirNode, GirType):
         else:
             return None
 
+    @property
+    def deprecated(self) -> bool:
+        return self.tl.INTERFACE_DEPRECATED == 1
+
 
 class Class(GirNode, GirType):
     xml_tag = "class"
@@ -609,6 +636,10 @@ class Class(GirNode, GirType):
         else:
             return None
 
+    @property
+    def deprecated(self) -> bool:
+        return self.tl.OBJ_DEPRECATED == 1
+
 
 class TemplateType(GirType):
     def __init__(self, name: str, parent: T.Optional[GirType]):
@@ -722,6 +753,10 @@ class Enumeration(GirNode, GirType):
         else:
             return None
 
+    @property
+    def deprecated(self) -> bool:
+        return self.tl.ENUM_DEPRECATED == 1
+
 
 class Boxed(GirNode, GirType):
     xml_tag = "glib:boxed"
@@ -743,6 +778,10 @@ class Boxed(GirNode, GirType):
         else:
             return None
 
+    @property
+    def deprecated(self) -> bool:
+        return self.tl.STRUCT_DEPRECATED == 1
+
 
 class Bitfield(Enumeration):
     xml_tag = "bitfield"

blueprintcompiler/language/__init__.py

@@ -38,7 +38,6 @@ from .gtk_styles import ExtStyles
 from .gtkbuilder_child import Child, ChildExtension, ChildInternal, ChildType
 from .gtkbuilder_template import Template
 from .imports import GtkDirective, Import
-from .property_binding import PropertyBinding
 from .types import ClassName
 from .ui import UI
 from .values import (

blueprintcompiler/language/binding.py

@@ -23,16 +23,57 @@ from .common import *
 from .expression import Expression, LiteralExpr, LookupOp
 
 
+class BindingFlag(AstNode):
+    grammar = [
+        AnyOf(
+            UseExact("flag", "inverted"),
+            UseExact("flag", "bidirectional"),
+            UseExact("flag", "no-sync-create"),
+            UseExact("flag", "sync-create"),
+        )
+    ]
+
+    @property
+    def flag(self) -> str:
+        return self.tokens["flag"]
+
+    @validate()
+    def sync_create(self):
+        if self.flag == "sync-create":
+            raise UpgradeWarning(
+                "'sync-create' is now the default. Use 'no-sync-create' if this is not wanted.",
+                actions=[CodeAction("remove 'sync-create'", "")],
+            )
+
+    @validate()
+    def unique(self):
+        self.validate_unique_in_parent(
+            f"Duplicate flag '{self.flag}'", lambda x: x.flag == self.flag
+        )
+
+    @validate()
+    def flags_only_if_simple(self):
+        if self.parent.simple_binding is None:
+            raise CompileError(
+                "Only bindings with a single lookup can have flags",
+            )
+
+
 class Binding(AstNode):
     grammar = [
-        Keyword("bind"),
+        AnyOf(Keyword("bind"), UseExact("bind", "bind-property")),
         Expression,
+        ZeroOrMore(BindingFlag),
     ]
 
     @property
     def expression(self) -> Expression:
         return self.children[Expression][0]
 
+    @property
+    def flags(self) -> T.List[BindingFlag]:
+        return self.children[BindingFlag]
+
     @property
     def simple_binding(self) -> T.Optional["SimpleBinding"]:
         if isinstance(self.expression.last, LookupOp):
@@ -40,14 +81,29 @@ class Binding(AstNode):
                 from .values import IdentLiteral
 
                 if isinstance(self.expression.last.lhs.literal.value, IdentLiteral):
+                    flags = [x.flag for x in self.flags]
                     return SimpleBinding(
                         self.expression.last.lhs.literal.value.ident,
                         self.expression.last.property_name,
+                        no_sync_create="no-sync-create" in flags,
+                        bidirectional="bidirectional" in flags,
+                        inverted="inverted" in flags,
                     )
         return None
 
+    @validate("bind")
+    def bind_property(self):
+        if self.tokens["bind"] == "bind-property":
+            raise UpgradeWarning(
+                "'bind-property' is no longer needed. Use 'bind' instead. (blueprint 0.8.2)",
+                actions=[CodeAction("use 'bind'", "bind")],
+            )
+
 
 @dataclass
 class SimpleBinding:
     source: str
     property_name: str
+    no_sync_create: bool = False
+    bidirectional: bool = False
+    inverted: bool = False

blueprintcompiler/language/common.py

@@ -33,6 +33,7 @@ from ..errors import (
     CodeAction,
     CompileError,
     CompileWarning,
+    DeprecatedWarning,
     MultipleErrors,
     UpgradeWarning,
 )

blueprintcompiler/language/contexts.py

@@ -30,6 +30,7 @@ from .gtkbuilder_template import Template
 class ValueTypeCtx:
     value_type: T.Optional[GirType]
     allow_null: bool = False
+    must_infer_type: bool = False
 
 
 @dataclass

blueprintcompiler/language/expression.py

@@ -114,7 +114,7 @@ class LookupOp(InfixExpr):
 
     @context(ValueTypeCtx)
     def value_type(self) -> ValueTypeCtx:
-        return ValueTypeCtx(None)
+        return ValueTypeCtx(None, must_infer_type=True)
 
     @property
     def property_name(self) -> str:
@@ -133,6 +133,10 @@ class LookupOp(InfixExpr):
     @validate("property")
     def property_exists(self):
         if self.lhs.type is None:
+            # Literal values throw their own errors if the type isn't known
+            if isinstance(self.lhs, LiteralExpr):
+                return
+
             raise CompileError(
                 f"Could not determine the type of the preceding expression",
                 hints=[

blueprintcompiler/language/gobject_property.py

@@ -22,21 +22,18 @@ from .binding import Binding
 from .common import *
 from .contexts import ValueTypeCtx
 from .gtkbuilder_template import Template
-from .property_binding import PropertyBinding
 from .values import ObjectValue, Value
 
 
 class Property(AstNode):
-    grammar = Statement(
-        UseIdent("name"), ":", AnyOf(PropertyBinding, Binding, ObjectValue, Value)
-    )
+    grammar = Statement(UseIdent("name"), ":", AnyOf(Binding, ObjectValue, Value))
 
     @property
     def name(self) -> str:
         return self.tokens["name"]
 
     @property
-    def value(self) -> T.Union[PropertyBinding, Binding, ObjectValue, Value]:
+    def value(self) -> T.Union[Binding, ObjectValue, Value]:
         return self.children[0]
 
     @property
@@ -44,14 +41,16 @@ class Property(AstNode):
         return self.parent.parent.gir_class
 
     @property
-    def gir_property(self):
+    def gir_property(self) -> T.Optional[gir.Property]:
         if self.gir_class is not None and not isinstance(self.gir_class, ExternType):
             return self.gir_class.properties.get(self.tokens["name"])
+        else:
+            return None
 
     @validate()
     def binding_valid(self):
         if (
-            (isinstance(self.value, PropertyBinding) or isinstance(self.value, Binding))
+            isinstance(self.value, Binding)
             and self.gir_property is not None
             and self.gir_property.construct_only
         ):
@@ -94,6 +93,17 @@ class Property(AstNode):
             check=lambda child: child.tokens["name"] == self.tokens["name"],
         )
 
+    @validate("name")
+    def deprecated(self) -> None:
+        if self.gir_property is not None and self.gir_property.deprecated:
+            hints = []
+            if self.gir_property.deprecated_doc:
+                hints.append(self.gir_property.deprecated_doc)
+            raise DeprecatedWarning(
+                f"{self.gir_property.signature} is deprecated",
+                hints=hints,
+            )
+
     @docs("name")
     def property_docs(self):
         if self.gir_property is not None:

blueprintcompiler/language/gobject_signal.py

@@ -95,9 +95,11 @@ class Signal(AstNode):
         return any(x.flag == "after" for x in self.flags)
 
     @property
-    def gir_signal(self):
+    def gir_signal(self) -> T.Optional[gir.Signal]:
         if self.gir_class is not None and not isinstance(self.gir_class, ExternType):
             return self.gir_class.signals.get(self.tokens["name"])
+        else:
+            return None
 
     @property
     def gir_class(self):
@@ -134,6 +136,17 @@ class Signal(AstNode):
         if self.context[ScopeCtx].objects.get(object_id) is None:
             raise CompileError(f"Could not find object with ID '{object_id}'")
 
+    @validate("name")
+    def deprecated(self) -> None:
+        if self.gir_signal is not None and self.gir_signal.deprecated:
+            hints = []
+            if self.gir_signal.deprecated_doc:
+                hints.append(self.gir_signal.deprecated_doc)
+            raise DeprecatedWarning(
+                f"{self.gir_signal.signature} is deprecated",
+                hints=hints,
+            )
+
     @docs("name")
     def signal_docs(self):
         if self.gir_signal is not None:

blueprintcompiler/language/property_binding.py

@@ -1,145 +0,0 @@
-# property_binding.py
-#
-# Copyright 2023 James Westman <james@jwestman.net>
-#
-# This file is free software; you can redistribute it and/or modify it
-# under the terms of the GNU Lesser General Public License as
-# published by the Free Software Foundation; either version 3 of the
-# License, or (at your option) any later version.
-#
-# This file is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-# SPDX-License-Identifier: LGPL-3.0-or-later
-
-from .common import *
-from .contexts import ScopeCtx
-from .gobject_object import Object
-
-
-class PropertyBindingFlag(AstNode):
-    grammar = [
-        AnyOf(
-            UseExact("flag", "inverted"),
-            UseExact("flag", "bidirectional"),
-            UseExact("flag", "no-sync-create"),
-            UseExact("flag", "sync-create"),
-        )
-    ]
-
-    @property
-    def flag(self) -> str:
-        return self.tokens["flag"]
-
-    @validate()
-    def sync_create(self):
-        if self.flag == "sync-create":
-            raise UpgradeWarning(
-                "'sync-create' is now the default. Use 'no-sync-create' if this is not wanted.",
-                actions=[CodeAction("remove 'sync-create'", "")],
-            )
-
-    @validate()
-    def unique(self):
-        self.validate_unique_in_parent(
-            f"Duplicate flag '{self.flag}'", lambda x: x.flag == self.flag
-        )
-
-
-class PropertyBinding(AstNode):
-    grammar = AnyOf(
-        [
-            Keyword("bind-property"),
-            UseIdent("source"),
-            ".",
-            UseIdent("property"),
-            ZeroOrMore(PropertyBindingFlag),
-        ],
-        [
-            Keyword("bind"),
-            UseIdent("source"),
-            ".",
-            UseIdent("property"),
-            PropertyBindingFlag,
-            ZeroOrMore(PropertyBindingFlag),
-        ],
-    )
-
-    @property
-    def source(self) -> str:
-        return self.tokens["source"]
-
-    @property
-    def source_obj(self) -> T.Optional[Object]:
-        if self.root.is_legacy_template(self.source):
-            return self.root.template
-        return self.context[ScopeCtx].objects.get(self.source)
-
-    @property
-    def property_name(self) -> str:
-        return self.tokens["property"]
-
-    @property
-    def flags(self) -> T.List[PropertyBindingFlag]:
-        return self.children[PropertyBindingFlag]
-
-    @property
-    def inverted(self) -> bool:
-        return any([f.flag == "inverted" for f in self.flags])
-
-    @property
-    def bidirectional(self) -> bool:
-        return any([f.flag == "bidirectional" for f in self.flags])
-
-    @property
-    def no_sync_create(self) -> bool:
-        return any([f.flag == "no-sync-create" for f in self.flags])
-
-    @validate("source")
-    def source_object_exists(self) -> None:
-        if self.source_obj is None:
-            raise CompileError(
-                f"Could not find object with ID {self.source}",
-                did_you_mean=(self.source, self.context[ScopeCtx].objects.keys()),
-            )
-
-    @validate("property")
-    def property_exists(self) -> None:
-        if self.source_obj is None:
-            return
-
-        gir_class = self.source_obj.gir_class
-
-        if gir_class is None or gir_class.incomplete:
-            # Objects that we have no gir data on should not be validated
-            # This happens for classes defined by the app itself
-            return
-
-        if (
-            isinstance(gir_class, gir.Class)
-            and gir_class.properties.get(self.property_name) is None
-        ):
-            raise CompileError(
-                f"{gir_class.full_name} does not have a property called {self.property_name}"
-            )
-
-    @validate("bind")
-    def old_bind(self):
-        if self.tokens["bind"]:
-            raise UpgradeWarning(
-                "Use 'bind-property', introduced in blueprint 0.8.0, to use binding flags",
-                actions=[CodeAction("Use 'bind-property'", "bind-property")],
-            )
-
-    @validate("source")
-    def legacy_template(self):
-        if self.root.is_legacy_template(self.source):
-            raise UpgradeWarning(
-                "Use 'template' instead of the class name (introduced in 0.8.0)",
-                actions=[CodeAction("Use 'template'", "template")],
-            )

blueprintcompiler/language/types.py

@@ -57,6 +57,17 @@ class TypeName(AstNode):
         if not self.tokens["extern"]:
             self.root.gir.validate_ns(self.tokens["namespace"])
 
+    @validate()
+    def deprecated(self) -> None:
+        if self.gir_type and self.gir_type.deprecated:
+            hints = []
+            if self.gir_type.deprecated_doc:
+                hints.append(self.gir_type.deprecated_doc)
+            raise DeprecatedWarning(
+                f"{self.gir_type.full_name} is deprecated",
+                hints=hints,
+            )
+
     @property
     def gir_ns(self):
         if not self.tokens["extern"]:

blueprintcompiler/language/values.py

@@ -291,7 +291,7 @@ class IdentLiteral(AstNode):
                 actions=[CodeAction("Use 'template'", "template")],
             )
 
-        elif expected_type is not None:
+        elif expected_type is not None or self.context[ValueTypeCtx].must_infer_type:
             object = self.context[ScopeCtx].objects.get(self.ident)
             if object is None:
                 if self.ident == "null":
@@ -305,7 +305,11 @@ class IdentLiteral(AstNode):
                             self.context[ScopeCtx].objects.keys(),
                         ),
                     )
-            elif object.gir_class and not object.gir_class.assignable_to(expected_type):
+            elif (
+                expected_type is not None
+                and object.gir_class is not None
+                and not object.gir_class.assignable_to(expected_type)
+            ):
                 raise CompileError(
                     f"Cannot assign {object.gir_class.full_name} to {expected_type.full_name}"
                 )

blueprintcompiler/lsp.py

@@ -391,6 +391,9 @@ class LanguageServer:
             else DiagnosticSeverity.Error,
         }
 
+        if isinstance(err, DeprecationWarning):
+            result["tags"] = [DiagnosticTag.Deprecated]
+
         if len(err.references) > 0:
             result["relatedInformation"] = [
                 {

blueprintcompiler/lsp_utils.py

@@ -119,6 +119,11 @@ class DiagnosticSeverity(enum.IntEnum):
     Hint = 4
 
 
+class DiagnosticTag(enum.IntEnum):
+    Unnecessary = 1
+    Deprecated = 2
+
+
 @dataclass
 class SemanticToken:
     start: int

blueprintcompiler/outputs/xml/__init__.py

@@ -116,27 +116,21 @@ class XmlOutput(OutputFormat):
             if simple := value.simple_binding:
                 props["bind-source"] = self._object_id(value, simple.source)
                 props["bind-property"] = simple.property_name
-                props["bind-flags"] = "sync-create"
+                flags = []
+                if not simple.no_sync_create:
+                    flags.append("sync-create")
+                if simple.inverted:
+                    flags.append("invert-boolean")
+                if simple.bidirectional:
+                    flags.append("bidirectional")
+                props["bind-flags"] = "|".join(flags) or None
+
                 xml.put_self_closing("property", **props)
             else:
                 xml.start_tag("binding", **props)
                 self._emit_expression(value.expression, xml)
                 xml.end_tag()
 
-        elif isinstance(value, PropertyBinding):
-            bind_flags = []
-            if not value.no_sync_create:
-                bind_flags.append("sync-create")
-            if value.inverted:
-                bind_flags.append("invert-boolean")
-            if value.bidirectional:
-                bind_flags.append("bidirectional")
-
-            props["bind-source"] = self._object_id(value, value.source)
-            props["bind-property"] = value.property_name
-            props["bind-flags"] = "|".join(bind_flags) or None
-            xml.put_self_closing("property", **props)
-
         elif isinstance(value, ObjectValue):
             xml.start_tag("property", **props)
             self._emit_object(value.object, xml)
@@ -199,7 +193,10 @@ class XmlOutput(OutputFormat):
         elif isinstance(value, TypeLiteral):
             xml.put_text(value.type_name.glib_type_name)
         else:
-            xml.put_text(value.value)
+            if isinstance(value.value, float) and value.value == int(value.value):
+                xml.put_text(int(value.value))
+            else:
+                xml.put_text(value.value)
 
     def _emit_value(self, value: Value, xml: XmlEmitter):
         if isinstance(value.child, Literal):

blueprintcompiler/parse_tree.py

@@ -520,8 +520,6 @@ class UseNumber(ParseNode):
             return False
 
         number = token.get_number()
-        if number % 1.0 == 0:
-            number = int(number)
         ctx.set_group_val(self.key, number, token)
         return True
 

blueprintcompiler/tokenizer.py

@@ -70,8 +70,10 @@ class Token:
         try:
             if string.startswith("0x"):
                 return int(string, 16)
-            else:
+            elif "." in string:
                 return float(string)
+            else:
+                return int(string)
         except:
             raise CompileError(
                 f"{str(self)} is not a valid number literal", self.start, self.end

blueprintcompiler/typelib.py

@@ -150,11 +150,15 @@ class Typelib:
 
     BLOB_NAME = Field(0x4, "string")
 
+    STRUCT_DEPRECATED = Field(0x2, "u16", 0, 1)
+
+    ENUM_DEPRECATED = Field(0x2, "u16", 0, 1)
     ENUM_GTYPE_NAME = Field(0x8, "string")
     ENUM_N_VALUES = Field(0x10, "u16")
     ENUM_N_METHODS = Field(0x12, "u16")
     ENUM_VALUES = Field(0x18, "offset")
 
+    INTERFACE_DEPRECATED = Field(0x2, "u16", 0, 1)
     INTERFACE_GTYPE_NAME = Field(0x8, "string")
     INTERFACE_N_PREREQUISITES = Field(0x12, "u16")
     INTERFACE_N_PROPERTIES = Field(0x14, "u16")