use crate::interface::InterfaceGenerator;
use anyhow::{bail, Result};
use heck::*;
use std::collections::{BTreeMap, HashMap, HashSet};
use std::fmt::{self, Write as _};
use std::io::{Read, Write};
use std::mem;
use std::process::{Command, Stdio};
use std::str::FromStr;
use wit_bindgen_core::abi::{Bitcast, WasmType};
use wit_bindgen_core::{
uwrite, uwriteln, wit_parser::*, Files, InterfaceGenerator as _, Source, Types, WorldGenerator,
};
mod bindgen;
mod interface;
struct InterfaceName {
remapped: bool,
path: String,
}
#[derive(Default)]
struct RustWasm {
types: Types,
src: Source,
opts: Opts,
import_modules: Vec<(String, Vec<String>)>,
export_modules: Vec<(String, Vec<String>)>,
skip: HashSet<String>,
interface_names: HashMap<InterfaceId, InterfaceName>,
interface_last_seen_as_import: HashMap<InterfaceId, bool>,
import_funcs_called: bool,
with_name_counter: usize,
used_with_opts: HashSet<String>,
world: Option<WorldId>,
}
#[cfg(feature = "clap")]
fn iterate_hashmap_string(s: &str) -> impl Iterator<Item = Result<(&str, &str), String>> {
s.split(',').map(move |entry| {
entry.split_once('=').ok_or_else(|| {
format!("expected string of form `<key>=<value>[,<key>=<value>...]`; got `{s}`")
})
})
}
#[cfg(feature = "clap")]
fn parse_exports(s: &str) -> Result<HashMap<ExportKey, String>, String> {
if s.is_empty() {
Ok(HashMap::default())
} else {
iterate_hashmap_string(s)
.map(|entry| {
let (key, value) = entry?;
Ok((
match key {
"world" => ExportKey::World,
_ => ExportKey::Name(key.to_owned()),
},
value.to_owned(),
))
})
.collect()
}
}
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum ExportKey {
World,
Name(String),
}
#[cfg(feature = "clap")]
fn parse_with(s: &str) -> Result<HashMap<String, String>, String> {
if s.is_empty() {
Ok(HashMap::default())
} else {
iterate_hashmap_string(s)
.map(|entry| {
let (key, value) = entry?;
Ok((key.to_owned(), value.to_owned()))
})
.collect()
}
}
#[derive(Default, Debug, Clone)]
#[cfg_attr(feature = "clap", derive(clap::Args))]
pub struct Opts {
#[cfg_attr(feature = "clap", arg(long))]
pub rustfmt: bool,
#[cfg_attr(feature = "clap", arg(long))]
pub std_feature: bool,
#[cfg_attr(feature = "clap", arg(long))]
pub raw_strings: bool,
#[cfg_attr(feature = "clap", arg(long))]
pub skip: Vec<String>,
#[cfg_attr(feature = "clap", arg(long, value_parser = parse_exports, default_value = ""))]
pub exports: HashMap<ExportKey, String>,
#[cfg_attr(feature = "clap", arg(long))]
pub stubs: bool,
#[cfg_attr(feature = "clap", arg(long))]
pub export_prefix: Option<String>,
#[cfg_attr(feature = "clap", arg(long, default_value_t = Ownership::Owning))]
pub ownership: Ownership,
#[cfg_attr(feature = "clap", arg(long))]
pub runtime_path: Option<String>,
#[cfg_attr(feature = "clap", arg(long))]
pub bitflags_path: Option<String>,
#[cfg_attr(feature = "clap", arg(long = "additional_derive_attribute", short = 'd', default_values_t = Vec::<String>::new()))]
pub additional_derive_attributes: Vec<String>,
#[cfg_attr(feature = "clap", arg(long, value_parser = parse_with, default_value = ""))]
pub with: HashMap<String, String>,
#[cfg_attr(feature = "clap", arg(long))]
pub type_section_suffix: Option<String>,
}
impl Opts {
pub fn build(self) -> Box<dyn WorldGenerator> {
let mut r = RustWasm::new();
r.skip = self.skip.iter().cloned().collect();
r.opts = self;
Box::new(r)
}
}
impl RustWasm {
fn new() -> RustWasm {
RustWasm::default()
}
fn interface<'a>(
&'a mut self,
identifier: Identifier<'a>,
wasm_import_module: Option<&'a str>,
resolve: &'a Resolve,
in_import: bool,
) -> InterfaceGenerator<'a> {
let mut sizes = SizeAlign::default();
sizes.fill(resolve);
InterfaceGenerator {
identifier,
wasm_import_module,
src: Source::default(),
in_import,
gen: self,
sizes,
resolve,
return_pointer_area_size: 0,
return_pointer_area_align: 0,
}
}
fn emit_modules(&mut self, modules: Vec<(String, Vec<String>)>) {
#[derive(Default)]
struct Module {
submodules: BTreeMap<String, Module>,
contents: Vec<String>,
}
let mut map = Module::default();
for (module, path) in modules {
let mut cur = &mut map;
for name in path[..path.len() - 1].iter() {
cur = cur
.submodules
.entry(name.clone())
.or_insert(Module::default());
}
cur.contents.push(module);
}
emit(&mut self.src, map);
fn emit(me: &mut Source, module: Module) {
for (name, submodule) in module.submodules {
uwriteln!(me, "pub mod {name} {{");
emit(me, submodule);
uwriteln!(me, "}}");
}
for submodule in module.contents {
uwriteln!(me, "{submodule}");
}
}
}
fn runtime_path(&self) -> &str {
self.opts
.runtime_path
.as_deref()
.unwrap_or("wit_bindgen::rt")
}
fn bitflags_path(&self) -> &str {
self.opts
.bitflags_path
.as_deref()
.unwrap_or("wit_bindgen::bitflags")
}
fn lookup_export(&self, key: &ExportKey) -> Result<String> {
if let Some(key) = self.opts.exports.get(key) {
return Ok(key.clone());
}
if self.opts.stubs {
return Ok("Stub".to_owned());
}
let key = match key {
ExportKey::World => "world".to_owned(),
ExportKey::Name(name) => format!("\"{name}\""),
};
if self.opts.exports.is_empty() {
bail!(MissingExportsMap { key });
}
bail!("expected `exports` map to contain key `{key}`")
}
fn name_interface(
&mut self,
resolve: &Resolve,
id: InterfaceId,
name: &WorldKey,
is_export: bool,
) -> bool {
let with_name = resolve.name_world_key(name);
let entry = if let Some(remapped_path) = self.opts.with.get(&with_name) {
let name = format!("__with_name{}", self.with_name_counter);
self.used_with_opts.insert(with_name);
self.with_name_counter += 1;
uwriteln!(self.src, "use {remapped_path} as {name};");
InterfaceName {
remapped: true,
path: name,
}
} else {
let path = compute_module_path(name, resolve, is_export).join("::");
InterfaceName {
remapped: false,
path,
}
};
let remapped = entry.remapped;
self.interface_names.insert(id, entry);
remapped
}
}
fn name_package_module(resolve: &Resolve, id: PackageId) -> String {
let pkg = &resolve.packages[id];
let versions_with_same_name = resolve
.packages
.iter()
.filter_map(|(_, p)| {
if p.name.namespace == pkg.name.namespace && p.name.name == pkg.name.name {
Some(&p.name.version)
} else {
None
}
})
.collect::<Vec<_>>();
let base = pkg.name.name.to_snake_case();
if versions_with_same_name.len() == 1 {
return base;
}
let version = match &pkg.name.version {
Some(version) => version,
None => return base,
};
let version = version
.to_string()
.replace('.', "_")
.replace('-', "_")
.replace('+', "_")
.to_snake_case();
format!("{base}{version}")
}
impl WorldGenerator for RustWasm {
fn preprocess(&mut self, resolve: &Resolve, world: WorldId) {
wit_bindgen_core::generated_preamble(&mut self.src, env!("CARGO_PKG_VERSION"));
uwriteln!(self.src, "// Options used:");
if self.opts.std_feature {
uwriteln!(self.src, "// * std_feature");
}
if self.opts.raw_strings {
uwriteln!(self.src, "// * raw_strings");
}
if !self.opts.skip.is_empty() {
uwriteln!(self.src, "// * skip: {:?}", self.opts.skip);
}
if !matches!(self.opts.ownership, Ownership::Owning) {
uwriteln!(self.src, "// * ownership: {:?}", self.opts.ownership);
}
if !self.opts.additional_derive_attributes.is_empty() {
uwriteln!(
self.src,
"// * additional derives {:?}",
self.opts.additional_derive_attributes
);
}
if !self.opts.with.is_empty() {
let mut with = self.opts.with.iter().collect::<Vec<_>>();
with.sort();
uwriteln!(self.src, "// * with {with:?}");
}
self.types.analyze(resolve);
self.world = Some(world);
}
fn import_interface(
&mut self,
resolve: &Resolve,
name: &WorldKey,
id: InterfaceId,
_files: &mut Files,
) {
self.interface_last_seen_as_import.insert(id, true);
let wasm_import_module = resolve.name_world_key(name);
let mut gen = self.interface(
Identifier::Interface(id, name),
Some(&wasm_import_module),
resolve,
true,
);
let (snake, module_path) = gen.start_append_submodule(name);
if gen.gen.name_interface(resolve, id, name, false) {
return;
}
gen.types(id);
gen.generate_imports(resolve.interfaces[id].functions.values());
gen.finish_append_submodule(&snake, module_path);
}
fn import_funcs(
&mut self,
resolve: &Resolve,
world: WorldId,
funcs: &[(&str, &Function)],
_files: &mut Files,
) {
self.import_funcs_called = true;
let mut gen = self.interface(Identifier::World(world), Some("$root"), resolve, true);
gen.generate_imports(funcs.iter().map(|(_, func)| *func));
let src = gen.finish();
self.src.push_str(&src);
}
fn export_interface(
&mut self,
resolve: &Resolve,
name: &WorldKey,
id: InterfaceId,
_files: &mut Files,
) -> Result<()> {
self.interface_last_seen_as_import.insert(id, false);
let mut gen = self.interface(Identifier::Interface(id, name), None, resolve, false);
let (snake, module_path) = gen.start_append_submodule(name);
if gen.gen.name_interface(resolve, id, name, true) {
return Ok(());
}
gen.types(id);
gen.generate_exports(resolve.interfaces[id].functions.values())?;
gen.finish_append_submodule(&snake, module_path);
if self.opts.stubs {
let (pkg, name) = match name {
WorldKey::Name(name) => (None, name),
WorldKey::Interface(id) => {
let interface = &resolve.interfaces[*id];
(
Some(interface.package.unwrap()),
interface.name.as_ref().unwrap(),
)
}
};
for (resource, funcs) in group_by_resource(resolve.interfaces[id].functions.values()) {
let world_id = self.world.unwrap();
let mut gen = self.interface(Identifier::World(world_id), None, resolve, false);
let pkg = pkg.map(|pid| {
let namespace = resolve.packages[pid].name.namespace.clone();
let package_module = name_package_module(resolve, pid);
(namespace, package_module)
});
gen.generate_stub(resource, pkg, name, true, &funcs);
let stub = gen.finish();
self.src.push_str(&stub);
}
}
Ok(())
}
fn export_funcs(
&mut self,
resolve: &Resolve,
world: WorldId,
funcs: &[(&str, &Function)],
_files: &mut Files,
) -> Result<()> {
let mut gen = self.interface(Identifier::World(world), None, resolve, false);
gen.generate_exports(funcs.iter().map(|f| f.1))?;
let src = gen.finish();
self.src.push_str(&src);
if self.opts.stubs {
for (resource, funcs) in group_by_resource(funcs.iter().map(|f| f.1)) {
let mut gen = self.interface(Identifier::World(world), None, resolve, false);
let world = &resolve.worlds[world];
gen.generate_stub(resource, None, &world.name, false, &funcs);
let stub = gen.finish();
self.src.push_str(&stub);
}
}
Ok(())
}
fn import_types(
&mut self,
resolve: &Resolve,
world: WorldId,
types: &[(&str, TypeId)],
_files: &mut Files,
) {
let mut gen = self.interface(Identifier::World(world), Some("$root"), resolve, true);
for (name, ty) in types {
gen.define_type(name, *ty);
}
let src = gen.finish();
self.src.push_str(&src);
}
fn finish_imports(&mut self, resolve: &Resolve, world: WorldId, files: &mut Files) {
if !self.import_funcs_called {
self.import_funcs(resolve, world, &[], files);
}
}
fn finish(&mut self, resolve: &Resolve, world: WorldId, files: &mut Files) -> Result<()> {
let name = &resolve.worlds[world].name;
let imports = mem::take(&mut self.import_modules);
self.emit_modules(imports);
let exports = mem::take(&mut self.export_modules);
self.emit_modules(exports);
self.src.push_str("\n#[cfg(target_arch = \"wasm32\")]\n");
let suffix = self.opts.type_section_suffix.as_deref().unwrap_or("");
self.src.push_str(&format!(
"#[link_section = \"component-type:{name}{suffix}\"]\n"
));
let mut producers = wasm_metadata::Producers::empty();
producers.add(
"processed-by",
env!("CARGO_PKG_NAME"),
env!("CARGO_PKG_VERSION"),
);
let component_type = wit_component::metadata::encode(
resolve,
world,
wit_component::StringEncoding::UTF8,
Some(&producers),
)
.unwrap();
self.src.push_str("#[doc(hidden)]\n");
self.src.push_str(&format!(
"pub static __WIT_BINDGEN_COMPONENT_TYPE: [u8; {}] = *b\"\\\n",
component_type.len()
));
let mut line_length = 0;
let s = self.src.as_mut_string();
for byte in component_type.iter() {
if line_length >= 80 {
s.push_str("\\\n");
line_length = 0;
}
match byte {
b'\\' => {
s.push_str("\\\\");
line_length += 2;
}
b'"' => {
s.push_str("\\\"");
line_length += 2;
}
b if b.is_ascii_alphanumeric() || b.is_ascii_punctuation() => {
s.push(char::from(*byte));
line_length += 1;
}
0 => {
s.push_str("\\0");
line_length += 2;
}
_ => {
uwrite!(s, "\\x{:02x}", byte);
line_length += 4;
}
}
}
self.src.push_str("\";\n");
let rt = self.runtime_path().to_string();
uwriteln!(
self.src,
"
#[inline(never)]
#[doc(hidden)]
#[cfg(target_arch = \"wasm32\")]
pub fn __link_section() {{
{rt}::maybe_link_cabi_realloc();
}}
",
);
if self.opts.stubs {
self.src.push_str("\n#[derive(Debug)]\npub struct Stub;\n");
}
let mut src = mem::take(&mut self.src);
if self.opts.rustfmt {
let mut child = Command::new("rustfmt")
.arg("--edition=2018")
.stdin(Stdio::piped())
.stdout(Stdio::piped())
.spawn()
.expect("failed to spawn `rustfmt`");
child
.stdin
.take()
.unwrap()
.write_all(src.as_bytes())
.unwrap();
src.as_mut_string().truncate(0);
child
.stdout
.take()
.unwrap()
.read_to_string(src.as_mut_string())
.unwrap();
let status = child.wait().unwrap();
assert!(status.success());
}
let module_name = name.to_snake_case();
files.push(&format!("{module_name}.rs"), src.as_bytes());
let remapping_keys = self.opts.with.keys().cloned().collect::<HashSet<String>>();
let mut unused_keys = remapping_keys
.difference(&self.used_with_opts)
.collect::<Vec<&String>>();
unused_keys.sort();
if !unused_keys.is_empty() {
bail!("unused remappings provided via `with`: {unused_keys:?}");
}
Ok(())
}
}
fn compute_module_path(name: &WorldKey, resolve: &Resolve, is_export: bool) -> Vec<String> {
let mut path = Vec::new();
if is_export {
path.push("exports".to_string());
}
match name {
WorldKey::Name(name) => {
path.push(name.to_snake_case());
}
WorldKey::Interface(id) => {
let iface = &resolve.interfaces[*id];
let pkg = iface.package.unwrap();
let pkgname = resolve.packages[pkg].name.clone();
path.push(pkgname.namespace.to_snake_case());
path.push(name_package_module(resolve, pkg));
path.push(iface.name.as_ref().unwrap().to_snake_case());
}
}
path
}
enum Identifier<'a> {
World(WorldId),
Interface(InterfaceId, &'a WorldKey),
}
fn group_by_resource<'a>(
funcs: impl Iterator<Item = &'a Function>,
) -> BTreeMap<Option<TypeId>, Vec<&'a Function>> {
let mut by_resource = BTreeMap::<_, Vec<_>>::new();
for func in funcs {
match &func.kind {
FunctionKind::Freestanding => by_resource.entry(None).or_default().push(func),
FunctionKind::Method(ty) | FunctionKind::Static(ty) | FunctionKind::Constructor(ty) => {
by_resource.entry(Some(*ty)).or_default().push(func);
}
}
}
by_resource
}
#[derive(Default, Debug, Clone, Copy)]
pub enum Ownership {
#[default]
Owning,
Borrowing {
duplicate_if_necessary: bool,
},
}
impl FromStr for Ownership {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"owning" => Ok(Self::Owning),
"borrowing" => Ok(Self::Borrowing {
duplicate_if_necessary: false,
}),
"borrowing-duplicate-if-necessary" => Ok(Self::Borrowing {
duplicate_if_necessary: true,
}),
_ => Err(format!(
"unrecognized ownership: `{s}`; \
expected `owning`, `borrowing`, or `borrowing-duplicate-if-necessary`"
)),
}
}
}
impl fmt::Display for Ownership {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(match self {
Ownership::Owning => "owning",
Ownership::Borrowing {
duplicate_if_necessary: false,
} => "borrowing",
Ownership::Borrowing {
duplicate_if_necessary: true,
} => "borrowing-duplicate-if-necessary",
})
}
}
#[derive(Default)]
struct FnSig {
async_: bool,
unsafe_: bool,
private: bool,
use_item_name: bool,
generics: Option<String>,
self_arg: Option<String>,
self_is_first_param: bool,
}
pub fn to_rust_ident(name: &str) -> String {
match name {
"as" => "as_".into(),
"break" => "break_".into(),
"const" => "const_".into(),
"continue" => "continue_".into(),
"crate" => "crate_".into(),
"else" => "else_".into(),
"enum" => "enum_".into(),
"extern" => "extern_".into(),
"false" => "false_".into(),
"fn" => "fn_".into(),
"for" => "for_".into(),
"if" => "if_".into(),
"impl" => "impl_".into(),
"in" => "in_".into(),
"let" => "let_".into(),
"loop" => "loop_".into(),
"match" => "match_".into(),
"mod" => "mod_".into(),
"move" => "move_".into(),
"mut" => "mut_".into(),
"pub" => "pub_".into(),
"ref" => "ref_".into(),
"return" => "return_".into(),
"self" => "self_".into(),
"static" => "static_".into(),
"struct" => "struct_".into(),
"super" => "super_".into(),
"trait" => "trait_".into(),
"true" => "true_".into(),
"type" => "type_".into(),
"unsafe" => "unsafe_".into(),
"use" => "use_".into(),
"where" => "where_".into(),
"while" => "while_".into(),
"async" => "async_".into(),
"await" => "await_".into(),
"dyn" => "dyn_".into(),
"abstract" => "abstract_".into(),
"become" => "become_".into(),
"box" => "box_".into(),
"do" => "do_".into(),
"final" => "final_".into(),
"macro" => "macro_".into(),
"override" => "override_".into(),
"priv" => "priv_".into(),
"typeof" => "typeof_".into(),
"unsized" => "unsized_".into(),
"virtual" => "virtual_".into(),
"yield" => "yield_".into(),
"try" => "try_".into(),
s => s.to_snake_case(),
}
}
fn to_upper_camel_case(name: &str) -> String {
match name {
"guest" => "Guest_".to_string(),
s => s.to_upper_camel_case(),
}
}
fn wasm_type(ty: WasmType) -> &'static str {
match ty {
WasmType::I32 => "i32",
WasmType::I64 => "i64",
WasmType::F32 => "f32",
WasmType::F64 => "f64",
}
}
fn int_repr(repr: Int) -> &'static str {
match repr {
Int::U8 => "u8",
Int::U16 => "u16",
Int::U32 => "u32",
Int::U64 => "u64",
}
}
fn bitcast(casts: &[Bitcast], operands: &[String], results: &mut Vec<String>) {
for (cast, operand) in casts.iter().zip(operands) {
results.push(match cast {
Bitcast::None => operand.clone(),
Bitcast::I32ToI64 => format!("i64::from({})", operand),
Bitcast::F32ToI32 => format!("({}).to_bits() as i32", operand),
Bitcast::F64ToI64 => format!("({}).to_bits() as i64", operand),
Bitcast::I64ToI32 => format!("{} as i32", operand),
Bitcast::I32ToF32 => format!("f32::from_bits({} as u32)", operand),
Bitcast::I64ToF64 => format!("f64::from_bits({} as u64)", operand),
Bitcast::F32ToI64 => format!("i64::from(({}).to_bits())", operand),
Bitcast::I64ToF32 => format!("f32::from_bits({} as u32)", operand),
});
}
}
enum RustFlagsRepr {
U8,
U16,
U32,
U64,
U128,
}
impl RustFlagsRepr {
fn new(f: &Flags) -> RustFlagsRepr {
match f.repr() {
FlagsRepr::U8 => RustFlagsRepr::U8,
FlagsRepr::U16 => RustFlagsRepr::U16,
FlagsRepr::U32(1) => RustFlagsRepr::U32,
FlagsRepr::U32(2) => RustFlagsRepr::U64,
FlagsRepr::U32(3 | 4) => RustFlagsRepr::U128,
FlagsRepr::U32(n) => panic!("unsupported number of flags: {}", n * 32),
}
}
}
impl fmt::Display for RustFlagsRepr {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
RustFlagsRepr::U8 => "u8".fmt(f),
RustFlagsRepr::U16 => "u16".fmt(f),
RustFlagsRepr::U32 => "u32".fmt(f),
RustFlagsRepr::U64 => "u64".fmt(f),
RustFlagsRepr::U128 => "u128".fmt(f),
}
}
}
#[derive(Debug)]
pub struct MissingExportsMap {
key: String,
}
impl fmt::Display for MissingExportsMap {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"no `exports` map provided in configuration - provide an `exports` map a key `{key}`",
key = self.key,
)
}
}
impl std::error::Error for MissingExportsMap {}