summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poveda <christian.poveda@ferrous-systems.com>2022-09-23 15:20:56 -0500
committerChristian Poveda <christian.poveda@ferrous-systems.com>2022-09-23 15:20:56 -0500
commite1f314eb44b09268c6d05ff152f3ddd61e635135 (patch)
treed5f4c08ec1e99eef3bf739ed1019ccfd6ad44943
parent6de2d3d1c17bb4dd432daabf2cd858254663f49e (diff)
move codegen postprocessing to its own module
-rw-r--r--src/codegen/mod.rs5
-rw-r--r--src/codegen/postprocessing.rs148
-rw-r--r--src/lib.rs113
3 files changed, 152 insertions, 114 deletions
diff --git a/src/codegen/mod.rs b/src/codegen/mod.rs
index 843d5111..bc2c9fe2 100644
--- a/src/codegen/mod.rs
+++ b/src/codegen/mod.rs
@@ -3,6 +3,7 @@ mod error;
mod helpers;
mod impl_debug;
mod impl_partialeq;
+mod postprocessing;
pub mod struct_layout;
#[cfg(test)]
@@ -4414,7 +4415,7 @@ impl CodeGenerator for ObjCInterface {
pub(crate) fn codegen(
context: BindgenContext,
-) -> (Vec<proc_macro2::TokenStream>, BindgenOptions, Vec<String>) {
+) -> (proc_macro2::TokenStream, BindgenOptions, Vec<String>) {
context.gen(|context| {
let _t = context.timer("codegen");
let counter = Cell::new(0);
@@ -4464,7 +4465,7 @@ pub(crate) fn codegen(
result.push(dynamic_items_tokens);
}
- result.items
+ postprocessing::postprocessing(result.items, context.options())
})
}
diff --git a/src/codegen/postprocessing.rs b/src/codegen/postprocessing.rs
new file mode 100644
index 00000000..72832298
--- /dev/null
+++ b/src/codegen/postprocessing.rs
@@ -0,0 +1,148 @@
+use proc_macro2::TokenStream;
+use quote::ToTokens;
+use syn::Item;
+
+use crate::BindgenOptions;
+
+macro_rules! decl_postprocessing {
+ ($($ty:ty),*) => {
+ pub(crate) fn postprocessing(
+ items: Vec<TokenStream>,
+ options: &BindgenOptions,
+ ) -> TokenStream {
+ // Whether any of the enabled options requires `syn`.
+ let require_syn = $(<$ty as PostProcessing>::should_run(options))||*;
+
+ if !require_syn {
+ return items.into_iter().collect();
+ }
+
+ let module_wrapped_tokens =
+ quote!(mod wrapper_for_sorting_hack { #( #items )* });
+
+ // This syn business is a hack, for now. This means that we are re-parsing already
+ // generated code using `syn` (as opposed to `quote`) because `syn` provides us more
+ // control over the elements.
+ // One caveat is that some of the items coming from `quote`d output might have
+ // multiple items within them. Hence, we have to wrap the incoming in a `mod`.
+ // The two `unwrap`s here are deliberate because
+ // The first one won't panic because we build the `mod` and know it is there
+ // The second one won't panic because we know original output has something in
+ // it already.
+ let mut items =
+ syn::parse2::<syn::ItemMod>(module_wrapped_tokens)
+ .unwrap()
+ .content
+ .unwrap()
+ .1;
+
+ $(if <$ty as PostProcessing>::should_run(options) {
+ <$ty as PostProcessing>::run(&mut items);
+ })*
+
+ let synful_items = items
+ .into_iter()
+ .map(|item| item.into_token_stream());
+
+ quote! { #( #synful_items )* }
+ }
+ };
+}
+
+decl_postprocessing! {
+ MergeExternBlocks,
+ SortSemantically
+}
+
+trait PostProcessing {
+ fn should_run(options: &BindgenOptions) -> bool;
+
+ fn run(items: &mut Vec<Item>);
+}
+
+struct SortSemantically;
+
+impl PostProcessing for SortSemantically {
+ #[inline]
+ fn should_run(options: &BindgenOptions) -> bool {
+ options.sort_semantically
+ }
+
+ fn run(items: &mut Vec<Item>) {
+ items.sort_by_key(|item| match item {
+ Item::Type(_) => 0,
+ Item::Struct(_) => 1,
+ Item::Const(_) => 2,
+ Item::Fn(_) => 3,
+ Item::Enum(_) => 4,
+ Item::Union(_) => 5,
+ Item::Static(_) => 6,
+ Item::Trait(_) => 7,
+ Item::TraitAlias(_) => 8,
+ Item::Impl(_) => 9,
+ Item::Mod(_) => 10,
+ Item::Use(_) => 11,
+ Item::Verbatim(_) => 12,
+ Item::ExternCrate(_) => 13,
+ Item::ForeignMod(_) => 14,
+ Item::Macro(_) => 15,
+ Item::Macro2(_) => 16,
+ _ => 18,
+ });
+ }
+}
+
+struct MergeExternBlocks;
+
+impl PostProcessing for MergeExternBlocks {
+ #[inline]
+ fn should_run(options: &BindgenOptions) -> bool {
+ options.merge_extern_blocks
+ }
+
+ fn run(items: &mut Vec<Item>) {
+ // Keep all the extern blocks in a different `Vec` for faster search.
+ let mut foreign_mods = Vec::<syn::ItemForeignMod>::new();
+
+ for item in std::mem::take(items) {
+ match item {
+ Item::ForeignMod(syn::ItemForeignMod {
+ attrs,
+ abi,
+ brace_token,
+ items: foreign_items,
+ }) => {
+ let mut exists = false;
+ for foreign_mod in &mut foreign_mods {
+ // Check if there is a extern block with the same ABI and
+ // attributes.
+ if foreign_mod.attrs == attrs && foreign_mod.abi == abi
+ {
+ // Merge the items of the two blocks.
+ foreign_mod.items.extend_from_slice(&foreign_items);
+ exists = true;
+ break;
+ }
+ }
+ // If no existing extern block had the same ABI and attributes, store
+ // it.
+ if !exists {
+ foreign_mods.push(syn::ItemForeignMod {
+ attrs,
+ abi,
+ brace_token,
+ items: foreign_items,
+ });
+ }
+ }
+ // If the item is not an extern block, we don't have to do anything.
+ _ => items.push(item),
+ }
+ }
+
+ // Move all the extern blocks alongiside the rest of the items.
+ for foreign_mod in foreign_mods {
+ items.push(Item::ForeignMod(foreign_mod));
+ }
+ }
+}
diff --git a/src/lib.rs b/src/lib.rs
index 3c89368f..d0be8604 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -88,7 +88,6 @@ use std::{env, iter};
// Some convenient typedefs for a fast hash map and hash set.
type HashMap<K, V> = ::rustc_hash::FxHashMap<K, V>;
type HashSet<K> = ::rustc_hash::FxHashSet<K>;
-use quote::ToTokens;
pub(crate) use std::collections::hash_map::Entry;
/// Default prefix for the anon fields.
@@ -2118,11 +2117,6 @@ struct BindgenOptions {
impl ::std::panic::UnwindSafe for BindgenOptions {}
impl BindgenOptions {
- /// Whether any of the enabled options requires `syn`.
- fn require_syn(&self) -> bool {
- self.sort_semantically || self.merge_extern_blocks
- }
-
fn build(&mut self) {
let mut regex_sets = [
&mut self.allowlisted_vars,
@@ -2555,112 +2549,7 @@ impl Bindings {
parse(&mut context)?;
}
- let (items, options, warnings) = codegen::codegen(context);
-
- let module = if options.require_syn() {
- let module_wrapped_tokens =
- quote!(mod wrapper_for_sorting_hack { #( #items )* });
-
- // This syn business is a hack, for now. This means that we are re-parsing already
- // generated code using `syn` (as opposed to `quote`) because `syn` provides us more
- // control over the elements.
- // One caveat is that some of the items coming from `quote`d output might have
- // multiple items within them. Hence, we have to wrap the incoming in a `mod`.
- // The two `unwrap`s here are deliberate because
- // The first one won't panic because we build the `mod` and know it is there
- // The second one won't panic because we know original output has something in
- // it already.
- let mut syn_parsed_items =
- syn::parse2::<syn::ItemMod>(module_wrapped_tokens)
- .unwrap()
- .content
- .unwrap()
- .1;
-
- if options.merge_extern_blocks {
- // Here we will store all the items after deduplication.
- let mut items = Vec::new();
-
- // Keep all the extern blocks in a different `Vec` for faster search.
- let mut foreign_mods = Vec::<syn::ItemForeignMod>::new();
- for item in syn_parsed_items {
- match item {
- syn::Item::ForeignMod(syn::ItemForeignMod {
- attrs,
- abi,
- brace_token,
- items: foreign_items,
- }) => {
- let mut exists = false;
- for foreign_mod in &mut foreign_mods {
- // Check if there is a extern block with the same ABI and
- // attributes.
- if foreign_mod.attrs == attrs &&
- foreign_mod.abi == abi
- {
- // Merge the items of the two blocks.
- foreign_mod
- .items
- .extend_from_slice(&foreign_items);
- exists = true;
- break;
- }
- }
- // If no existing extern block had the same ABI and attributes, store
- // it.
- if !exists {
- foreign_mods.push(syn::ItemForeignMod {
- attrs,
- abi,
- brace_token,
- items: foreign_items,
- });
- }
- }
- // If the item is not an extern block, we don't have to do anything.
- _ => items.push(item),
- }
- }
-
- // Move all the extern blocks alongiside the rest of the items.
- for foreign_mod in foreign_mods {
- items.push(syn::Item::ForeignMod(foreign_mod));
- }
-
- syn_parsed_items = items;
- }
-
- if options.sort_semantically {
- syn_parsed_items.sort_by_key(|item| match item {
- syn::Item::Type(_) => 0,
- syn::Item::Struct(_) => 1,
- syn::Item::Const(_) => 2,
- syn::Item::Fn(_) => 3,
- syn::Item::Enum(_) => 4,
- syn::Item::Union(_) => 5,
- syn::Item::Static(_) => 6,
- syn::Item::Trait(_) => 7,
- syn::Item::TraitAlias(_) => 8,
- syn::Item::Impl(_) => 9,
- syn::Item::Mod(_) => 10,
- syn::Item::Use(_) => 11,
- syn::Item::Verbatim(_) => 12,
- syn::Item::ExternCrate(_) => 13,
- syn::Item::ForeignMod(_) => 14,
- syn::Item::Macro(_) => 15,
- syn::Item::Macro2(_) => 16,
- _ => 18,
- });
- }
-
- let synful_items = syn_parsed_items
- .into_iter()
- .map(|item| item.into_token_stream());
-
- quote! { #( #synful_items )* }
- } else {
- quote! { #( #items )* }
- };
+ let (module, options, warnings) = codegen::codegen(context);
Ok(Bindings {
options,