Siklos/blueprint-compiler
1
0
Fork 0
mirror of https://gitlab.gnome.org/jwestman/blueprint-compiler.git synced 2025-05-04 15:59:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove PropertyBinding rule, just use Binding

Browse source
This commit is contained in:
James Westman 2023-05-22 21:26:07 -05:00
parent abc4e5de65
commit 0a4b5d07a1
16 changed files with 100 additions and 179 deletions
Download patch file Download diff file Expand all files Collapse all files

1
blueprintcompiler/language/__init__.py
View file

@ -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 (

58
blueprintcompiler/language/binding.py
View file

@ -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

1
blueprintcompiler/language/contexts.py
View file

@ -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

6
blueprintcompiler/language/expression.py
View file

@ -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=[

9
blueprintcompiler/language/gobject_property.py
View file

@ -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
@ -51,7 +48,7 @@ class Property(AstNode):
@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
):

145
blueprintcompiler/language/property_binding.py
View file

@ -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")],
)

8
blueprintcompiler/language/values.py
View file

@ -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}"
)

24
blueprintcompiler/outputs/xml/__init__.py
View file

@ -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)

5
tests/sample_errors/binding_flags.blp Normal file
View file

@ -0,0 +1,5 @@
using Gtk 4.0;
Label {
label: bind $my_closure() as <Label> bidirectional;
}

1
tests/sample_errors/binding_flags.err Normal file
View file

@ -0,0 +1 @@
4,40,13,Only bindings with a single lookup can have flags

5
tests/sample_errors/binding_object_not_found.blp Normal file
View file

@ -0,0 +1,5 @@
using Gtk 4.0;
Label {
label: bind something.other;
}

1
tests/sample_errors/binding_object_not_found.err Normal file
View file

@ -0,0 +1 @@
4,15,9,Could not find object with ID something

5
tests/sample_errors/warn_old_bind.blp
View file

@ -1,9 +1,8 @@
using Gtk 4.0;
Box {
visible: bind box2.visible inverted;
orientation: bind box2.orientation;
spacing: bind box2.spacing no-sync-create;
visible: bind-property box2.visible inverted;
orientation: bind-property box2.orientation;
}
Box box2 {

4
tests/sample_errors/warn_old_bind.err
View file

@ -1,2 +1,2 @@
4,12,4,Use 'bind-property', introduced in blueprint 0.8.0, to use binding flags
6,12,4,Use 'bind-property', introduced in blueprint 0.8.0, to use binding flags
4,12,13,'bind-property' is no longer needed. Use 'bind' instead. (blueprint 0.8.2)
5,16,13,'bind-property' is no longer needed. Use 'bind' instead. (blueprint 0.8.2)

4
tests/samples/property_binding.blp
View file

@ -1,9 +1,9 @@
using Gtk 4.0;
Box {
visible: bind-property box2.visible inverted;
visible: bind box2.visible inverted;
orientation: bind box2.orientation;
spacing: bind-property box2.spacing no-sync-create;
spacing: bind box2.spacing no-sync-create;
}
Box box2 {

2
tests/samples/template_bind_property.blp
View file

@ -1,5 +1,5 @@
using Gtk 4.0;
template $MyTemplate {
object: bind-property template.object2;
object: bind template.object2;
}