/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ use std::io::Write; use syn::ext::IdentExt; use crate::bindgen::config::{Config, Language, LayoutConfig}; use crate::bindgen::declarationtyperesolver::DeclarationTypeResolver; use crate::bindgen::dependencies::Dependencies; use crate::bindgen::ir::{ AnnotationSet, Cfg, ConditionWrite, Documentation, Field, GenericArgument, GenericParams, Item, ItemContainer, Path, Repr, ReprAlign, ReprStyle, ToCondition, }; use crate::bindgen::library::Library; use crate::bindgen::mangle; use crate::bindgen::monomorph::Monomorphs; use crate::bindgen::rename::{IdentifierType, RenameRule}; use crate::bindgen::utilities::IterHelpers; use crate::bindgen::writer::{ListType, Source, SourceWriter}; #[derive(Debug, Clone)] pub struct Union { pub path: Path, pub export_name: String, pub generic_params: GenericParams, pub fields: Vec, pub tuple_union: bool, pub alignment: Option, pub cfg: Option, pub annotations: AnnotationSet, pub documentation: Documentation, } impl Union { pub fn load( layout_config: &LayoutConfig, item: &syn::ItemUnion, mod_cfg: Option<&Cfg>, ) -> Result { let repr = Repr::load(&item.attrs)?; if repr.style != ReprStyle::C { return Err("Union is not marked #[repr(C)].".to_owned()); } // Ensure we can safely represent the union given the configuration. if let Some(align) = repr.align { layout_config.ensure_safe_to_represent(&align)?; } let path = Path::new(item.ident.unraw().to_string()); let (fields, tuple_union) = { let out = item .fields .named .iter() .try_skip_map(|field| Field::load(field, &path))?; (out, false) }; Ok(Union::new( path, GenericParams::load(&item.generics)?, fields, repr.align, tuple_union, Cfg::append(mod_cfg, Cfg::load(&item.attrs)), AnnotationSet::load(&item.attrs)?, Documentation::load(&item.attrs), )) } #[allow(clippy::too_many_arguments)] pub fn new( path: Path, generic_params: GenericParams, fields: Vec, alignment: Option, tuple_union: bool, cfg: Option, annotations: AnnotationSet, documentation: Documentation, ) -> Self { let export_name = path.name().to_owned(); Self { path, export_name, generic_params, fields, tuple_union, alignment, cfg, annotations, documentation, } } pub fn simplify_standard_types(&mut self, config: &Config) { for field in &mut self.fields { field.ty.simplify_standard_types(config); } } pub fn is_generic(&self) -> bool { self.generic_params.len() > 0 } pub fn add_monomorphs(&self, library: &Library, out: &mut Monomorphs) { // Generic unions can instantiate monomorphs only once they've been // instantiated. See `instantiate_monomorph` for more details. if self.is_generic() { return; } for field in &self.fields { field.ty.add_monomorphs(library, out); } } pub fn mangle_paths(&mut self, monomorphs: &Monomorphs) { for field in &mut self.fields { field.ty.mangle_paths(monomorphs); } } } impl Item for Union { fn path(&self) -> &Path { &self.path } fn export_name(&self) -> &str { &self.export_name } fn cfg(&self) -> Option<&Cfg> { self.cfg.as_ref() } fn annotations(&self) -> &AnnotationSet { &self.annotations } fn annotations_mut(&mut self) -> &mut AnnotationSet { &mut self.annotations } fn container(&self) -> ItemContainer { ItemContainer::Union(self.clone()) } fn collect_declaration_types(&self, resolver: &mut DeclarationTypeResolver) { resolver.add_union(&self.path); } fn resolve_declaration_types(&mut self, resolver: &DeclarationTypeResolver) { for field in &mut self.fields { field.ty.resolve_declaration_types(resolver); } } fn rename_for_config(&mut self, config: &Config) { config.export.rename(&mut self.export_name); for field in &mut self.fields { field.ty.rename_for_config(config, &self.generic_params); } let rules = self .annotations .parse_atom::("rename-all") .unwrap_or(config.structure.rename_fields); if let Some(o) = self.annotations.list("field-names") { let mut overriden_fields = Vec::new(); for (i, field) in self.fields.iter().enumerate() { if i >= o.len() { overriden_fields.push(field.clone()); } else { overriden_fields.push(Field { name: o[i].clone(), ty: field.ty.clone(), cfg: field.cfg.clone(), annotations: field.annotations.clone(), documentation: field.documentation.clone(), }); } } self.fields = overriden_fields; } else if let Some(r) = rules.not_none() { self.fields = self .fields .iter() .map(|field| Field { name: r .apply(&field.name, IdentifierType::StructMember) .into_owned(), ty: field.ty.clone(), cfg: field.cfg.clone(), annotations: field.annotations.clone(), documentation: field.documentation.clone(), }) .collect(); } else if self.tuple_union { // If we don't have any rules for a tuple union, prefix them with // an underscore so it still compiles for field in &mut self.fields { field.name.insert(0, '_'); } } } fn add_dependencies(&self, library: &Library, out: &mut Dependencies) { for field in &self.fields { field .ty .add_dependencies_ignoring_generics(&self.generic_params, library, out); } } fn instantiate_monomorph( &self, generic_values: &[GenericArgument], library: &Library, out: &mut Monomorphs, ) { let mappings = self.generic_params.call(self.path.name(), generic_values); let mangled_path = mangle::mangle_path( &self.path, generic_values, &library.get_config().export.mangle, ); let monomorph = Union::new( mangled_path, GenericParams::default(), self.fields .iter() .map(|field| Field { name: field.name.clone(), ty: field.ty.specialize(&mappings), cfg: field.cfg.clone(), annotations: field.annotations.clone(), documentation: field.documentation.clone(), }) .collect(), self.alignment, self.tuple_union, self.cfg.clone(), self.annotations.clone(), self.documentation.clone(), ); out.insert_union(library, self, monomorph, generic_values.to_owned()); } } impl Source for Union { fn write(&self, config: &Config, out: &mut SourceWriter) { let condition = self.cfg.to_condition(config); condition.write_before(config, out); self.documentation.write(config, out); self.generic_params.write(config, out); // The following results in // C++ or C with Tag as style: // union Name { // C with Type only style: // typedef union { // C with Both as style: // typedef union Name { match config.language { Language::C if config.style.generate_typedef() => out.write("typedef "), Language::C | Language::Cxx => {} Language::Cython => out.write(config.style.cython_def()), } out.write("union"); // Cython supports `packed` on structs (see comments there), but not on unions. if config.language != Language::Cython { if let Some(align) = self.alignment { match align { ReprAlign::Packed => { if let Some(ref anno) = config.layout.packed { write!(out, " {}", anno); } } ReprAlign::Align(n) => { if let Some(ref anno) = config.layout.aligned_n { write!(out, " {}({})", anno, n); } } } } } if config.language != Language::C || config.style.generate_tag() { write!(out, " {}", self.export_name); } out.open_brace(); // Emit the pre_body section, if relevant if let Some(body) = config.export.pre_body(&self.path) { out.write_raw_block(body); out.new_line(); } out.write_vertical_source_list(&self.fields, ListType::Cap(";")); if config.language == Language::Cython && self.fields.is_empty() { out.write("pass"); } // Emit the post_body section, if relevant if let Some(body) = config.export.post_body(&self.path) { out.new_line(); out.write_raw_block(body); } if config.language == Language::C && config.style.generate_typedef() { out.close_brace(false); write!(out, " {};", self.export_name); } else { out.close_brace(true); } condition.write_after(config, out); } }