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
/*!
This is a specialized crate exporting a derive macro [`TryFromJsValue`]
that serves as a basis for workarounds for some lapses of functionality in
[`wasm-bindgen`](https://crates.io/crates/wasm-bindgen).
## Optional arguments
`wasm-bindgen` supports method arguments of the form `Option<T>`,
where `T` is an exported type, but it has an unexpected side effect on the JS side:
the value passed to a method this way gets consumed (mimicking Rust semantics).
See [this issue](https://github.com/rustwasm/wasm-bindgen/issues/2370).
`Option<&T>` is not currently supported, but an equivalent behavior can be implemented manually.
```
extern crate alloc;
use js_sys::Error;
use wasm_bindgen::{prelude::wasm_bindgen, JsCast, JsValue};
use wasm_bindgen_derive::TryFromJsValue;
// Derive `TryFromJsValue` for the target structure (note that it has to come
// before the `[#wasm_bindgen]` attribute, and requires `Clone`):
#[derive(TryFromJsValue)]
#[wasm_bindgen]
#[derive(Clone)]
struct MyType(usize);
// To have a correct typing annotation generated for TypeScript, declare a custom type.
#[wasm_bindgen]
extern "C" {
#[wasm_bindgen(typescript_type = "MyType | null")]
pub type OptionMyType;
}
// Use this type in the function signature.
pub fn option_example(value: &OptionMyType) -> Result<OptionMyType, Error> {
let js_value: &JsValue = value.as_ref();
let typed_value: Option<MyType> = if js_value.is_null() {
None
} else {
Some(MyType::try_from(js_value).map_err(|err| Error::new(&err))?)
};
// Now we have `typed_value: Option<MyType>`.
// Return it
// Note that by default `JsValue::from(None)` creates a `JsValue::UNDEFINED`.
// We want it to be `null` (as we declared in the TS type).
Ok(typed_value
.map(JsValue::from)
.unwrap_or(JsValue::NULL)
.unchecked_into::<OptionMyType>())
}
```
## Vector arguments
`wasm-bindgen` currently does not support vector arguments with elements having an exported type.
See [this issue](https://github.com/rustwasm/wasm-bindgen/issues/111),
which, although it is mainly about returning vectors, will probably allow taking vectors too
when fixed.
The workaround is similar to that for the optional arguments, with one step added,
where we try to cast the [`JsValue`](`wasm_bindgen::JsValue`) into [`Array`](`js_sys::Array`).
The following example also shows how to return an array with elements having an exported type.
```
extern crate alloc;
use js_sys::Error;
use wasm_bindgen::{prelude::wasm_bindgen, JsCast, JsValue};
use wasm_bindgen_derive::TryFromJsValue;
#[derive(TryFromJsValue)]
#[wasm_bindgen]
#[derive(Clone)]
struct MyType(usize);
// To have a correct typing annotation generated for TypeScript, declare a custom type.
#[wasm_bindgen]
extern "C" {
#[wasm_bindgen(typescript_type = "MyType[]")]
pub type MyTypeArray;
}
// Use this type in the function signature.
pub fn vec_example(val: &MyTypeArray) -> Result<MyTypeArray, Error> {
// Unpack the array
let js_val: &JsValue = val.as_ref();
let array: &js_sys::Array = js_val
.dyn_ref()
.ok_or_else(|| Error::new("The argument must be an array"))?;
let length: usize = array.length().try_into().map_err(|err| Error::new(&format!("{}", err)))?;
let mut typed_array = Vec::<MyType>::with_capacity(length);
for js in array.iter() {
let typed_elem = MyType::try_from(&js).map_err(|err| Error::new(&err))?;
typed_array.push(typed_elem);
}
// Now we have `typed_array: Vec<MyType>`.
// Return the array
Ok(typed_array
.into_iter()
.map(JsValue::from)
.collect::<js_sys::Array>()
.unchecked_into::<MyTypeArray>())
}
```
*/
#![doc(html_root_url = "https://docs.rs/wasm-bindgen-derive")]
#![warn(missing_docs, rust_2018_idioms, unused_qualifications)]
#![no_std]
extern crate alloc;
use alloc::format;
use alloc::string::ToString;
use proc_macro::TokenStream;
use proc_macro2::{Span, TokenStream as TokenStream2};
use quote::quote;
use syn::{parse_macro_input, Data, DeriveInput, Error};
macro_rules! derive_error {
($string: tt) => {
Error::new(Span::call_site(), $string)
.to_compile_error()
.into()
};
}
/** Derives a `TryFrom<&JsValue>` for a type exported using `#[wasm_bindgen]`.
Note that:
* this derivation must be be positioned before `#[wasm_bindgen]`;
* the type must implement [`Clone`].
* `extern crate alloc` must be declared in scope.
The macro is authored by [**@AlexKorn**](https://github.com/AlexKorn)
based on the idea of [**@aweinstock314**](https://github.com/aweinstock314).
See [this](https://github.com/rustwasm/wasm-bindgen/issues/2231#issuecomment-656293288)
and [this](https://github.com/rustwasm/wasm-bindgen/issues/2231#issuecomment-1169658111)
GitHub comments.
*/
#[proc_macro_derive(TryFromJsValue)]
pub fn derive_try_from_jsvalue(input: TokenStream) -> TokenStream {
let input: DeriveInput = parse_macro_input!(input as DeriveInput);
let name = input.ident;
let data = input.data;
match data {
Data::Struct(_) => {}
_ => return derive_error!("TryFromJsValue may only be derived on structs"),
};
let wasm_bindgen_meta = input.attrs.iter().find_map(|attr| {
attr.parse_meta()
.ok()
.and_then(|meta| match meta.path().is_ident("wasm_bindgen") {
true => Some(meta),
false => None,
})
});
if wasm_bindgen_meta.is_none() {
return derive_error!(
"TryFromJsValue can be defined only on struct exported to wasm with #[wasm_bindgen]"
);
}
let maybe_js_class = wasm_bindgen_meta
.and_then(|meta| match meta {
syn::Meta::List(list) => Some(list),
_ => None,
})
.and_then(|meta_list| {
meta_list.nested.iter().find_map(|nested_meta| {
let maybe_meta = match nested_meta {
syn::NestedMeta::Meta(meta) => Some(meta),
_ => None,
};
maybe_meta
.and_then(|meta| match meta {
syn::Meta::NameValue(name_value) => Some(name_value),
_ => None,
})
.and_then(|name_value| match name_value.path.is_ident("js_name") {
true => Some(name_value.lit.clone()),
false => None,
})
.and_then(|lit| match lit {
syn::Lit::Str(str) => Some(str.value()),
_ => None,
})
})
});
let wasm_bindgen_macro_invocaton = match maybe_js_class {
Some(class) => format!("wasm_bindgen(js_class = \"{}\")", class),
None => "wasm_bindgen".to_string(),
}
.parse::<TokenStream2>()
.unwrap();
let expanded = quote! {
impl #name {
pub fn __get_classname() -> &'static str {
::core::stringify!(#name)
}
}
#[#wasm_bindgen_macro_invocaton]
impl #name {
#[wasm_bindgen(js_name = "__getClassname")]
pub fn __js_get_classname(&self) -> String {
use ::alloc::borrow::ToOwned;
::core::stringify!(#name).to_owned()
}
}
impl ::core::convert::TryFrom<&::wasm_bindgen::JsValue> for #name {
type Error = String;
fn try_from(js: &::wasm_bindgen::JsValue) -> Result<Self, Self::Error> {
use ::alloc::borrow::ToOwned;
use ::alloc::string::ToString;
use ::wasm_bindgen::JsCast;
use ::wasm_bindgen::convert::RefFromWasmAbi;
let classname = Self::__get_classname();
if !js.is_object() {
return Err(format!("Value supplied as {} is not an object", classname));
}
let no_get_classname_msg = concat!(
"no __getClassname method specified for object; ",
"did you forget to derive TryFromJsObject for this type?");
let get_classname = ::js_sys::Reflect::get(
js,
&::wasm_bindgen::JsValue::from("__getClassname"),
)
.or(Err(no_get_classname_msg.to_string()))?;
if get_classname.is_undefined() {
return Err(no_get_classname_msg.to_string());
}
let get_classname = get_classname
.dyn_into::<::js_sys::Function>()
.map_err(|err| format!("__getClassname is not a function, {:?}", err))?;
let object_classname: String = ::js_sys::Reflect::apply(
&get_classname,
js,
&::js_sys::Array::new(),
)
.ok()
.and_then(|v| v.as_string())
.ok_or_else(|| "Failed to get classname".to_owned())?;
if object_classname.as_str() == classname {
// Note: using an undocumented implementation detail of `wasm-bindgen`:
// the pointer property has the name `__wbg_ptr` (since wasm-bindgen 0.2.85)
let ptr = ::js_sys::Reflect::get(js, &::wasm_bindgen::JsValue::from_str("__wbg_ptr"))
.map_err(|err| format!("{:?}", err))?;
let ptr_u32: u32 = ptr.as_f64().ok_or(::wasm_bindgen::JsValue::NULL)
.map_err(|err| format!("{:?}", err))?
as u32;
let instance_ref = unsafe { #name::ref_from_abi(ptr_u32) };
Ok(instance_ref.clone())
} else {
Err(format!("Cannot convert {} to {}", object_classname, classname))
}
}
}
};
TokenStream::from(expanded)
}