-
Notifications
You must be signed in to change notification settings - Fork 1k
/
idl_type.rs
790 lines (735 loc) · 29.2 KB
/
idl_type.rs
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
use proc_macro2::{Ident, Span};
use syn;
use wasm_bindgen_backend::util::{ident_ty, leading_colon_path_ty, raw_ident, rust_ident};
use weedle::common::Identifier;
use weedle::term;
use weedle::types::*;
use crate::first_pass::FirstPassRecord;
use crate::util::{array, camel_case_ident, option_ty, shared_ref, snake_case_ident, TypePosition};
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug)]
pub(crate) enum IdlType<'a> {
Boolean,
Byte,
Octet,
Short,
UnsignedShort,
Long,
UnsignedLong,
LongLong,
UnsignedLongLong,
Float,
UnrestrictedFloat,
Double,
UnrestrictedDouble,
DomString,
ByteString,
UsvString,
Object,
Symbol,
Error,
Callback,
ArrayBuffer,
DataView,
Int8Array {
immutable: bool,
},
Uint8Array {
immutable: bool,
},
Uint8ClampedArray {
immutable: bool,
},
Int16Array {
immutable: bool,
},
Uint16Array {
immutable: bool,
},
Int32Array {
immutable: bool,
},
Uint32Array {
immutable: bool,
},
Float32Array {
immutable: bool,
},
Float64Array {
immutable: bool,
},
ArrayBufferView {
immutable: bool,
},
BufferSource {
immutable: bool,
},
Interface(&'a str),
Dictionary(&'a str),
Enum(&'a str),
CallbackInterface {
name: &'a str,
single_function: bool,
},
Nullable(Box<IdlType<'a>>),
FrozenArray(Box<IdlType<'a>>),
Sequence(Box<IdlType<'a>>),
Promise(Box<IdlType<'a>>),
Record(Box<IdlType<'a>>, Box<IdlType<'a>>),
Union(Vec<IdlType<'a>>),
Any,
Void,
UnknownInterface(&'a str),
}
pub(crate) trait ToIdlType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a>;
}
impl<'a> ToIdlType<'a> for UnionType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
let mut idl_types = Vec::with_capacity(self.body.list.len());
for t in &self.body.list {
idl_types.push(t.to_idl_type(record));
}
IdlType::Union(idl_types)
}
}
impl<'a> ToIdlType<'a> for Type<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
Type::Single(t) => t.to_idl_type(record),
Type::Union(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for SingleType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
SingleType::Any(t) => t.to_idl_type(record),
SingleType::NonAny(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for NonAnyType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
NonAnyType::Promise(t) => t.to_idl_type(record),
NonAnyType::Integer(t) => t.to_idl_type(record),
NonAnyType::FloatingPoint(t) => t.to_idl_type(record),
NonAnyType::Boolean(t) => t.to_idl_type(record),
NonAnyType::Byte(t) => t.to_idl_type(record),
NonAnyType::Octet(t) => t.to_idl_type(record),
NonAnyType::ByteString(t) => t.to_idl_type(record),
NonAnyType::DOMString(t) => t.to_idl_type(record),
NonAnyType::USVString(t) => t.to_idl_type(record),
NonAnyType::Sequence(t) => t.to_idl_type(record),
NonAnyType::Object(t) => t.to_idl_type(record),
NonAnyType::Symbol(t) => t.to_idl_type(record),
NonAnyType::Error(t) => t.to_idl_type(record),
NonAnyType::ArrayBuffer(t) => t.to_idl_type(record),
NonAnyType::DataView(t) => t.to_idl_type(record),
NonAnyType::Int8Array(t) => t.to_idl_type(record),
NonAnyType::Int16Array(t) => t.to_idl_type(record),
NonAnyType::Int32Array(t) => t.to_idl_type(record),
NonAnyType::Uint8Array(t) => t.to_idl_type(record),
NonAnyType::Uint16Array(t) => t.to_idl_type(record),
NonAnyType::Uint32Array(t) => t.to_idl_type(record),
NonAnyType::Uint8ClampedArray(t) => t.to_idl_type(record),
NonAnyType::Float32Array(t) => t.to_idl_type(record),
NonAnyType::Float64Array(t) => t.to_idl_type(record),
NonAnyType::FrozenArrayType(t) => t.to_idl_type(record),
NonAnyType::ArrayBufferView(t) => t.to_idl_type(record),
NonAnyType::BufferSource(t) => t.to_idl_type(record),
NonAnyType::RecordType(t) => t.to_idl_type(record),
NonAnyType::Identifier(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for SequenceType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
IdlType::Sequence(Box::new(self.generics.body.to_idl_type(record)))
}
}
impl<'a> ToIdlType<'a> for FrozenArrayType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
IdlType::FrozenArray(Box::new(self.generics.body.to_idl_type(record)))
}
}
impl<'a, T: ToIdlType<'a>> ToIdlType<'a> for MayBeNull<T> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
let inner_idl_type = self.type_.to_idl_type(record);
if self.q_mark.is_some() {
IdlType::Nullable(Box::new(inner_idl_type))
} else {
inner_idl_type
}
}
}
impl<'a> ToIdlType<'a> for PromiseType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
IdlType::Promise(Box::new(self.generics.body.to_idl_type(record)))
}
}
impl<'a> ToIdlType<'a> for IntegerType {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
IntegerType::LongLong(t) => t.to_idl_type(record),
IntegerType::Long(t) => t.to_idl_type(record),
IntegerType::Short(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for LongLongType {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
if self.unsigned.is_some() {
IdlType::UnsignedLongLong
} else {
IdlType::LongLong
}
}
}
impl<'a> ToIdlType<'a> for LongType {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
if self.unsigned.is_some() {
IdlType::UnsignedLong
} else {
IdlType::Long
}
}
}
impl<'a> ToIdlType<'a> for ShortType {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
if self.unsigned.is_some() {
IdlType::UnsignedShort
} else {
IdlType::Short
}
}
}
impl<'a> ToIdlType<'a> for FloatingPointType {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
FloatingPointType::Float(t) => t.to_idl_type(record),
FloatingPointType::Double(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for FloatType {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
if self.unrestricted.is_some() {
IdlType::UnrestrictedFloat
} else {
IdlType::Float
}
}
}
impl<'a> ToIdlType<'a> for DoubleType {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
if self.unrestricted.is_some() {
IdlType::UnrestrictedDouble
} else {
IdlType::Double
}
}
}
impl<'a> ToIdlType<'a> for RecordType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
IdlType::Record(
Box::new(self.generics.body.0.to_idl_type(record)),
Box::new(self.generics.body.2.to_idl_type(record)),
)
}
}
impl<'a> ToIdlType<'a> for StringType {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
StringType::Byte(t) => t.to_idl_type(record),
StringType::DOM(t) => t.to_idl_type(record),
StringType::USV(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for UnionMemberType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
UnionMemberType::Single(t) => t.to_idl_type(record),
UnionMemberType::Union(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for ConstType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
ConstType::Integer(t) => t.to_idl_type(record),
ConstType::FloatingPoint(t) => t.to_idl_type(record),
ConstType::Boolean(t) => t.to_idl_type(record),
ConstType::Byte(t) => t.to_idl_type(record),
ConstType::Octet(t) => t.to_idl_type(record),
ConstType::Identifier(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for ReturnType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
match self {
ReturnType::Void(t) => t.to_idl_type(record),
ReturnType::Type(t) => t.to_idl_type(record),
}
}
}
impl<'a> ToIdlType<'a> for AttributedType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
self.type_.to_idl_type(record)
}
}
impl<'a> ToIdlType<'a> for AttributedNonAnyType<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
self.type_.to_idl_type(record)
}
}
impl<'a> ToIdlType<'a> for Identifier<'a> {
fn to_idl_type(&self, record: &FirstPassRecord<'a>) -> IdlType<'a> {
if self.0 == "DOMTimeStamp" {
// https://heycam.github.io/webidl/#DOMTimeStamp
IdlType::UnsignedLongLong
} else if let Some(idl_type) = record.typedefs.get(&self.0) {
idl_type.to_idl_type(record)
} else if record.interfaces.contains_key(self.0) {
IdlType::Interface(self.0)
} else if record.dictionaries.contains_key(self.0) {
IdlType::Dictionary(self.0)
} else if record.enums.contains_key(self.0) {
IdlType::Enum(self.0)
} else if record.callbacks.contains(self.0) {
IdlType::Callback
} else if let Some(data) = record.callback_interfaces.get(self.0) {
IdlType::CallbackInterface {
name: self.0,
single_function: data.single_function,
}
} else if self.0 == "WindowProxy" {
// See this for more info:
//
// https://html.spec.whatwg.org/multipage/window-object.html#windowproxy
//
// namely this seems to be "legalese" for "this is a `Window`", so
// let's translate it as such.
IdlType::Interface("Window")
} else {
log::warn!("Unrecognized type: {}", self.0);
IdlType::UnknownInterface(self.0)
}
}
}
macro_rules! terms_to_idl_type {
($($t:tt => $r:tt)*) => ($(
impl<'a> ToIdlType<'a> for term::$t {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
IdlType::$r
}
}
)*);
}
// We default to arrays being mutable, but in certain cases where we're certain that
// slices won't get mutated on the JS side (such as the WebGL APIs) we might, later in the flow,
// instead use the immutable version.
macro_rules! terms_to_idl_type_maybe_immutable {
($($t:tt => $r:tt)*) => ($(
impl<'a> ToIdlType<'a> for term::$t {
fn to_idl_type(&self, _record: &FirstPassRecord<'a>) -> IdlType<'a> {
IdlType::$r { immutable: false }
}
}
)*);
}
terms_to_idl_type! {
Symbol => Symbol
ByteString => ByteString
DOMString => DomString
USVString => UsvString
Any => Any
Boolean => Boolean
Byte => Byte
Double => Double
Float => Float
Long => Long
Object => Object
Octet => Octet
Short => Short
Void => Void
ArrayBuffer => ArrayBuffer
DataView => DataView
Error => Error
}
terms_to_idl_type_maybe_immutable! {
ArrayBufferView => ArrayBufferView
BufferSource => BufferSource
Float32Array => Float32Array
Float64Array => Float64Array
Int16Array => Int16Array
Int32Array => Int32Array
Int8Array => Int8Array
Uint16Array => Uint16Array
Uint32Array => Uint32Array
Uint8Array => Uint8Array
Uint8ClampedArray => Uint8ClampedArray
}
#[derive(Debug, Clone)]
pub enum TypeError {
CannotConvert,
}
impl<'a> IdlType<'a> {
/// Generates a snake case type name.
pub(crate) fn push_snake_case_name(&self, dst: &mut String) {
match self {
IdlType::Boolean => dst.push_str("bool"),
IdlType::Byte => dst.push_str("i8"),
IdlType::Octet => dst.push_str("u8"),
IdlType::Short => dst.push_str("i16"),
IdlType::UnsignedShort => dst.push_str("u16"),
IdlType::Long => dst.push_str("i32"),
IdlType::UnsignedLong => dst.push_str("u32"),
IdlType::LongLong => dst.push_str("i64"),
IdlType::UnsignedLongLong => dst.push_str("u64"),
IdlType::Float | IdlType::UnrestrictedFloat => dst.push_str("f32"),
IdlType::Double | IdlType::UnrestrictedDouble => dst.push_str("f64"),
IdlType::DomString | IdlType::ByteString | IdlType::UsvString => dst.push_str("str"),
IdlType::Object => dst.push_str("object"),
IdlType::Symbol => dst.push_str("symbol"),
IdlType::Error => dst.push_str("error"),
IdlType::Callback => dst.push_str("callback"),
IdlType::ArrayBuffer => dst.push_str("array_buffer"),
IdlType::DataView => dst.push_str("data_view"),
IdlType::Int8Array { .. } => dst.push_str("i8_array"),
IdlType::Uint8Array { .. } => dst.push_str("u8_array"),
IdlType::Uint8ClampedArray { .. } => dst.push_str("u8_clamped_array"),
IdlType::Int16Array { .. } => dst.push_str("i16_array"),
IdlType::Uint16Array { .. } => dst.push_str("u16_array"),
IdlType::Int32Array { .. } => dst.push_str("i32_array"),
IdlType::Uint32Array { .. } => dst.push_str("u32_array"),
IdlType::Float32Array { .. } => dst.push_str("f32_array"),
IdlType::Float64Array { .. } => dst.push_str("f64_array"),
IdlType::ArrayBufferView { .. } => dst.push_str("array_buffer_view"),
IdlType::BufferSource { .. } => dst.push_str("buffer_source"),
IdlType::Interface(name) => dst.push_str(&snake_case_ident(name)),
IdlType::UnknownInterface(name) => dst.push_str(&snake_case_ident(name)),
IdlType::Dictionary(name) => dst.push_str(&snake_case_ident(name)),
IdlType::Enum(name) => dst.push_str(&snake_case_ident(name)),
IdlType::CallbackInterface { name, .. } => dst.push_str(&snake_case_ident(name)),
IdlType::Nullable(idl_type) => {
dst.push_str("opt_");
idl_type.push_snake_case_name(dst);
}
IdlType::FrozenArray(idl_type) => {
idl_type.push_snake_case_name(dst);
dst.push_str("_frozen_array");
}
IdlType::Sequence(idl_type) => {
idl_type.push_snake_case_name(dst);
dst.push_str("_sequence");
}
IdlType::Promise(idl_type) => {
idl_type.push_snake_case_name(dst);
dst.push_str("_promise");
}
IdlType::Record(idl_type_from, idl_type_to) => {
dst.push_str("record_from_");
idl_type_from.push_snake_case_name(dst);
dst.push_str("_to_");
idl_type_to.push_snake_case_name(dst);
}
IdlType::Union(idl_types) => {
dst.push_str("union_of_");
let mut first = true;
for idl_type in idl_types {
if first {
first = false;
} else {
dst.push_str("_and_");
}
idl_type.push_snake_case_name(dst);
}
}
IdlType::Any => dst.push_str("any"),
IdlType::Void => dst.push_str("void"),
}
}
/// Converts to syn type if possible.
pub(crate) fn to_syn_type(&self, pos: TypePosition) -> Result<Option<syn::Type>, TypeError> {
let externref = |ty| {
Some(match pos {
TypePosition::Argument => shared_ref(ty, false),
TypePosition::Return => ty,
})
};
let js_sys = |name: &str| {
let path = vec![rust_ident("js_sys"), rust_ident(name)];
let ty = leading_colon_path_ty(path);
externref(ty)
};
let js_value = {
let path = vec![rust_ident("wasm_bindgen"), rust_ident("JsValue")];
externref(leading_colon_path_ty(path))
};
match self {
IdlType::Boolean => Ok(Some(ident_ty(raw_ident("bool")))),
IdlType::Byte => Ok(Some(ident_ty(raw_ident("i8")))),
IdlType::Octet => Ok(Some(ident_ty(raw_ident("u8")))),
IdlType::Short => Ok(Some(ident_ty(raw_ident("i16")))),
IdlType::UnsignedShort => Ok(Some(ident_ty(raw_ident("u16")))),
IdlType::Long => Ok(Some(ident_ty(raw_ident("i32")))),
IdlType::UnsignedLong => Ok(Some(ident_ty(raw_ident("u32")))),
// Technically these are 64-bit numbers, but we're binding web
// APIs that don't actually have return the corresponding 64-bit
// type, `BigInt`. Instead the web basically uses floats for these
// values. We already expand these types in argument position to
// i32/f64 (convenience for i32, losslessness for f64). If we get
// here then we're looking at an un-flattened long type such as
// dictionary fields or return types. In order to generate bindings
// for these functions we just use `f64` here, which should match
// exactly what the JS web currently uses anyway.
//
// Perhaps one day we'll bind to u64/i64 here, but we need `BigInt`
// to see more usage!
IdlType::LongLong | IdlType::UnsignedLongLong => Ok(Some(ident_ty(raw_ident("f64")))),
IdlType::Float => Ok(Some(ident_ty(raw_ident("f32")))),
IdlType::UnrestrictedFloat => Ok(Some(ident_ty(raw_ident("f32")))),
IdlType::Double => Ok(Some(ident_ty(raw_ident("f64")))),
IdlType::UnrestrictedDouble => Ok(Some(ident_ty(raw_ident("f64")))),
IdlType::DomString | IdlType::ByteString | IdlType::UsvString => match pos {
TypePosition::Argument => Ok(Some(shared_ref(ident_ty(raw_ident("str")), false))),
TypePosition::Return => Ok(Some(ident_ty(raw_ident("String")))),
},
IdlType::Object => Ok(js_sys("Object")),
IdlType::Symbol => Err(TypeError::CannotConvert),
IdlType::Error => Err(TypeError::CannotConvert),
IdlType::ArrayBuffer => Ok(js_sys("ArrayBuffer")),
IdlType::DataView => Ok(js_sys("DataView")),
IdlType::Int8Array { immutable } => Ok(Some(array("i8", pos, *immutable))),
IdlType::Uint8Array { immutable } => Ok(Some(array("u8", pos, *immutable))),
IdlType::Uint8ClampedArray { immutable } => {
Ok(Some(clamped(array("u8", pos, *immutable))))
}
IdlType::Int16Array { immutable } => Ok(Some(array("i16", pos, *immutable))),
IdlType::Uint16Array { immutable } => Ok(Some(array("u16", pos, *immutable))),
IdlType::Int32Array { immutable } => Ok(Some(array("i32", pos, *immutable))),
IdlType::Uint32Array { immutable } => Ok(Some(array("u32", pos, *immutable))),
IdlType::Float32Array { immutable } => Ok(Some(array("f32", pos, *immutable))),
IdlType::Float64Array { immutable } => Ok(Some(array("f64", pos, *immutable))),
IdlType::ArrayBufferView { .. } | IdlType::BufferSource { .. } => Ok(js_sys("Object")),
IdlType::Interface(name)
| IdlType::Dictionary(name)
| IdlType::CallbackInterface { name, .. } => {
let ty = ident_ty(rust_ident(camel_case_ident(name).as_str()));
Ok(externref(ty))
}
IdlType::Enum(name) => Ok(Some(ident_ty(rust_ident(camel_case_ident(name).as_str())))),
IdlType::Nullable(idl_type) => {
let inner = idl_type.to_syn_type(pos)?;
match inner {
Some(inner) => {
// TODO: this is a bit of a hack, but `Option<JsValue>` isn't
// supported right now. As a result if we see `JsValue` for our
// inner type, leave that as the same when we create a nullable
// version of that. That way `any?` just becomes `JsValue` and
// it's up to users to dispatch and/or create instances
// appropriately.
if let syn::Type::Path(path) = &inner {
if path.qself.is_none()
&& path
.path
.segments
.last()
.map(|p| p.ident == "JsValue")
.unwrap_or(false)
{
return Ok(Some(inner.clone()));
}
}
Ok(Some(option_ty(inner)))
}
None => Ok(None),
}
}
IdlType::FrozenArray(_idl_type) => Err(TypeError::CannotConvert),
// webidl sequences must always be returned as javascript `Array`s. They may accept
// anything implementing the @@iterable interface.
IdlType::Sequence(_idl_type) => match pos {
TypePosition::Argument => Ok(js_value),
TypePosition::Return => Ok(js_sys("Array")),
},
IdlType::Promise(_idl_type) => Ok(js_sys("Promise")),
IdlType::Record(_idl_type_from, _idl_type_to) => Err(TypeError::CannotConvert),
IdlType::Union(idl_types) => {
// Note that most union types have already been expanded to
// their components via `flatten`. Unions in a return position
// or dictionary fields, however, haven't been flattened, which
// means we may need to conver them to a `syn` type.
//
// Currently this does a bit of a "poor man's" tree traversal by
// saying that if all union members are interfaces we can assume
// they've all got `Object` as a superclass, so we can take an
// object here. If any are not an interface though we
// pessimisitcally translate the union into a `JsValue`,
// absolutely anything. It's up to the application to figure out
// what to do with that.
//
// TODO: we should probably do a better job here translating
// unions to a single type. Two possible strategies could be:
//
// 1. Use strategy of finding the nearest common subclass
// (finding the best type that is suitable for all values of
// this union) instead of always assuming `Object`.
// 2. Generate enum with payload in Rust for each union type.
// Such an enum, however, might have a relatively high
// overhead in creating it from a JS value, but would be
// cheap to convert from a variant back to a JS value.
if idl_types.iter().all(|idl_type| match idl_type {
IdlType::Interface(..) => true,
_ => false,
}) {
IdlType::Object.to_syn_type(pos)
} else {
IdlType::Any.to_syn_type(pos)
}
}
IdlType::Any => Ok(js_value),
IdlType::Void => Ok(None),
IdlType::Callback => Ok(js_sys("Function")),
IdlType::UnknownInterface(_) => Err(TypeError::CannotConvert),
}
}
/// Flattens unions recursively.
///
/// Works similarly to [flattened union member types],
/// but also flattens unions inside generics of other types.
///
/// [flattened union member types]: https://heycam.github.io/webidl/#dfn-flattened-union-member-types
pub(crate) fn flatten(&self) -> Vec<Self> {
match self {
IdlType::Nullable(idl_type) => idl_type
.flatten()
.into_iter()
.map(Box::new)
.map(IdlType::Nullable)
.collect(),
IdlType::FrozenArray(idl_type) => idl_type
.flatten()
.into_iter()
.map(Box::new)
.map(IdlType::FrozenArray)
.collect(),
IdlType::Sequence(idl_type) => idl_type
.flatten()
.into_iter()
.map(Box::new)
.map(IdlType::Sequence)
.collect(),
IdlType::Promise(idl_type) => idl_type
.flatten()
.into_iter()
.map(Box::new)
.map(IdlType::Promise)
.collect(),
IdlType::Record(idl_type_from, idl_type_to) => {
let mut idl_types = Vec::new();
for idl_type_from in idl_type_from.flatten() {
for idl_type_to in idl_type_to.flatten() {
idl_types.push(IdlType::Record(
Box::new(idl_type_from.clone()),
Box::new(idl_type_to.clone()),
));
}
}
idl_types
}
IdlType::Union(idl_types) => idl_types
.iter()
.flat_map(|idl_type| idl_type.flatten())
.collect(),
IdlType::ArrayBufferView { immutable } => vec![
IdlType::ArrayBufferView {
immutable: *immutable,
},
IdlType::Uint8Array {
immutable: *immutable,
},
],
IdlType::BufferSource { immutable } => vec![
IdlType::BufferSource {
immutable: *immutable,
},
IdlType::Uint8Array {
immutable: *immutable,
},
],
IdlType::LongLong => vec![IdlType::Long, IdlType::Double],
IdlType::UnsignedLongLong => vec![IdlType::UnsignedLong, IdlType::Double],
IdlType::CallbackInterface {
name,
single_function: true,
} => {
// According to the webidl spec [1] single-function callback
// interfaces can also be replaced in arguments with simply a
// single callable function, which we map to a `Callback`.
//
// [1]: https://heycam.github.io/webidl/#es-user-objects
vec![
IdlType::Callback,
IdlType::CallbackInterface {
name,
single_function: false,
},
]
}
idl_type @ _ => vec![idl_type.clone()],
}
}
}
#[test]
fn idl_type_flatten_test() {
use self::IdlType::*;
assert_eq!(
Union(vec![
Interface("Node"),
Union(vec![Sequence(Box::new(Long),), Interface("Event"),]),
Nullable(Box::new(Union(vec![
Interface("XMLHttpRequest"),
DomString,
])),),
Sequence(Box::new(Union(vec![
Sequence(Box::new(Double),),
Interface("NodeList"),
])),),
])
.flatten(),
vec![
Interface("Node"),
Sequence(Box::new(Long)),
Interface("Event"),
Nullable(Box::new(Interface("XMLHttpRequest"))),
Nullable(Box::new(DomString)),
Sequence(Box::new(Sequence(Box::new(Double)))),
Sequence(Box::new(Interface("NodeList"))),
],
);
}
/// From `T` create `::wasm_bindgen::Clamped<T>`
fn clamped(t: syn::Type) -> syn::Type {
let arguments = syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
colon2_token: None,
lt_token: Default::default(),
args: vec![syn::GenericArgument::Type(t)].into_iter().collect(),
gt_token: Default::default(),
});
let ident = raw_ident("Clamped");
let seg = syn::PathSegment { ident, arguments };
syn::TypePath {
qself: None,
path: syn::Path {
leading_colon: Some(Default::default()),
segments: vec![Ident::new("wasm_bindgen", Span::call_site()).into(), seg]
.into_iter()
.collect(),
},
}
.into()
}