1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
/* 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/. */
/// Alternative implementation for the `generate` command, that we plan to eventually replace the current default with.
///
/// Traditionally, users would invoke `uniffi-bindgen generate` to generate bindings for a single crate, passing it the UDL file, config file, etc.
///
/// library_mode is a new way to generate bindings for multiple crates at once.
/// Users pass the path to the build cdylib file and UniFFI figures everything out, leveraging `cargo_metadata`, the metadata UniFFI stores inside exported symbols in the dylib, etc.
///
/// This brings several advantages.:
/// - No more need to specify the dylib in the `uniffi.toml` file(s)
/// - UniFFI can figure out the dependencies based on the dylib exports and generate the sources for
/// all of them at once.
/// - UniFFI can figure out the package/module names for each crate, eliminating the external
/// package maps.
use crate::{
load_initial_config, macro_metadata, BindingGenerator, BindingsConfig, ComponentInterface,
Result,
};
use anyhow::{bail, Context};
use camino::Utf8Path;
use cargo_metadata::{MetadataCommand, Package};
use std::{
collections::{HashMap, HashSet},
fs,
};
use uniffi_meta::{
create_metadata_groups, fixup_external_type, group_metadata, Metadata, MetadataGroup,
};
/// Generate foreign bindings
///
/// Returns the list of sources used to generate the bindings, in no particular order.
pub fn generate_bindings<T: BindingGenerator + ?Sized>(
library_path: &Utf8Path,
crate_name: Option<String>,
binding_generator: &T,
config_file_override: Option<&Utf8Path>,
out_dir: &Utf8Path,
try_format_code: bool,
) -> Result<Vec<Source<T::Config>>> {
generate_external_bindings(
binding_generator,
library_path,
crate_name.clone(),
config_file_override,
out_dir,
try_format_code,
)
}
/// Generate foreign bindings
///
/// Returns the list of sources used to generate the bindings, in no particular order.
pub fn generate_external_bindings<T: BindingGenerator>(
binding_generator: &T,
library_path: &Utf8Path,
crate_name: Option<String>,
config_file_override: Option<&Utf8Path>,
out_dir: &Utf8Path,
try_format_code: bool,
) -> Result<Vec<Source<T::Config>>> {
let cargo_metadata = MetadataCommand::new()
.exec()
.context("error running cargo metadata")?;
let cdylib_name = calc_cdylib_name(library_path);
binding_generator.check_library_path(library_path, cdylib_name)?;
let mut sources = find_sources(
&cargo_metadata,
library_path,
cdylib_name,
config_file_override,
)?;
for i in 0..sources.len() {
// Partition up the sources list because we're eventually going to call
// `update_from_dependency_configs()` which requires an exclusive reference to one source and
// shared references to all other sources.
let (sources_before, rest) = sources.split_at_mut(i);
let (source, sources_after) = rest.split_first_mut().unwrap();
let other_sources = sources_before.iter().chain(sources_after.iter());
// Calculate which configs come from dependent crates
let dependencies =
HashSet::<&str>::from_iter(source.package.dependencies.iter().map(|d| d.name.as_str()));
let config_map: HashMap<&str, &T::Config> = other_sources
.filter_map(|s| {
dependencies
.contains(s.package.name.as_str())
.then_some((s.crate_name.as_str(), &s.config))
})
.collect();
// We can finally call update_from_dependency_configs
source.config.update_from_dependency_configs(config_map);
}
fs::create_dir_all(out_dir)?;
if let Some(crate_name) = &crate_name {
let old_elements = sources.drain(..);
let mut matches: Vec<_> = old_elements
.filter(|s| &s.crate_name == crate_name)
.collect();
match matches.len() {
0 => bail!("Crate {crate_name} not found in {library_path}"),
1 => sources.push(matches.pop().unwrap()),
n => bail!("{n} crates named {crate_name} found in {library_path}"),
}
}
for source in sources.iter() {
binding_generator.write_bindings(&source.ci, &source.config, out_dir, try_format_code)?;
}
Ok(sources)
}
// A single source that we generate bindings for
#[derive(Debug)]
pub struct Source<Config: BindingsConfig> {
pub package: Package,
pub crate_name: String,
pub ci: ComponentInterface,
pub config: Config,
}
// If `library_path` is a C dynamic library, return its name
pub fn calc_cdylib_name(library_path: &Utf8Path) -> Option<&str> {
let cdylib_extensions = [".so", ".dll", ".dylib"];
let filename = library_path.file_name()?;
let filename = filename.strip_prefix("lib").unwrap_or(filename);
for ext in cdylib_extensions {
if let Some(f) = filename.strip_suffix(ext) {
return Some(f);
}
}
None
}
fn find_sources<Config: BindingsConfig>(
cargo_metadata: &cargo_metadata::Metadata,
library_path: &Utf8Path,
cdylib_name: Option<&str>,
config_file_override: Option<&Utf8Path>,
) -> Result<Vec<Source<Config>>> {
let items = macro_metadata::extract_from_library(library_path)?;
let mut metadata_groups = create_metadata_groups(&items);
group_metadata(&mut metadata_groups, items)?;
// Collect and process all UDL from all groups at the start - the fixups
// of external types makes this tricky to do as we finalize the group.
let mut udl_items: HashMap<String, MetadataGroup> = HashMap::new();
for group in metadata_groups.values() {
let package = find_package_by_crate_name(cargo_metadata, &group.namespace.crate_name)?;
let crate_root = package
.manifest_path
.parent()
.context("manifest path has no parent")?;
let crate_name = group.namespace.crate_name.clone();
if let Some(mut metadata_group) = load_udl_metadata(group, crate_root, &crate_name)? {
// fixup the items.
metadata_group.items = metadata_group
.items
.into_iter()
.map(|item| fixup_external_type(item, &metadata_groups))
// some items are both in UDL and library metadata. For many that's fine but
// uniffi-traits aren't trivial to compare meaning we end up with dupes.
// We filter out such problematic items here.
.filter(|item| !matches!(item, Metadata::UniffiTrait { .. }))
.collect();
udl_items.insert(crate_name, metadata_group);
};
}
metadata_groups
.into_values()
.map(|group| {
let package = find_package_by_crate_name(cargo_metadata, &group.namespace.crate_name)?;
let crate_root = package
.manifest_path
.parent()
.context("manifest path has no parent")?;
let crate_name = group.namespace.crate_name.clone();
let mut ci = ComponentInterface::new(&crate_name);
if let Some(metadata) = udl_items.remove(&crate_name) {
ci.add_metadata(metadata)?;
};
ci.add_metadata(group)?;
let mut config = load_initial_config::<Config>(crate_root, config_file_override)?;
if let Some(cdylib_name) = cdylib_name {
config.update_from_cdylib_name(cdylib_name);
}
config.update_from_ci(&ci);
Ok(Source {
config,
crate_name,
ci,
package,
})
})
.collect()
}
fn find_package_by_crate_name(
metadata: &cargo_metadata::Metadata,
crate_name: &str,
) -> Result<Package> {
let matching: Vec<&Package> = metadata
.packages
.iter()
.filter(|p| {
p.targets
.iter()
.any(|t| t.name.replace('-', "_") == crate_name)
})
.collect();
match matching.len() {
1 => Ok(matching[0].clone()),
n => bail!("cargo metadata returned {n} packages for crate name {crate_name}"),
}
}
fn load_udl_metadata(
group: &MetadataGroup,
crate_root: &Utf8Path,
crate_name: &str,
) -> Result<Option<MetadataGroup>> {
let udl_items = group
.items
.iter()
.filter_map(|i| match i {
uniffi_meta::Metadata::UdlFile(meta) => Some(meta),
_ => None,
})
.collect::<Vec<_>>();
match udl_items.len() {
// No UDL files, load directly from the group
0 => Ok(None),
// Found a UDL file, use it to load the CI, then add the MetadataGroup
1 => {
if udl_items[0].module_path != crate_name {
bail!(
"UDL is for crate '{}' but this crate name is '{}'",
udl_items[0].module_path,
crate_name
);
}
let ci_name = &udl_items[0].file_stub;
let ci_path = crate_root.join("src").join(format!("{ci_name}.udl"));
if ci_path.exists() {
let udl = fs::read_to_string(ci_path)?;
let udl_group = uniffi_udl::parse_udl(&udl, crate_name)?;
Ok(Some(udl_group))
} else {
bail!("{ci_path} not found");
}
}
n => bail!("{n} UDL files found for {crate_root}"),
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn calc_cdylib_name_is_correct() {
assert_eq!(
"uniffi",
calc_cdylib_name("/path/to/libuniffi.so".into()).unwrap()
);
assert_eq!(
"uniffi",
calc_cdylib_name("/path/to/libuniffi.dylib".into()).unwrap()
);
assert_eq!(
"uniffi",
calc_cdylib_name("/path/to/uniffi.dll".into()).unwrap()
);
}
/// Right now we unconditionally strip the `lib` prefix.
///
/// Technically Windows DLLs do not start with a `lib` prefix,
/// but a library name could start with a `lib` prefix.
/// On Linux/macOS this would result in a `liblibuniffi.{so,dylib}` file.
#[test]
#[ignore] // Currently fails.
fn calc_cdylib_name_is_correct_on_windows() {
assert_eq!(
"libuniffi",
calc_cdylib_name("/path/to/libuniffi.dll".into()).unwrap()
);
}
}
|