gtk4-macros: Make the blueprint compiler feature opt-in

Otherwise tests would fail if the user doesn't have blueprint-compiler installed
locally

Author: bilelmoussaoui

gtk4-macros/Cargo.toml

@@ -15,7 +15,9 @@ rust-version = "1.64"
 proc-macro = true
 
 [features]
+default = []
 xml_validation = ["quick-xml"]
+blueprint = []
 
 [dependencies]
 anyhow = "1.0"

gtk4-macros/README.md

@@ -21,6 +21,7 @@ Currently, the minimum supported Rust version is `1.64.0`.
 | Feature | Description |
 | ---     | ----------- |
 | `xml_validation` | Check the existence of `#[template_child]` fields in the UI file. Only works with `#[template(string = "")]` |
+| `blueprint` | Adds blueprint usage support in `#[template(string = "")]` |
 
 ### See Also
 

gtk4-macros/src/attribute_parser.rs

@@ -16,19 +16,26 @@ pub enum TemplateSource {
     File(String),
     Resource(String),
     Xml(String),
+    #[cfg(feature = "blueprint")]
     Blueprint(String),
 }
 
 impl TemplateSource {
     fn from_string_source(source: String) -> Result<Self> {
         for c in source.chars() {
+            #[cfg(feature = "blueprint")]
             if c.is_ascii_alphabetic() {
                 // blueprint code starts with some alphabetic letters
                 return Ok(Self::Blueprint(source));
             } else if c == '<' {
                 // xml tags starts with '<' symbol
                 return Ok(Self::Xml(source));
             }
+            #[cfg(not(feature = "blueprint"))]
+            if c == '<' {
+                // xml tags starts with '<' symbol
+                return Ok(Self::Xml(source));
+            }
         }
         bail!("Unknown lanuage")
     }

gtk4-macros/src/composite_template_derive.rs

@@ -11,7 +11,9 @@ use syn::Data;
 use std::collections::HashMap;
 use std::string::ToString;
 
-use crate::{attribute_parser::*, blueprint::*, util::*};
+#[cfg(feature = "blueprint")]
+use crate::blueprint::*;
+use crate::{attribute_parser::*, util::*};
 
 fn gen_set_template(source: &TemplateSource, crate_ident: &proc_macro2::Ident) -> TokenStream {
     match source {
@@ -33,6 +35,7 @@ fn gen_set_template(source: &TemplateSource, crate_ident: &proc_macro2::Ident) -
                 #template.as_bytes(),
             );
         },
+        #[cfg(feature = "blueprint")]
         TemplateSource::Blueprint(blueprint) => {
             let template =
                 compile_blueprint(blueprint.as_bytes()).expect("can't compile blueprint");

gtk4-macros/src/lib.rs

@@ -5,6 +5,7 @@
 //! The crate aims to provide useful macros to use with the GTK 4 Rust bindings.
 
 mod attribute_parser;
+#[cfg(feature = "blueprint")]
 mod blueprint;
 mod composite_template_derive;
 mod template_callbacks_attribute;
@@ -41,15 +42,12 @@ use syn::{parse_macro_input, DeriveInput};
 ///
 /// ```no_run
 /// # fn main() {}
-/// use gtk::prelude::*;
-/// use gtk::glib;
-/// use gtk::CompositeTemplate;
-/// use gtk::subclass::prelude::*;
+/// use gtk::{glib, prelude::*, subclass::prelude::*};
 ///
 /// mod imp {
 ///     use super::*;
 ///
-///     #[derive(Debug, Default, CompositeTemplate)]
+///     #[derive(Debug, Default, gtk::CompositeTemplate)]
 ///     #[template(file = "test/template.ui")]
 ///     pub struct MyWidget {
 ///         #[template_child]
@@ -90,17 +88,16 @@ use syn::{parse_macro_input, DeriveInput};
 /// ```
 ///
 /// The [`CompositeTemplate`] macro can also be used with [Blueprint](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/)
+/// if the feature `blueprint` is enabled.
 ///
-/// ```rust
-/// ```no_run
+/// ```ignore
 /// # fn main() {}
-/// use gtk::prelude::*;
-/// use gtk::glib;
-/// use gtk::CompositeTemplate;
-/// use gtk::subclass::prelude::*;
+/// use gtk::{glib, prelude::*, subclass::prelude::*};
 ///
 /// mod imp {
-///     #[derive(Debug, Default, CompositeTemplate)]
+///     use super::*;
+///
+///     #[derive(Debug, Default, gtk::CompositeTemplate)]
 ///     #[template(string = "
 ///     template MyWidget : Widget {
 ///         Label label {
@@ -234,15 +231,12 @@ pub fn composite_template_derive(input: TokenStream) -> TokenStream {
 ///
 /// ```no_run
 /// # fn main() {}
-/// use gtk::prelude::*;
-/// use gtk::glib;
-/// use gtk::CompositeTemplate;
-/// use gtk::subclass::prelude::*;
+/// use gtk::{glib, prelude::*, subclass::prelude::*};
 ///
 /// mod imp {
 ///     use super::*;
 ///
-///     #[derive(Debug, Default, CompositeTemplate)]
+///     #[derive(Debug, Default, gtk::CompositeTemplate)]
 ///     #[template(file = "test/template_callbacks.ui")]
 ///     pub struct MyWidget {
 ///         #[template_child]

gtk4-macros/tests/templates.rs

@@ -200,7 +200,7 @@ fn template_child_without_attribute() {
     let _: MyWidget3 = glib::Object::new();
 }
 
-#[cfg(target_os = "linux")]
+#[cfg(feature = "blueprint")]
 mod imp4 {
     use super::*;
 
@@ -246,13 +246,13 @@ mod imp4 {
     impl WidgetImpl for MyWidget4 {}
 }
 
-#[cfg(target_os = "linux")]
+#[cfg(feature = "blueprint")]
 glib::wrapper! {
     pub struct MyWidget4(ObjectSubclass<imp4::MyWidget4>) @extends gtk::Widget;
 }
 
 #[gtk::test]
-#[cfg(target_os = "linux")]
+#[cfg(feature = "blueprint")]
 fn blueprint_template() {
     let _: MyWidget4 = glib::Object::new();
 }

gtk4/Cargo.toml

@@ -23,6 +23,7 @@ v4_6 = ["ffi/v4_6", "v4_4", "gdk/v4_6", "gsk/v4_6", "pango/v1_50"]
 v4_8 = ["ffi/v4_8", "v4_6", "gdk/v4_8"]
 v4_10 = ["ffi/v4_10", "v4_8", "gdk/v4_10"]
 xml_validation = ["gtk4-macros/xml_validation"]
+blueprint = ["gtk4-macros/blueprint"]
 unsafe-assume-initialized = []
 
 # Versions from https://gitlab.gnome.org/GNOME/gnome-build-meta/-/tree/gnome-43/elements/sdk

gtk4/README.md

@@ -191,7 +191,8 @@ gtk = { git = "https://github.com/gtk-rs/gtk4-rs.git", package = "gtk4" }
 | `gnome_43` | Enable all version feature flags of this crate and its dependencies to match the GNOME 43 SDK |
 | `gnome_42` | Enable all version feature flags of this crate and its dependencies to match the GNOME 42 SDK |
 | `unsafe-assume-initialized` | Disable checks that gtk is initialized, for use in C ABI libraries |
-| `xml_validation` | Enable `xml_validation` feature of gtk4-macros 
+| `xml_validation` | Enable `xml_validation` feature of gtk4-macros |
+| `blueprint` | Enable `blueprint` feature of gtk4-macros |
 
 ### See Also