diff --git a/blueprintcompiler/annotations.py b/blueprintcompiler/annotations.py deleted file mode 100644 index c40de13..0000000 --- a/blueprintcompiler/annotations.py +++ /dev/null @@ -1,191 +0,0 @@ -# annotations.py -# -# Copyright 2024 James Westman -# -# 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 . -# -# SPDX-License-Identifier: LGPL-3.0-or-later - -# Extra information about types in common libraries that's used for things like completions. - -import typing as T -from dataclasses import dataclass - -from . import gir - - -@dataclass -class Annotation: - translatable_properties: T.List[str] - - -def is_property_translated(property: gir.Property): - ns = property.get_containing(gir.Namespace) - ns_name = ns.name + "-" + ns.version - if annotation := _ANNOTATIONS.get(ns_name): - assert property.container is not None - return ( - property.container.name + ":" + property.name - in annotation.translatable_properties - ) - else: - return False - - -_ANNOTATIONS = { - "Gtk-4.0": Annotation( - translatable_properties=[ - "AboutDialog:comments", - "AboutDialog:translator-credits", - "AboutDialog:website-label", - "AlertDialog:detail", - "AlertDialog:message", - "AppChooserButton:heading", - "AppChooserDialog:heading", - "AppChooserWidget:default-text", - "AssistantPage:title", - "Button:label", - "CellRendererText:markup", - "CellRendererText:placeholder-text", - "CellRendererText:text", - "CheckButton:label", - "ColorButton:title", - "ColorDialog:title", - "ColumnViewColumn:title", - "ColumnViewRow:accessible-description", - "ColumnViewRow:accessible-label", - "Entry:placeholder-text", - "Entry:primary-icon-tooltip-markup", - "Entry:primary-icon-tooltip-text", - "Entry:secondary-icon-tooltip-markup", - "Entry:secondary-icon-tooltip-text", - "EntryBuffer:text", - "Expander:label", - "FileChooserNative:accept-label", - "FileChooserNative:cancel-label", - "FileChooserWidget:subtitle", - "FileDialog:accept-label", - "FileDialog:title", - "FileDialog:initial-name", - "FileFilter:name", - "FontButton:title", - "FontDialog:title", - "Frame:label", - "Inscription:markup", - "Inscription:text", - "Label:label", - "ListItem:accessible-description", - "ListItem:accessible-label", - "LockButton:text-lock", - "LockButton:text-unlock", - "LockButton:tooltip-lock", - "LockButton:tooltip-not-authorized", - "LockButton:tooltip-unlock", - "MenuButton:label", - "MessageDialog:secondary-text", - "MessageDialog:text", - "NativeDialog:title", - "NotebookPage:menu-label", - "NotebookPage:tab-label", - "PasswordEntry:placeholder-text", - "Picture:alternative-text", - "PrintDialog:accept-label", - "PrintDialog:title", - "Printer:name", - "PrintJob:title", - "PrintOperation:custom-tab-label", - "PrintOperation:export-filename", - "PrintOperation:job-name", - "ProgressBar:text", - "SearchEntry:placeholder-text", - "ShortcutLabel:disabled-text", - "ShortcutsGroup:title", - "ShortcutsSection:title", - "ShortcutsShortcut:title", - "ShortcutsShortcut:subtitle", - "StackPage:title", - "Text:placeholder-text", - "TextBuffer:text", - "TreeViewColumn:title", - "Widget:tooltip-markup", - "Widget:tooltip-text", - "Window:title", - "Editable:text", - "FontChooser:preview-text", - ] - ), - "Adw-1": Annotation( - translatable_properties=[ - "AboutDialog:comments", - "AboutDialog:translator-credits", - "AboutWindow:comments", - "AboutWindow:translator-credits", - "ActionRow:subtitle", - "ActionRow:title", - "AlertDialog:body", - "AlertDialog:heading", - "Avatar:text", - "Banner:button-label", - "Banner:title", - "ButtonContent:label", - "Dialog:title", - "ExpanderRow:subtitle", - "MessageDialog:body", - "MessageDialog:heading", - "NavigationPage:title", - "PreferencesGroup:description", - "PreferencesGroup:title", - "PreferencesPage:description", - "PreferencesPage:title", - "PreferencesRow:title", - "SplitButton:dropdown-tooltip", - "SplitButton:label", - "StatusPage:description", - "StatusPage:title", - "TabPage:indicator-tooltip", - "TabPage:keyword", - "TabPage:title", - "Toast:button-label", - "Toast:title", - "ViewStackPage:title", - "ViewSwitcherTitle:subtitle", - "ViewSwitcherTitle:title", - "WindowTitle:subtitle", - "WindowTitle:title", - ] - ), - "Shumate-1.0": Annotation( - translatable_properties=[ - "License:extra-text", - "MapSource:license", - "MapSource:name", - ] - ), - "GtkSource-5": Annotation( - translatable_properties=[ - "CompletionCell:markup", - "CompletionCell:text", - "CompletionSnippets:title", - "CompletionWords:title", - "GutterRendererText:markup", - "GutterRendererText:text", - "SearchSettings:search-text", - "Snippet:description", - "Snippet:name", - "SnippetChunk:tooltip-text", - "StyleScheme:description", - "StyleScheme:name", - ] - ), -} diff --git a/blueprintcompiler/ast_utils.py b/blueprintcompiler/ast_utils.py index 8f742e0..bd5befa 100644 --- a/blueprintcompiler/ast_utils.py +++ b/blueprintcompiler/ast_utils.py @@ -160,11 +160,6 @@ class AstNode: yield e if e.fatal: return - except MultipleErrors as e: - for error in e.errors: - yield error - if error.fatal: - return for child in self.children: yield from child._get_errors() @@ -254,7 +249,14 @@ def validate( if skip_incomplete and self.incomplete: return - def fill_error(e: CompileError): + try: + func(self) + except CompileError as e: + # If the node is only partially complete, then an error must + # have already been reported at the parsing stage + if self.incomplete: + return + if e.range is None: e.range = ( Range.join( @@ -264,26 +266,8 @@ def validate( or self.range ) - try: - func(self) - except CompileError as e: - # If the node is only partially complete, then an error must - # have already been reported at the parsing stage - if self.incomplete: - return - - fill_error(e) - # Re-raise the exception raise e - except MultipleErrors as e: - if self.incomplete: - return - - for error in e.errors: - fill_error(error) - - raise e inner._validator = True return inner diff --git a/blueprintcompiler/completions.py b/blueprintcompiler/completions.py index 5d36739..e05d6ee 100644 --- a/blueprintcompiler/completions.py +++ b/blueprintcompiler/completions.py @@ -17,9 +17,10 @@ # # SPDX-License-Identifier: LGPL-3.0-or-later +import sys import typing as T -from . import annotations, gir, language +from . import gir, language from .ast_utils import AstNode from .completions_utils import * from .language.types import ClassName @@ -30,6 +31,10 @@ from .tokenizer import Token, TokenType Pattern = T.List[T.Tuple[TokenType, T.Optional[str]]] +def debug(*args, **kwargs): + print(*args, file=sys.stderr, **kwargs) + + def _complete( lsp, ast_node: AstNode, tokens: T.List[Token], idx: int, token_idx: int ) -> T.Iterator[Completion]: @@ -134,7 +139,7 @@ def gtk_object_completer(lsp, ast_node, match_variables): matches=new_statement_patterns, ) def property_completer(lsp, ast_node, match_variables): - if ast_node.gir_class and hasattr(ast_node.gir_class, "properties"): + if ast_node.gir_class and not isinstance(ast_node.gir_class, gir.ExternType): for prop_name, prop in ast_node.gir_class.properties.items(): if ( isinstance(prop.type, gir.BoolType) @@ -149,17 +154,11 @@ def property_completer(lsp, ast_node, match_variables): detail=prop.detail, ) elif isinstance(prop.type, gir.StringType): - snippet = ( - f'{prop_name}: _("$0");' - if annotations.is_property_translated(prop) - else f'{prop_name}: "$0";' - ) - yield Completion( prop_name, CompletionItemKind.Property, sort_text=f"0 {prop_name}", - snippet=snippet, + snippet=f'{prop_name}: "$0";', docs=prop.doc, detail=prop.detail, ) @@ -189,7 +188,7 @@ def property_completer(lsp, ast_node, match_variables): @completer( - applies_in=[language.Property, language.A11yProperty], + applies_in=[language.Property, language.BaseAttribute], matches=[[(TokenType.IDENT, None), (TokenType.OP, ":")]], ) def prop_value_completer(lsp, ast_node, match_variables): @@ -213,7 +212,7 @@ def prop_value_completer(lsp, ast_node, match_variables): matches=new_statement_patterns, ) def signal_completer(lsp, ast_node, match_variables): - if ast_node.gir_class and hasattr(ast_node.gir_class, "signals"): + if ast_node.gir_class and not isinstance(ast_node.gir_class, gir.ExternType): for signal_name, signal in ast_node.gir_class.signals.items(): if not isinstance(ast_node.parent, language.Object): name = "on" diff --git a/blueprintcompiler/completions_utils.py b/blueprintcompiler/completions_utils.py index eccf125..03bec0f 100644 --- a/blueprintcompiler/completions_utils.py +++ b/blueprintcompiler/completions_utils.py @@ -31,6 +31,17 @@ new_statement_patterns = [ ] +def applies_to(*ast_types): + """Decorator describing which AST nodes the completer should apply in.""" + + def decorator(func): + for c in ast_types: + c.completers.append(func) + return func + + return decorator + + def completer(applies_in: T.List, matches: T.List = [], applies_in_subclass=None): def decorator(func): def inner(prev_tokens: T.List[Token], ast_node, lsp): diff --git a/blueprintcompiler/formatter.py b/blueprintcompiler/formatter.py index 35da5d2..c003d45 100644 --- a/blueprintcompiler/formatter.py +++ b/blueprintcompiler/formatter.py @@ -20,8 +20,7 @@ import re from enum import Enum -from . import tokenizer -from .errors import CompilerBugError +from . import tokenizer, utils from .tokenizer import TokenType OPENING_TOKENS = ("{", "[") @@ -193,8 +192,8 @@ def format(data, tab_size=2, insert_space=True): commit_current_line(LineType.COMMENT, newlines_before=newlines) - else: # pragma: no cover - raise CompilerBugError() + else: + commit_current_line() elif str_item == "(" and ( re.match(r"^([A-Za-z_\-])+\s*\(", current_line) or watch_parentheses diff --git a/blueprintcompiler/gir.py b/blueprintcompiler/gir.py index 333f4ac..30a5eaa 100644 --- a/blueprintcompiler/gir.py +++ b/blueprintcompiler/gir.py @@ -24,20 +24,8 @@ from functools import cached_property import gi # type: ignore -try: - gi.require_version("GIRepository", "3.0") - from gi.repository import GIRepository # type: ignore - - _repo = GIRepository.Repository() -except ValueError: - # We can remove this once we can bump the minimum dependencies - # to glib 2.80 and pygobject 3.52 - # dependency('glib-2.0', version: '>= 2.80.0') - # dependency('girepository-2.0', version: '>= 2.80.0') - gi.require_version("GIRepository", "2.0") - from gi.repository import GIRepository # type: ignore - - _repo = GIRepository.Repository +gi.require_version("GIRepository", "2.0") +from gi.repository import GIRepository # type: ignore from . import typelib, xml_reader from .errors import CompileError, CompilerBugError @@ -54,7 +42,7 @@ def add_typelib_search_path(path: str): def get_namespace(namespace: str, version: str) -> "Namespace": - search_paths = [*_repo.get_search_path(), *_user_search_paths] + search_paths = [*GIRepository.Repository.get_search_path(), *_user_search_paths] filename = f"{namespace}-{version}.typelib" @@ -86,7 +74,7 @@ def get_available_namespaces() -> T.List[T.Tuple[str, str]]: return _available_namespaces search_paths: list[str] = [ - *_repo.get_search_path(), + *GIRepository.Repository.get_search_path(), *_user_search_paths, ] @@ -467,13 +455,10 @@ class Signature(GirNode): return result @cached_property - def return_type(self) -> T.Optional[GirType]: - if self.tl.SIGNATURE_RETURN_TYPE == 0: - return None - else: - return self.get_containing(Repository)._resolve_type_id( - self.tl.SIGNATURE_RETURN_TYPE - ) + def return_type(self) -> GirType: + return self.get_containing(Repository)._resolve_type_id( + self.tl.SIGNATURE_RETURN_TYPE + ) class Signal(GirNode): @@ -493,10 +478,7 @@ class Signal(GirNode): args = ", ".join( [f"{a.type.full_name} {a.name}" for a in self.gir_signature.args] ) - result = f"signal {self.container.full_name}::{self.name} ({args})" - if self.gir_signature.return_type is not None: - result += f" -> {self.gir_signature.return_type.full_name}" - return result + return f"signal {self.container.full_name}::{self.name} ({args})" @property def online_docs(self) -> T.Optional[str]: @@ -908,6 +890,14 @@ class Namespace(GirNode): if isinstance(entry, Class) } + @cached_property + def interfaces(self) -> T.Mapping[str, Interface]: + return { + name: entry + for name, entry in self.entries.items() + if isinstance(entry, Interface) + } + def get_type(self, name) -> T.Optional[GirType]: """Gets a type (class, interface, enum, etc.) from this namespace.""" return self.entries.get(name) @@ -931,8 +921,13 @@ class Namespace(GirNode): """Looks up a type in the scope of this namespace (including in the namespace's dependencies).""" - ns, name = type_name.split(".", 1) - return self.get_containing(Repository).get_type(name, ns) + if type_name in _BASIC_TYPES: + return _BASIC_TYPES[type_name]() + elif "." in type_name: + ns, name = type_name.split(".", 1) + return self.get_containing(Repository).get_type(name, ns) + else: + return self.get_type(type_name) @property def online_docs(self) -> T.Optional[str]: @@ -951,7 +946,7 @@ class Repository(GirNode): self.includes = { name: get_namespace(name, version) for name, version in deps } - except: # pragma: no cover + except: raise CompilerBugError(f"Failed to load dependencies.") else: self.includes = {} @@ -959,6 +954,12 @@ class Repository(GirNode): def get_type(self, name: str, ns: str) -> T.Optional[GirType]: return self.lookup_namespace(ns).get_type(name) + def get_type_by_cname(self, name: str) -> T.Optional[GirType]: + for ns in [self.namespace, *self.includes.values()]: + if type := ns.get_type_by_cname(name): + return type + return None + def lookup_namespace(self, ns: str): """Finds a namespace among this namespace's dependencies.""" if ns == self.namespace.name: diff --git a/blueprintcompiler/language/__init__.py b/blueprintcompiler/language/__init__.py index e797eaa..b302686 100644 --- a/blueprintcompiler/language/__init__.py +++ b/blueprintcompiler/language/__init__.py @@ -4,6 +4,7 @@ from .adw_breakpoint import ( AdwBreakpointSetters, ) from .adw_response_dialog import ExtAdwResponseDialog +from .attributes import BaseAttribute from .binding import Binding from .common import * from .contexts import ScopeCtx, ValueTypeCtx @@ -19,7 +20,7 @@ from .expression import ( from .gobject_object import Object, ObjectContent from .gobject_property import Property from .gobject_signal import Signal -from .gtk_a11y import A11yProperty, ExtAccessibility +from .gtk_a11y import ExtAccessibility from .gtk_combo_box_text import ExtComboBoxItems from .gtk_file_filter import ( Filters, diff --git a/blueprintcompiler/language/adw_response_dialog.py b/blueprintcompiler/language/adw_response_dialog.py index d2680fd..5493d4d 100644 --- a/blueprintcompiler/language/adw_response_dialog.py +++ b/blueprintcompiler/language/adw_response_dialog.py @@ -20,6 +20,7 @@ from ..decompiler import decompile_translatable, truthy from .common import * +from .contexts import ValueTypeCtx from .gobject_object import ObjectContent, validate_parent_type from .values import StringValue @@ -93,6 +94,10 @@ class ExtAdwResponseDialogResponse(AstNode): self.value.range.text, ) + @context(ValueTypeCtx) + def value_type(self) -> ValueTypeCtx: + return ValueTypeCtx(StringType()) + @validate("id") def unique_in_parent(self): self.validate_unique_in_parent( diff --git a/blueprintcompiler/language/attributes.py b/blueprintcompiler/language/attributes.py new file mode 100644 index 0000000..8ff1f0b --- /dev/null +++ b/blueprintcompiler/language/attributes.py @@ -0,0 +1,32 @@ +# attributes.py +# +# Copyright 2022 James Westman +# +# 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 . +# +# SPDX-License-Identifier: LGPL-3.0-or-later + + +from .common import * + + +class BaseAttribute(AstNode): + """A helper class for attribute syntax of the form `name: literal_value;`""" + + tag_name: str = "" + attr_name: str = "name" + + @property + def name(self): + return self.tokens["name"] diff --git a/blueprintcompiler/language/expression.py b/blueprintcompiler/language/expression.py index f305035..ae9c399 100644 --- a/blueprintcompiler/language/expression.py +++ b/blueprintcompiler/language/expression.py @@ -38,6 +38,10 @@ class ExprBase(AstNode): def type(self) -> T.Optional[GirType]: raise NotImplementedError() + @property + def type_complete(self) -> bool: + return True + @property def rhs(self) -> T.Optional["ExprBase"]: if isinstance(self.parent, Expression): @@ -61,6 +65,10 @@ class Expression(ExprBase): def type(self) -> T.Optional[GirType]: return self.last.type + @property + def type_complete(self) -> bool: + return self.last.type_complete + class InfixExpr(ExprBase): @property @@ -91,6 +99,15 @@ class LiteralExpr(ExprBase): def type(self) -> T.Optional[GirType]: return self.literal.value.type + @property + def type_complete(self) -> bool: + from .values import IdentLiteral + + if isinstance(self.literal.value, IdentLiteral): + if object := self.context[ScopeCtx].objects.get(self.literal.value.ident): + return not object.gir_class.incomplete + return True + class LookupOp(InfixExpr): grammar = [".", UseIdent("property")] @@ -194,6 +211,10 @@ class CastExpr(InfixExpr): def type(self) -> T.Optional[GirType]: return self.children[TypeName][0].gir_type + @property + def type_complete(self) -> bool: + return True + @validate() def cast_makes_sense(self): if self.type is None or self.lhs.type is None: diff --git a/blueprintcompiler/language/gobject_property.py b/blueprintcompiler/language/gobject_property.py index b553909..5d0c867 100644 --- a/blueprintcompiler/language/gobject_property.py +++ b/blueprintcompiler/language/gobject_property.py @@ -51,7 +51,7 @@ class Property(AstNode): @property def document_symbol(self) -> DocumentSymbol: - if isinstance(self.value, ObjectValue) or self.value is None: + if isinstance(self.value, ObjectValue): detail = None else: detail = self.value.range.text diff --git a/blueprintcompiler/language/gobject_signal.py b/blueprintcompiler/language/gobject_signal.py index 9c27b97..79f9ae7 100644 --- a/blueprintcompiler/language/gobject_signal.py +++ b/blueprintcompiler/language/gobject_signal.py @@ -27,7 +27,6 @@ from .gtkbuilder_template import Template class SignalFlag(AstNode): grammar = AnyOf( UseExact("flag", "swapped"), - UseExact("flag", "not-swapped"), UseExact("flag", "after"), ) @@ -41,27 +40,6 @@ class SignalFlag(AstNode): f"Duplicate flag '{self.flag}'", lambda x: x.flag == self.flag ) - @validate() - def swapped_exclusive(self): - if self.flag in ["swapped", "not-swapped"]: - self.validate_unique_in_parent( - "'swapped' and 'not-swapped' flags cannot be used together", - lambda x: x.flag in ["swapped", "not-swapped"], - ) - - @validate() - def swapped_unnecessary(self): - if self.flag == "not-swapped" and self.parent.object_id is None: - raise CompileWarning( - "'not-swapped' is the default for handlers that do not specify an object", - actions=[CodeAction("Remove 'not-swapped' flag", "")], - ) - elif self.flag == "swapped" and self.parent.object_id is not None: - raise CompileWarning( - "'swapped' is the default for handlers that specify an object", - actions=[CodeAction("Remove 'swapped' flag", "")], - ) - @docs() def ref_docs(self): return get_docs_section("Syntax Signal") @@ -114,17 +92,9 @@ class Signal(AstNode): def flags(self) -> T.List[SignalFlag]: return self.children[SignalFlag] - # Returns True if the "swapped" flag is present, False if "not-swapped" is present, and None if neither are present. - # GtkBuilder's default if swapped is not specified is to not swap the arguments if no object is specified, and to - # swap them if an object is specified. @property - def is_swapped(self) -> T.Optional[bool]: - for flag in self.flags: - if flag.flag == "swapped": - return True - elif flag.flag == "not-swapped": - return False - return None + def is_swapped(self) -> bool: + return any(x.flag == "swapped" for x in self.flags) @property def is_after(self) -> bool: @@ -143,17 +113,16 @@ class Signal(AstNode): @property def document_symbol(self) -> DocumentSymbol: - detail = self.ranges["detail_start", "detail_end"] return DocumentSymbol( self.full_name, SymbolKind.Event, self.range, self.group.tokens["name"].range, - detail.text if detail is not None else None, + self.ranges["detail_start", "detail_end"].text, ) def get_reference(self, idx: int) -> T.Optional[LocationLink]: - if self.object_id is not None and idx in self.group.tokens["object"].range: + if idx in self.group.tokens["object"].range: obj = self.context[ScopeCtx].objects.get(self.object_id) if obj is not None: return LocationLink( @@ -225,16 +194,15 @@ class Signal(AstNode): @decompiler("signal") -def decompile_signal(ctx, gir, name, handler, swapped=None, after="false", object=None): +def decompile_signal( + ctx, gir, name, handler, swapped="false", after="false", object=None +): object_name = object or "" name = name.replace("_", "-") line = f"{name} => ${handler}({object_name})" if decompile.truthy(swapped): line += " swapped" - elif swapped is not None: - line += " not-swapped" - if decompile.truthy(after): line += " after" diff --git a/blueprintcompiler/language/gtk_a11y.py b/blueprintcompiler/language/gtk_a11y.py index 0cc3cb3..3657565 100644 --- a/blueprintcompiler/language/gtk_a11y.py +++ b/blueprintcompiler/language/gtk_a11y.py @@ -19,6 +19,8 @@ import typing as T +from ..decompiler import escape_quote +from .attributes import BaseAttribute from .common import * from .contexts import ValueTypeCtx from .gobject_object import ObjectContent, validate_parent_type @@ -117,7 +119,7 @@ def _get_docs(gir, name): return gir_type.doc -class A11yProperty(AstNode): +class A11yProperty(BaseAttribute): grammar = Statement( UseIdent("name"), ":", diff --git a/blueprintcompiler/language/gtk_combo_box_text.py b/blueprintcompiler/language/gtk_combo_box_text.py index 32b3486..312750a 100644 --- a/blueprintcompiler/language/gtk_combo_box_text.py +++ b/blueprintcompiler/language/gtk_combo_box_text.py @@ -19,6 +19,7 @@ from .common import * +from .contexts import ValueTypeCtx from .gobject_object import ObjectContent, validate_parent_type from .values import StringValue diff --git a/blueprintcompiler/language/gtk_list_item_factory.py b/blueprintcompiler/language/gtk_list_item_factory.py index c9e1399..3309c08 100644 --- a/blueprintcompiler/language/gtk_list_item_factory.py +++ b/blueprintcompiler/language/gtk_list_item_factory.py @@ -50,7 +50,7 @@ class ExtListItemFactory(AstNode): else: return self.root.gir.get_type("ListItem", "Gtk") - @validate("id") + @validate("template") def container_is_builder_list(self): validate_parent_type( self, @@ -59,7 +59,7 @@ class ExtListItemFactory(AstNode): "sub-templates", ) - @validate("id") + @validate("template") def unique_in_parent(self): self.validate_unique_in_parent("Duplicate template block") @@ -76,7 +76,7 @@ class ExtListItemFactory(AstNode): f"Only Gtk.ListItem, Gtk.ListHeader, Gtk.ColumnViewRow, or Gtk.ColumnViewCell is allowed as a type here" ) - @validate("id") + @validate("template") def type_name_upgrade(self): if self.type_name is None: raise UpgradeWarning( @@ -103,7 +103,10 @@ class ExtListItemFactory(AstNode): @property def action_widgets(self): - # The sub-template shouldn't have its own actions, this is just here to satisfy XmlOutput._emit_object_or_template + """ + The sub-template shouldn't have it`s own actions this is + just hear to satisfy XmlOutput._emit_object_or_template + """ return None @docs("id") diff --git a/blueprintcompiler/language/imports.py b/blueprintcompiler/language/imports.py index 2d4bcf6..3060bea 100644 --- a/blueprintcompiler/language/imports.py +++ b/blueprintcompiler/language/imports.py @@ -59,8 +59,14 @@ class GtkDirective(AstNode): @property def gir_namespace(self): - # For better error handling, just assume it's 4.0 - return gir.get_namespace("Gtk", "4.0") + # validate the GTK version first to make sure the more specific error + # message is emitted + self.gtk_version() + if self.tokens["version"] is not None: + return gir.get_namespace("Gtk", self.tokens["version"]) + else: + # For better error handling, just assume it's 4.0 + return gir.get_namespace("Gtk", "4.0") @docs() def ref_docs(self): @@ -84,7 +90,7 @@ class Import(AstNode): @validate("namespace", "version") def namespace_exists(self): - gir.get_namespace(self.namespace, self.version) + gir.get_namespace(self.tokens["namespace"], self.tokens["version"]) @validate() def unused(self): @@ -100,7 +106,7 @@ class Import(AstNode): @property def gir_namespace(self): try: - return gir.get_namespace(self.namespace, self.version) + return gir.get_namespace(self.tokens["namespace"], self.tokens["version"]) except CompileError: return None diff --git a/blueprintcompiler/outputs/xml/__init__.py b/blueprintcompiler/outputs/xml/__init__.py index a21b6fb..5e43834 100644 --- a/blueprintcompiler/outputs/xml/__init__.py +++ b/blueprintcompiler/outputs/xml/__init__.py @@ -169,7 +169,7 @@ class XmlOutput(OutputFormat): "signal", name=name, handler=signal.handler, - swapped=signal.is_swapped, + swapped=signal.is_swapped or None, after=signal.is_after or None, object=( self._object_id(signal, signal.object_id) if signal.object_id else None @@ -366,13 +366,12 @@ class XmlOutput(OutputFormat): elif isinstance(extension, ExtScaleMarks): xml.start_tag("marks") - for mark in extension.marks: - label = mark.label.child if mark.label is not None else None + for mark in extension.children: xml.start_tag( "mark", value=mark.value, position=mark.position, - **self._translated_string_attrs(label), + **self._translated_string_attrs(mark.label and mark.label.child), ) if mark.label is not None: xml.put_text(mark.label.string) diff --git a/blueprintcompiler/outputs/xml/xml_emitter.py b/blueprintcompiler/outputs/xml/xml_emitter.py index ea91e03..ca87a49 100644 --- a/blueprintcompiler/outputs/xml/xml_emitter.py +++ b/blueprintcompiler/outputs/xml/xml_emitter.py @@ -40,9 +40,7 @@ class XmlEmitter: self._tag_stack = [] self._needs_newline = False - def start_tag( - self, tag, **attrs: T.Union[str, GirType, ClassName, bool, None, float] - ): + def start_tag(self, tag, **attrs: T.Union[str, GirType, ClassName, bool, None]): self._indent() self.result += f"<{tag}" for key, val in attrs.items(): diff --git a/blueprintcompiler/parse_tree.py b/blueprintcompiler/parse_tree.py index ae062fb..fff6e4a 100644 --- a/blueprintcompiler/parse_tree.py +++ b/blueprintcompiler/parse_tree.py @@ -95,11 +95,19 @@ class ParseGroup: try: return self.ast_type(self, children, self.keys, incomplete=self.incomplete) - except TypeError: # pragma: no cover + except TypeError as e: raise CompilerBugError( f"Failed to construct ast.{self.ast_type.__name__} from ParseGroup. See the previous stacktrace." ) + def __str__(self): + result = str(self.ast_type.__name__) + result += "".join([f"\n{key}: {val}" for key, val in self.keys.items()]) + "\n" + result += "\n".join( + [str(child) for children in self.children.values() for child in children] + ) + return result.replace("\n", "\n ") + class ParseContext: """Contains the state of the parser.""" @@ -257,6 +265,10 @@ class ParseNode: """Convenience method for err().""" return self.err("Expected " + expect) + def warn(self, message) -> "Warning": + """Causes this ParseNode to emit a warning if it parses successfully.""" + return Warning(self, message) + class Err(ParseNode): """ParseNode that emits a compile error if it fails to parse.""" @@ -278,6 +290,27 @@ class Err(ParseNode): return True +class Warning(ParseNode): + """ParseNode that emits a compile warning if it parses successfully.""" + + def __init__(self, child, message: str): + self.child = to_parse_node(child) + self.message = message + + def _parse(self, ctx: ParseContext): + ctx.skip() + start_idx = ctx.index + if self.child.parse(ctx).succeeded(): + start_token = ctx.tokens[start_idx] + end_token = ctx.tokens[ctx.index] + ctx.warnings.append( + CompileWarning(self.message, start_token.start, end_token.end) + ) + return True + else: + return False + + class Fail(ParseNode): """ParseNode that emits a compile error if it parses successfully.""" diff --git a/docs/reference/objects.rst b/docs/reference/objects.rst index 09f5af8..699db49 100644 --- a/docs/reference/objects.rst +++ b/docs/reference/objects.rst @@ -91,7 +91,7 @@ Signal Handlers .. rst-class:: grammar-block Signal = `> ('::' `>)? '=>' '$' `> '(' `>? ')' (SignalFlag)* ';' - SignalFlag = 'after' | 'swapped' | 'not-swapped' + SignalFlag = 'after' | 'swapped' Signals are one way to respond to user input (another is `actions `_, which use the `action-name property `_). @@ -99,8 +99,6 @@ Signals provide a handle for your code to listen to events in the UI. The handle Optionally, you can provide an object ID to use when connecting the signal. -The ``swapped`` flag is used to swap the order of the object and userdata arguments in C applications. If an object argument is specified, then this is the default behavior, so the ``not-swapped`` flag can be used to prevent the swap. - Example ~~~~~~~ @@ -110,6 +108,7 @@ Example clicked => $on_button_clicked(); } + .. _Syntax Child: Children diff --git a/tests/formatting/comment_in.blp b/tests/formatting/comment_in.blp deleted file mode 100644 index 32a907c..0000000 --- a/tests/formatting/comment_in.blp +++ /dev/null @@ -1,2 +0,0 @@ -using Gtk 4.0; -//comment \ No newline at end of file diff --git a/tests/formatting/comment_out.blp b/tests/formatting/comment_out.blp deleted file mode 100644 index d5dca95..0000000 --- a/tests/formatting/comment_out.blp +++ /dev/null @@ -1,2 +0,0 @@ -using Gtk 4.0; -// comment diff --git a/tests/sample_errors/float_to_int_assignment.blp b/tests/sample_errors/float_to_int_assignment.blp deleted file mode 100644 index 73b5dc4..0000000 --- a/tests/sample_errors/float_to_int_assignment.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -Entry { - margin-bottom: 10.5; -} diff --git a/tests/sample_errors/float_to_int_assignment.err b/tests/sample_errors/float_to_int_assignment.err deleted file mode 100644 index 0e9dc41..0000000 --- a/tests/sample_errors/float_to_int_assignment.err +++ /dev/null @@ -1 +0,0 @@ -4,18,4,Cannot convert 10.5 to integer \ No newline at end of file diff --git a/tests/sample_errors/incomplete_signal.blp b/tests/sample_errors/incomplete_signal.blp deleted file mode 100644 index 4ec693d..0000000 --- a/tests/sample_errors/incomplete_signal.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -Label { - notify:: -} diff --git a/tests/sample_errors/incomplete_signal.err b/tests/sample_errors/incomplete_signal.err deleted file mode 100644 index 901ef3b..0000000 --- a/tests/sample_errors/incomplete_signal.err +++ /dev/null @@ -1,2 +0,0 @@ -5,1,0,Expected a signal detail name -4,9,3,Unexpected tokens \ No newline at end of file diff --git a/tests/sample_errors/int_object.blp b/tests/sample_errors/int_object.blp deleted file mode 100644 index 35b2562..0000000 --- a/tests/sample_errors/int_object.blp +++ /dev/null @@ -1,3 +0,0 @@ -using Gtk 4.0; - -int {} diff --git a/tests/sample_errors/int_object.err b/tests/sample_errors/int_object.err deleted file mode 100644 index 221e6e6..0000000 --- a/tests/sample_errors/int_object.err +++ /dev/null @@ -1 +0,0 @@ -3,1,3,int is not a class \ No newline at end of file diff --git a/tests/sample_errors/menu_assignment.blp b/tests/sample_errors/menu_assignment.blp deleted file mode 100644 index 9188d8a..0000000 --- a/tests/sample_errors/menu_assignment.blp +++ /dev/null @@ -1,7 +0,0 @@ -using Gtk 4.0; - -Overlay { - child: my_menu; -} - -menu my_menu {} diff --git a/tests/sample_errors/menu_assignment.err b/tests/sample_errors/menu_assignment.err deleted file mode 100644 index fb3187f..0000000 --- a/tests/sample_errors/menu_assignment.err +++ /dev/null @@ -1 +0,0 @@ -4,10,7,Cannot assign Gio.Menu to Gtk.Widget \ No newline at end of file diff --git a/tests/sample_errors/signal_exclusive_flags.blp b/tests/sample_errors/signal_exclusive_flags.blp deleted file mode 100644 index 6432965..0000000 --- a/tests/sample_errors/signal_exclusive_flags.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -$MyObject obj { - signal1 => $handler() swapped not-swapped; -} diff --git a/tests/sample_errors/signal_exclusive_flags.err b/tests/sample_errors/signal_exclusive_flags.err deleted file mode 100644 index 5176510..0000000 --- a/tests/sample_errors/signal_exclusive_flags.err +++ /dev/null @@ -1 +0,0 @@ -4,33,11,'swapped' and 'not-swapped' flags cannot be used together \ No newline at end of file diff --git a/tests/sample_errors/signal_unnecessary_flags.blp b/tests/sample_errors/signal_unnecessary_flags.blp deleted file mode 100644 index ed95a9b..0000000 --- a/tests/sample_errors/signal_unnecessary_flags.blp +++ /dev/null @@ -1,6 +0,0 @@ -using Gtk 4.0; - -$MyObject obj { - signal1 => $handler() not-swapped; - signal2 => $handler(obj) swapped; -} diff --git a/tests/sample_errors/signal_unnecessary_flags.err b/tests/sample_errors/signal_unnecessary_flags.err deleted file mode 100644 index 7586085..0000000 --- a/tests/sample_errors/signal_unnecessary_flags.err +++ /dev/null @@ -1,2 +0,0 @@ -4,25,11,'not-swapped' is the default for handlers that do not specify an object -5,28,7,'swapped' is the default for handlers that specify an object \ No newline at end of file diff --git a/tests/sample_errors/string_to_num_assignment.blp b/tests/sample_errors/string_to_num_assignment.blp deleted file mode 100644 index 22e8fba..0000000 --- a/tests/sample_errors/string_to_num_assignment.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -Entry { - margin-bottom: "10"; -} diff --git a/tests/sample_errors/string_to_num_assignment.err b/tests/sample_errors/string_to_num_assignment.err deleted file mode 100644 index 98a6160..0000000 --- a/tests/sample_errors/string_to_num_assignment.err +++ /dev/null @@ -1 +0,0 @@ -4,18,4,Cannot convert string to number \ No newline at end of file diff --git a/tests/sample_errors/string_to_object_assignment.blp b/tests/sample_errors/string_to_object_assignment.blp deleted file mode 100644 index 0c070ba..0000000 --- a/tests/sample_errors/string_to_object_assignment.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -Button { - child: "Click me"; -} diff --git a/tests/sample_errors/string_to_object_assignment.err b/tests/sample_errors/string_to_object_assignment.err deleted file mode 100644 index f9492af..0000000 --- a/tests/sample_errors/string_to_object_assignment.err +++ /dev/null @@ -1 +0,0 @@ -4,10,10,Cannot convert string to Gtk.Widget \ No newline at end of file diff --git a/tests/sample_errors/string_to_type_assignment.blp b/tests/sample_errors/string_to_type_assignment.blp deleted file mode 100644 index 90f531b..0000000 --- a/tests/sample_errors/string_to_type_assignment.blp +++ /dev/null @@ -1,6 +0,0 @@ -using Gtk 4.0; -using Gio 2.0; - -Gio.ListStore { - item-type: "Button"; -} diff --git a/tests/sample_errors/string_to_type_assignment.err b/tests/sample_errors/string_to_type_assignment.err deleted file mode 100644 index adb9eb0..0000000 --- a/tests/sample_errors/string_to_type_assignment.err +++ /dev/null @@ -1 +0,0 @@ -5,14,8,Cannot convert string to GType \ No newline at end of file diff --git a/tests/sample_errors/translated_assignment.blp b/tests/sample_errors/translated_assignment.blp deleted file mode 100644 index fa8fa9d..0000000 --- a/tests/sample_errors/translated_assignment.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -Button { - child: _("Click me"); -} diff --git a/tests/sample_errors/translated_assignment.err b/tests/sample_errors/translated_assignment.err deleted file mode 100644 index 78f6b96..0000000 --- a/tests/sample_errors/translated_assignment.err +++ /dev/null @@ -1 +0,0 @@ -4,10,13,Cannot convert translated string to Gtk.Widget \ No newline at end of file diff --git a/tests/sample_errors/typeof_assignment.blp b/tests/sample_errors/typeof_assignment.blp deleted file mode 100644 index a20d92c..0000000 --- a/tests/sample_errors/typeof_assignment.blp +++ /dev/null @@ -1,5 +0,0 @@ -using Gtk 4.0; - -Button { - label: typeof