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

2025-05-04 15:59:08 -04:00 · 2023-09-22 22:25:15 +02:00 · 2023-09-22 22:25:15 +02:00 · 4acc05cfda
commit 4acc05cfda
parent 529b26b759 1371dec494
46 changed files with 237 additions and 3 deletions
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -19,7 +19,7 @@ build:
    - ninja -C _build docs/en
    - git clone https://gitlab.gnome.org/jwestman/blueprint-regression-tests.git
    - cd blueprint-regression-tests
-    - git checkout 9bfb9325d75a9985310230f119579f07df519e60
+    - git checkout 71522af3607e08143671ee0d224e65e9b9eb9f30
    - ./test.sh
    - cd ..
  coverage: '/TOTAL.*\s([.\d]+)%/'
--- a/blueprintcompiler/lsp.py
+++ b/blueprintcompiler/lsp.py
@ -326,7 +326,7 @@ class LanguageServer:
        xml = None
        try:
            output = XmlOutput()
-            xml = output.emit(open_file.ast)
+            xml = output.emit(open_file.ast, generated_notice=False)
        except:
            printerr(traceback.format_exc())
            self._send_error(id, ErrorCode.RequestFailed, "Could not compile document")
--- a/blueprintcompiler/outputs/xml/xml_emitter.py
+++ b/blueprintcompiler/outputs/xml/xml_emitter.py
@ -25,9 +25,18 @@ from blueprintcompiler.language.types import ClassName


 class XmlEmitter:
-    def __init__(self, indent=2):
+    def __init__(self, indent=2, generated_notice=True):
        self.indent = indent
        self.result = '<?xml version="1.0" encoding="UTF-8"?>'
+        if generated_notice:
+            self.result += (
+                "\n"
+                "<!--\n"
+                "DO NOT EDIT!\n"
+                "This file was @generated by blueprint-compiler. Instead, edit the\n"
+                "corresponding .blp file and regenerate this file with blueprint-compiler.\n"
+                "-->"
+            )
        self._tag_stack = []
        self._needs_newline = False

--- a/tests/samples/accessibility.ui
+++ b/tests/samples/accessibility.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkBox">
--- a/tests/samples/action_widgets.ui
+++ b/tests/samples/action_widgets.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkDialog">
--- a/tests/samples/adw_breakpoint.ui
+++ b/tests/samples/adw_breakpoint.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel" id="label"></object>
--- a/tests/samples/child_type.ui
+++ b/tests/samples/child_type.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkWindow">
--- a/tests/samples/combo_box_text.ui
+++ b/tests/samples/combo_box_text.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkComboBoxText">
--- a/tests/samples/comments.ui
+++ b/tests/samples/comments.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GObject"></object>
--- a/tests/samples/enum.ui
+++ b/tests/samples/enum.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkScrolledWindow">
--- a/tests/samples/expr_closure.ui
+++ b/tests/samples/expr_closure.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel" id="my-label">
--- a/tests/samples/expr_closure_args.ui
+++ b/tests/samples/expr_closure_args.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel">
--- a/tests/samples/expr_lookup.ui
+++ b/tests/samples/expr_lookup.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkOverlay">
--- a/tests/samples/file_filter.ui
+++ b/tests/samples/file_filter.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkFileFilter">
--- a/tests/samples/flags.ui
+++ b/tests/samples/flags.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GApplication">
--- a/tests/samples/id_prop.ui
+++ b/tests/samples/id_prop.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkScale">
--- a/tests/samples/issue_119.ui
+++ b/tests/samples/issue_119.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkAdjustment">
--- a/tests/samples/layout.ui
+++ b/tests/samples/layout.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkGrid">
--- a/tests/samples/list_factory.ui
+++ b/tests/samples/list_factory.ui
@ -1,10 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkListView">
    <property name="factory">
      <object class="GtkBuilderListItemFactory" id="list_item_factory">
        <property name="bytes"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <template class="GtkListItem">
    <property name="child">
--- a/tests/samples/menu.ui
+++ b/tests/samples/menu.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <menu id="my-menu">
--- a/tests/samples/numbers.ui
+++ b/tests/samples/numbers.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel">
--- a/tests/samples/object_prop.ui
+++ b/tests/samples/object_prop.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkRange">
--- a/tests/samples/parseable.ui
+++ b/tests/samples/parseable.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkShortcut">
--- a/tests/samples/placeholder.ui
+++ b/tests/samples/placeholder.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkBox">
--- a/tests/samples/property.ui
+++ b/tests/samples/property.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkBox">
--- a/tests/samples/property_binding.ui
+++ b/tests/samples/property_binding.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkBox">
--- a/tests/samples/responses.ui
+++ b/tests/samples/responses.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="AdwMessageDialog">
--- a/tests/samples/scale_marks.ui
+++ b/tests/samples/scale_marks.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkScale">
--- a/tests/samples/signal.ui
+++ b/tests/samples/signal.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkEntry">
--- a/tests/samples/size_group.ui
+++ b/tests/samples/size_group.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkSizeGroup">
--- a/tests/samples/string_list.ui
+++ b/tests/samples/string_list.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkStringList" id="greetings">
--- a/tests/samples/strings.ui
+++ b/tests/samples/strings.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel">
--- a/tests/samples/style.ui
+++ b/tests/samples/style.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel">
--- a/tests/samples/subscope.ui
+++ b/tests/samples/subscope.ui
@ -1,8 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkBuilderListItemFactory">
    <property name="bytes"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <template class="GtkListItem">
    <property name="child">
--- a/tests/samples/template.ui
+++ b/tests/samples/template.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="TestTemplate" parent="GtkApplicationWindow">
--- a/tests/samples/template_bind_property.ui
+++ b/tests/samples/template_bind_property.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="MyTemplate">
--- a/tests/samples/template_binding.ui
+++ b/tests/samples/template_binding.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="MyTemplate" parent="GtkBox">
--- a/tests/samples/template_binding_extern.ui
+++ b/tests/samples/template_binding_extern.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="MyTemplate" parent="MyParentClass">
--- a/tests/samples/template_id.ui
+++ b/tests/samples/template_id.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="MyTemplate" parent="GtkButton">
--- a/tests/samples/template_no_parent.ui
+++ b/tests/samples/template_no_parent.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="GtkListItem"></template>
--- a/tests/samples/template_simple_binding.ui
+++ b/tests/samples/template_simple_binding.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <template class="MyTemplate">
--- a/tests/samples/translated.ui
+++ b/tests/samples/translated.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkLabel">
--- a/tests/samples/typeof.ui
+++ b/tests/samples/typeof.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GListStore">
--- a/tests/samples/uint.ui
+++ b/tests/samples/uint.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GtkFlowBox">
--- a/tests/samples/unchecked_class.ui
+++ b/tests/samples/unchecked_class.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="MyComponent" id="component">
--- a/tests/samples/using.ui
+++ b/tests/samples/using.ui
@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+DO NOT EDIT!
+This file was @generated by blueprint-compiler. Instead, edit the
+corresponding .blp file and regenerate this file with blueprint-compiler.
+-->
 <interface>
  <requires lib="gtk" version="4.0"/>
  <object class="GObject"></object>