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
|
/* 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/. */
//! Manage the universe of ComponentInterfaces / Configs
//!
//! uniffi-bindgen-gecko-js is unique because it generates bindings over a set of UDL files rather
//! than just one. This is because we want to generate the WebIDL statically rather than generate
//! it. To accomplish that, each WebIDL function inputs an opaque integer id that identifies which
//! version of it should run, for example `CallSync` inputs a function id. Operating on all UDL
//! files at once simplifies the task of ensuring those ids are to be unique and consistent between
//! the JS and c++ code.
//!
//! This module manages the list of ComponentInterface and the object ids.
use crate::render::cpp::ComponentInterfaceCppExt;
use crate::{Config, ConfigMap};
use anyhow::{bail, Context, Result};
use camino::Utf8PathBuf;
use std::collections::{BTreeSet, HashMap, HashSet};
use uniffi_bindgen::interface::{CallbackInterface, ComponentInterface, FfiFunction, Object};
pub struct ComponentUniverse {
pub components: Vec<(ComponentInterface, Config)>,
pub fixture_components: Vec<(ComponentInterface, Config)>,
}
impl ComponentUniverse {
pub fn new(config_map: ConfigMap) -> Result<Self> {
let universe = Self {
components: parse_udl_files(&config_map, false)?,
fixture_components: parse_udl_files(&config_map, true)?,
};
universe.check_udl_namespaces_unique()?;
universe.check_callback_interfaces()?;
Ok(universe)
}
fn check_udl_namespaces_unique(&self) -> Result<()> {
let mut set = HashSet::new();
for ci in self.iter_cis() {
if !set.insert(ci.namespace()) {
bail!("UDL files have duplicate namespace: {}", ci.namespace());
}
}
Ok(())
}
fn check_callback_interfaces(&self) -> Result<()> {
// We don't currently support callback interfaces returning values or throwing errors.
for ci in self.iter_cis() {
for cbi in ci.callback_interface_definitions() {
for method in cbi.methods() {
if method.return_type().is_some() {
bail!("Callback interface method {}.{} throws an error, which is not yet supported", cbi.name(), method.name())
}
if method.throws_type().is_some() {
bail!("Callback interface method {}.{} returns a value, which is not yet supported", cbi.name(), method.name())
}
}
}
}
Ok(())
}
pub fn iter_cis(&self) -> impl Iterator<Item = &ComponentInterface> {
self.components
.iter()
.chain(self.fixture_components.iter())
.map(|(ci, _)| ci)
}
}
fn parse_udl_files(
config_map: &ConfigMap,
fixture: bool,
) -> Result<Vec<(ComponentInterface, Config)>> {
// Sort config entries to ensure consistent output
let mut entries: Vec<_> = config_map.iter().collect();
entries.sort_by_key(|(key, _)| *key);
entries
.into_iter()
.filter_map(|(_, config)| {
if config.fixture == fixture {
Some(parse_udl_file(&config).map(|ci| (ci, config.clone())))
} else {
None
}
})
.collect()
}
fn parse_udl_file(config: &Config) -> Result<ComponentInterface> {
let udl_file = Utf8PathBuf::from(&config.udl_file);
let udl = std::fs::read_to_string(udl_file)
.context(format!("Error reading UDL file '{}'", config.udl_file))?;
ComponentInterface::from_webidl(&udl, &config.crate_name)
.context(format!("Failed to parse UDL '{}'", config.udl_file))
}
pub struct FunctionIds<'a> {
// Map (CI namespace, func name) -> Ids
map: HashMap<(&'a str, &'a str), usize>,
}
impl<'a> FunctionIds<'a> {
pub fn new(cis: &'a ComponentUniverse) -> Self {
Self {
map: cis
.iter_cis()
.flat_map(|ci| {
ci.exposed_functions()
.into_iter()
.map(move |f| (ci.namespace(), f.name()))
})
.enumerate()
.map(|(i, (namespace, name))| ((namespace, name), i))
// Sort using BTreeSet to guarantee the IDs remain stable across runs
.collect::<BTreeSet<_>>()
.into_iter()
.collect(),
}
}
pub fn get(&self, ci: &ComponentInterface, func: &FfiFunction) -> usize {
return *self.map.get(&(ci.namespace(), func.name())).unwrap();
}
pub fn name(&self, ci: &ComponentInterface, func: &FfiFunction) -> String {
format!("{}:{}", ci.namespace(), func.name())
}
}
pub struct ObjectIds<'a> {
// Map (CI namespace, object name) -> Ids
map: HashMap<(&'a str, &'a str), usize>,
}
impl<'a> ObjectIds<'a> {
pub fn new(cis: &'a ComponentUniverse) -> Self {
Self {
map: cis
.iter_cis()
.flat_map(|ci| {
ci.object_definitions()
.iter()
.map(move |o| (ci.namespace(), o.name()))
})
.enumerate()
.map(|(i, (namespace, name))| ((namespace, name), i))
// Sort using BTreeSet to guarantee the IDs remain stable across runs
.collect::<BTreeSet<_>>()
.into_iter()
.collect(),
}
}
pub fn get(&self, ci: &ComponentInterface, obj: &Object) -> usize {
return *self.map.get(&(ci.namespace(), obj.name())).unwrap();
}
pub fn name(&self, ci: &ComponentInterface, obj: &Object) -> String {
format!("{}:{}", ci.namespace(), obj.name())
}
}
pub struct CallbackIds<'a> {
// Map (CI namespace, callback name) -> Ids
map: HashMap<(&'a str, &'a str), usize>,
}
impl<'a> CallbackIds<'a> {
pub fn new(cis: &'a ComponentUniverse) -> Self {
Self {
map: cis
.iter_cis()
.flat_map(|ci| {
ci.callback_interface_definitions()
.iter()
.map(move |cb| (ci.namespace(), cb.name()))
})
.enumerate()
.map(|(i, (namespace, name))| ((namespace, name), i))
// Sort using BTreeSet to guarantee the IDs remain stable across runs
.collect::<BTreeSet<_>>()
.into_iter()
.collect(),
}
}
pub fn get(&self, ci: &ComponentInterface, cb: &CallbackInterface) -> usize {
return *self.map.get(&(ci.namespace(), cb.name())).unwrap();
}
pub fn name(&self, ci: &ComponentInterface, cb: &CallbackInterface) -> String {
format!("{}:{}", ci.namespace(), cb.name())
}
}
|
