Switch structs to storing CommonAttrs instead of just attrs

Author: BenFordTytherington

crates/cxx-qt-gen/src/generator/cpp/inherit.rs

@@ -27,7 +27,7 @@ pub fn generate(
 
     for &method in inherited_methods {
         // Skip if the cfg attributes are not resolved to true
-        if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &method.cfgs)? {
+        if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &method.common_attrs.cfgs)? {
             continue;
         }
 

crates/cxx-qt-gen/src/generator/cpp/mod.rs

@@ -72,7 +72,7 @@ impl GeneratedCppBlocks {
                 .iter()
                 .filter_map(|qobject| {
                     // Skip if the cfg attributes are not resolved to true
-                    match try_eval_attributes(opt.cfg_evaluator.as_ref(), &qobject.declaration.cfgs)
+                    match try_eval_attributes(opt.cfg_evaluator.as_ref(), &qobject.declaration.common_attrs.cfgs)
                     {
                         Ok(true) => {
                             Some(GeneratedCppQObject::from(qobject, &parser.type_names, opt))

crates/cxx-qt-gen/src/generator/cpp/qenum.rs

@@ -39,7 +39,7 @@ pub fn generate_declaration(
     opt: &GeneratedOpt,
 ) -> Result<String> {
     // Skip if the cfg attributes are not resolved to true
-    if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &qenum.cfgs)? {
+    if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &qenum.common_attrs.cfgs)? {
         return Ok(String::new());
     }
 
@@ -75,7 +75,7 @@ pub fn generate_on_qobject<'a>(
 
     for qenum in qenums {
         // Skip if the cfg attributes are not resolved to true
-        if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &qenum.cfgs)? {
+        if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &qenum.common_attrs.cfgs)? {
             continue;
         }
 

crates/cxx-qt-gen/src/generator/cpp/signal.rs

@@ -89,7 +89,7 @@ pub fn generate_cpp_signal(
     let mut generated = CppSignalFragment::default();
 
     // Skip if the cfg attributes are not resolved to true
-    if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &signal.cfgs)? {
+    if !try_eval_attributes(opt.cfg_evaluator.as_ref(), &signal.common_attrs.cfgs)? {
         return Ok(generated);
     }
 

crates/cxx-qt-gen/src/generator/rust/externcxxqt.rs

@@ -22,7 +22,7 @@ impl GeneratedRustFragment {
         } else {
             quote! {}
         };
-        let extern_block_docs = &extern_cxxqt_block.docs;
+        let extern_block_docs = &extern_cxxqt_block.common_attrs.docs;
 
         // Add the pass through blocks
         let unsafety = &extern_cxxqt_block.unsafety;
@@ -60,6 +60,7 @@ impl GeneratedRustFragment {
                     #[cxx_name = #cxx_name]
                 }
             };
+            // TODO! Can we make extract_docs return references, and then use here?
             let cfgs: Vec<&Attribute> = obj
                 .declaration
                 .attrs

crates/cxx-qt-gen/src/generator/rust/inherit.rs

@@ -48,8 +48,8 @@ pub fn generate(
             if method.safe {
                 std::mem::swap(&mut unsafe_call, &mut unsafe_block);
             }
-            let doc_comments = &method.docs;
-            let cfgs = &method.cfgs;
+            let doc_comments = &method.common_attrs.docs;
+            let cfgs = &method.common_attrs.cfgs;
             let namespace = qobject_names.namespace_tokens();
 
             syn::parse2(quote_spanned! {

crates/cxx-qt-gen/src/generator/rust/qenum.rs

@@ -16,8 +16,8 @@ pub fn generate_cxx_mod_contents(qenums: &[ParsedQEnum]) -> Vec<Item> {
             let item = &qenum.item;
             let vis = &item.vis;
             let variants = &item.variants;
-            let docs = &qenum.docs;
-            let cfgs = &qenum.cfgs;
+            let docs = &qenum.common_attrs.docs;
+            let cfgs = &qenum.common_attrs.cfgs;
 
             let cxx_namespace = if namespace.is_none() {
                 quote! {}

crates/cxx-qt-gen/src/generator/rust/qobject.rs

@@ -28,7 +28,7 @@ impl GeneratedRustFragment {
         let namespace_idents = NamespaceName::from(qobject);
 
         let mut generated = vec![
-            generate_qobject_definitions(&qobject_names, &qobject.cfgs, &qobject.docs)?,
+            generate_qobject_definitions(&qobject_names, &qobject.common_attrs.cfgs, &qobject.common_attrs.docs)?,
             generate_rust_properties(
                 &qobject.properties,
                 &qobject_names,
@@ -57,7 +57,7 @@ impl GeneratedRustFragment {
                 &qobject_names,
                 &namespace_idents,
                 type_names,
-                &qobject.cfgs,
+                &qobject.common_attrs.cfgs,
             )?);
         }
 
@@ -75,9 +75,9 @@ impl GeneratedRustFragment {
                 &qobject_names,
                 &namespace_idents,
                 type_names,
-                &qobject.cfgs,
+                &qobject.common_attrs.cfgs,
             )?,
-            cxxqttype::generate(&qobject_names, type_names, &qobject.cfgs)?,
+            cxxqttype::generate(&qobject_names, type_names, &qobject.common_attrs.cfgs)?,
         ]);
 
         Ok(GeneratedRustFragment::flatten(generated))

crates/cxx-qt-gen/src/generator/rust/signals.rs

@@ -100,8 +100,8 @@ pub fn generate_rust_signal(
     } else {
         Some(quote! { unsafe })
     };
-    let doc_comments = &signal.docs;
-    let cfgs = &signal.cfgs;
+    let doc_comments = &signal.common_attrs.docs;
+    let cfgs = &signal.common_attrs.cfgs;
     let namespace = if let Some(namespace) = qobject_name.namespace() {
         quote_spanned! { span=> #[namespace = #namespace ] }
     } else {

crates/cxx-qt-gen/src/parser/externcxxqt.rs

@@ -11,17 +11,18 @@ use crate::{
     syntax::{attribute::attribute_get_path, expr::expr_to_string},
 };
 use syn::{
-    spanned::Spanned, Attribute, Error, ForeignItem, ForeignItemFn, Ident, ItemForeignMod, Result,
+    spanned::Spanned, Error, ForeignItem, ForeignItemFn, Ident, ItemForeignMod, Result,
     Token,
 };
+use crate::parser::CommonAttrs;
 
 /// Representation of an extern "C++Qt" block
 #[derive(Default)]
 pub struct ParsedExternCxxQt {
     /// The namespace of the type in C++.
     pub namespace: Option<String>,
-    /// The Top level docs on the module
-    pub docs: Vec<Attribute>,
+    /// All the universal top level attributes for the block
+    pub common_attrs: CommonAttrs,
     /// Whether this block has an unsafe token
     pub unsafety: Option<Token![unsafe]>,
     /// Items which can be passed into the extern "C++Qt" block
@@ -55,7 +56,7 @@ impl ParsedExternCxxQt {
 
         let mut extern_cxx_block = ParsedExternCxxQt {
             namespace,
-            docs: common_attrs.docs,
+            common_attrs,
             unsafety: foreign_mod.unsafety,
             ..Default::default()
         };

crates/cxx-qt-gen/src/parser/inherit.rs

@@ -3,20 +3,18 @@
 //
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use crate::parser::{method::MethodFields, require_attributes, CaseConversion};
+use crate::parser::{method::MethodFields, require_attributes, CaseConversion, CommonAttrs};
 use core::ops::Deref;
 use quote::format_ident;
 use std::ops::DerefMut;
-use syn::{Attribute, ForeignItemFn, Ident, Result};
+use syn::{ForeignItemFn, Ident, Result};
 
 /// Describes a method found in an extern "RustQt" with #[inherit]
 pub struct ParsedInheritedMethod {
     /// The common fields which are available on all callable types
     pub method_fields: MethodFields,
-    /// All the docs (each line) of the inherited method
-    pub docs: Vec<Attribute>,
-    /// Cfgs for the inherited method
-    pub cfgs: Vec<Attribute>,
+    /// All the universal attributes for the inherited method
+    pub common_attrs: CommonAttrs,
 }
 
 impl ParsedInheritedMethod {
@@ -34,8 +32,7 @@ impl ParsedInheritedMethod {
 
         Ok(Self {
             method_fields: MethodFields::parse(method, auto_case)?,
-            docs: common_attrs.docs,
-            cfgs: common_attrs.cfgs,
+            common_attrs
         })
     }
 

crates/cxx-qt-gen/src/parser/mod.rs

@@ -87,22 +87,24 @@ impl CaseConversion {
     }
 }
 
-/// Iterate the attributes of the method to extract cfg attributes
-pub fn extract_cfgs(attrs: &[Attribute]) -> Vec<Attribute> {
+/// Helper function to extract all of a particular attribute from the slice
+fn extract_attr(attrs: &[Attribute], target: &str) -> Vec<Attribute> {
     attrs
         .iter()
-        .filter(|attr| path_compare_str(attr.meta.path(), &["cfg"]))
+        .filter(|attr| path_compare_str(attr.meta.path(), &[target]))
         .cloned()
         .collect()
 }
 
+/// Iterate the attributes of the method to extract cfg attributes
+pub fn extract_cfgs(attrs: &[Attribute]) -> Vec<Attribute> {
+    extract_attr(attrs, "cfg")
+}
+
 /// Iterate the attributes of the method to extract Doc attributes (doc comments are parsed as this)
 pub fn extract_docs(attrs: &[Attribute]) -> Vec<Attribute> {
-    attrs
-        .iter()
-        .filter(|attr| path_compare_str(attr.meta.path(), &["doc"]))
-        .cloned()
-        .collect()
+    extract_attr(attrs, "doc")
+
 }
 
 /// Splits a path by :: separators e.g. "cxx_qt::bridge" becomes ["cxx_qt", "bridge"]
@@ -116,9 +118,10 @@ fn split_path(path_str: &str) -> Vec<&str> {
 }
 
 /// Attributes which should be passed through, and are available on most things
+#[derive(Clone, Debug, Default)]
 pub struct CommonAttrs {
-    docs: Vec<Attribute>,
-    cfgs: Vec<Attribute>,
+    pub docs: Vec<Attribute>,
+    pub cfgs: Vec<Attribute>,
 }
 
 /// Collects a Map of all attributes found from the allowed list

crates/cxx-qt-gen/src/parser/qenum.rs

@@ -3,10 +3,10 @@
 //
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use crate::parser::CaseConversion;
+use crate::parser::{CaseConversion, CommonAttrs};
 use crate::{naming::Name, parser::require_attributes, syntax::path::path_compare_str};
 use quote::ToTokens;
-use syn::{Attribute, Ident, ItemEnum, Result, Variant};
+use syn::{Ident, ItemEnum, Result, Variant};
 
 pub struct ParsedQEnum {
     /// The name of the QObject
@@ -17,10 +17,8 @@ pub struct ParsedQEnum {
     pub qobject: Option<Ident>,
     /// The original enum item
     pub item: ItemEnum,
-    /// Docs from the qenum
-    pub docs: Vec<Attribute>,
-    /// Cfgs from the qenum
-    pub cfgs: Vec<Attribute>,
+    /// All the universal attributes for the enum
+    pub common_attrs: CommonAttrs,
 }
 
 impl ParsedQEnum {
@@ -94,8 +92,7 @@ impl ParsedQEnum {
             name,
             qobject,
             variants,
-            docs: common_attrs.docs,
-            cfgs: common_attrs.cfgs,
+            common_attrs,
             item: qenum,
         })
     }

crates/cxx-qt-gen/src/parser/qobject.rs

@@ -11,6 +11,7 @@ use crate::{
 #[cfg(test)]
 use quote::format_ident;
 use syn::{Attribute, Error, Ident, Meta, Result};
+use crate::parser::CommonAttrs;
 
 /// Metadata for registering QML element
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
@@ -40,10 +41,8 @@ pub struct ParsedQObject {
     pub has_qobject_macro: bool,
     /// The original declaration entered by the user, i.e. a type alias with a list of attributes
     pub declaration: ForeignTypeIdentAlias,
-    /// Cfgs for the object
-    pub cfgs: Vec<Attribute>,
-    /// Docs for the object
-    pub docs: Vec<Attribute>,
+    /// All the universal attributes for the object
+    pub common_attrs: CommonAttrs,
 }
 
 impl ParsedQObject {
@@ -74,8 +73,10 @@ impl ParsedQObject {
                 ident_left: format_ident!("MyObject"),
                 ident_right: format_ident!("MyObjectRust"),
             },
-            cfgs: vec![],
-            docs: vec![],
+            common_attrs: CommonAttrs {
+                docs: vec![],
+                cfgs: vec![],
+            }
         }
     }
 
@@ -124,8 +125,7 @@ impl ParsedQObject {
             properties,
             qml_metadata,
             has_qobject_macro,
-            cfgs: common_attrs.cfgs,
-            docs: common_attrs.docs,
+            common_attrs
         })
     }
 

crates/cxx-qt-gen/src/parser/signals.rs

@@ -8,7 +8,8 @@ use crate::{
 };
 use core::ops::Deref;
 use std::ops::DerefMut;
-use syn::{spanned::Spanned, Attribute, Error, ForeignItemFn, Result, Visibility};
+use syn::{spanned::Spanned, Error, ForeignItemFn, Result, Visibility};
+use crate::parser::CommonAttrs;
 
 #[derive(Clone)]
 /// Describes an individual Signal
@@ -19,10 +20,8 @@ pub struct ParsedSignal {
     pub inherit: bool,
     /// Whether the signal is private
     pub private: bool,
-    /// All the doc attributes (each line) of the signal
-    pub docs: Vec<Attribute>,
-    /// Cfgs for signal
-    pub cfgs: Vec<Attribute>,
+    /// All the universal attributes for the signal
+    pub common_attrs: CommonAttrs,
 }
 
 impl ParsedSignal {
@@ -58,8 +57,7 @@ impl ParsedSignal {
             method_fields: fields,
             inherit,
             private,
-            docs: common_attrs.docs,
-            cfgs: common_attrs.cfgs,
+            common_attrs,
         })
     }
 }