windows-rdl 0.100.0

RDL parser library and ECMA-335 generator
Documentation
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
use super::guid;
use super::*;

pub struct AttributeRef {
    pub type_name: metadata::TypeName,
    pub args: Vec<(String, metadata::Value)>,
}

struct AttributeInfo {
    type_name: metadata::TypeName,
    constructors: Vec<Vec<metadata::Type>>,
    properties: Vec<(String, metadata::Type)>,
}

struct SplitArgs<'a> {
    positional: Vec<&'a syn::Expr>,
    named: Vec<(String, &'a syn::Expr)>,
}

fn collect_bitor_variants(expr: &syn::Expr) -> Option<Vec<String>> {
    let mut names = Vec::new();
    collect_bitor_variants_inner(expr, &mut names)?;
    if names.len() >= 2 { Some(names) } else { None }
}

fn collect_bitor_variants_inner(expr: &syn::Expr, names: &mut Vec<String>) -> Option<()> {
    match expr {
        syn::Expr::Binary(syn::ExprBinary {
            left,
            op: syn::BinOp::BitOr(_),
            right,
            ..
        }) => {
            collect_bitor_variants_inner(left, names)?;
            collect_bitor_variants_inner(right, names)?;
            Some(())
        }
        syn::Expr::Path(syn::ExprPath { path, .. })
            if path.leading_colon.is_none() && path.segments.len() == 1 =>
        {
            names.push(path.segments[0].ident.to_string());
            Some(())
        }
        _ => None,
    }
}

impl Encoder<'_> {
    fn find_attribute_type(&self, path: &syn::Path) -> Option<AttributeInfo> {
        let mut segments: Vec<String> = path.segments.iter().map(|s| s.ident.to_string()).collect();

        let name = segments.pop()?;
        let attr_name = format!("{name}Attribute");

        let explicit_namespace = if segments.is_empty() {
            None
        } else {
            Some(segments.join("."))
        };

        let namespaces: Vec<String> = if let Some(ns) = explicit_namespace {
            vec![ns]
        } else {
            let parts: Vec<&str> = self.namespace.split('.').collect();
            let mut nss: Vec<String> = (1..=parts.len())
                .rev()
                .map(|len| parts[..len].join("."))
                .collect();
            for use_item in &self.file.uses {
                if let Some(ns) = glob_use_namespace(use_item)
                    && !nss.contains(&ns)
                {
                    nss.push(ns);
                }
            }
            nss
        };

        for ns in &namespaces {
            if let Some(info) = self
                .find_in_reference(ns, &attr_name)
                .or_else(|| self.find_in_index(ns, &attr_name))
            {
                return Some(info);
            }
        }

        None
    }

    fn find_in_reference(&self, namespace: &str, attr_name: &str) -> Option<AttributeInfo> {
        let mut constructors = vec![];
        let mut properties = vec![];

        if let Some(reference) = self.output.reference() {
            for typedef in reference.get(namespace, attr_name) {
                if typedef.category() == metadata::reader::TypeCategory::Attribute {
                    for method in typedef.methods() {
                        if method.name() == ".ctor" {
                            let sig = method.signature(&[]);
                            constructors.push(sig.types);
                        }
                    }
                    for field in typedef.fields() {
                        let flags = field.flags();
                        if flags.contains(metadata::FieldAttributes::Public)
                            && !flags.contains(metadata::FieldAttributes::Static)
                            && !flags.contains(metadata::FieldAttributes::Literal)
                            && !flags.contains(metadata::FieldAttributes::SpecialName)
                        {
                            properties.push((field.name().to_string(), field.ty()));
                        }
                    }
                }
            }
        }

        if constructors.is_empty() && properties.is_empty() {
            None
        } else {
            Some(AttributeInfo {
                type_name: metadata::TypeName::named(namespace, attr_name),
                constructors,
                properties,
            })
        }
    }

    fn find_in_index(&self, namespace: &str, attr_name: &str) -> Option<AttributeInfo> {
        let (_, item) = *self
            .index
            .namespaces
            .get(namespace)?
            .types
            .get(attr_name)?
            .first()?;
        let Item::Attribute(attr_item) = item else {
            return None;
        };

        let mut constructors = vec![];
        for method in &attr_item.methods {
            let types: Result<Vec<_>, _> = method
                .inputs
                .iter()
                .map(|arg| self.encode_type_in_attr_ns(namespace, &arg.ty))
                .collect();
            if let Ok(types) = types {
                constructors.push(types);
            }
        }

        let mut properties = vec![];
        for (prop_name, prop_ty) in &attr_item.properties {
            if let Ok(ty) = self.encode_type_in_attr_ns(namespace, prop_ty) {
                properties.push((prop_name.to_string(), ty));
            }
        }

        Some(AttributeInfo {
            type_name: metadata::TypeName::named(namespace, attr_name),
            constructors,
            properties,
        })
    }

    fn split_args<'a>(&self, args: &'a [syn::Expr]) -> Result<SplitArgs<'a>, Error> {
        let mut positional: Vec<&syn::Expr> = vec![];
        let mut named: Vec<(String, &syn::Expr)> = vec![];

        for arg in args {
            if let syn::Expr::Assign(syn::ExprAssign { left, right, .. }) = arg {
                if let syn::Expr::Path(syn::ExprPath { path, .. }) = left.as_ref()
                    && path.leading_colon.is_none()
                    && path.segments.len() == 1
                {
                    named.push((path.segments[0].ident.to_string(), right.as_ref()));
                    continue;
                }
                return self.err(arg, "expected `name = value` for named attribute argument");
            }
            if !named.is_empty() {
                return self.err(
                    arg,
                    "positional attribute arguments must come before named arguments",
                );
            }
            positional.push(arg);
        }

        Ok(SplitArgs { positional, named })
    }

    fn resolve_attribute_args(
        &self,
        attr: &syn::Attribute,
        info: &AttributeInfo,
        positional: &[&syn::Expr],
        named: &[(String, &syn::Expr)],
    ) -> Result<Vec<(String, metadata::Value)>, Error> {
        let mut last_type_error: Option<Error> = None;
        let mut ctor_values: Option<Vec<(String, metadata::Value)>> = None;

        for types in &info.constructors {
            if types.len() != positional.len() {
                continue;
            }

            let mut values = vec![];
            let mut type_error: Option<Error> = None;

            for (ty, arg) in types.iter().zip(positional.iter()) {
                match self.encode_attr_value(ty, arg) {
                    Ok(v) => values.push((String::new(), v)),
                    Err(e) => {
                        type_error = Some(e);
                        break;
                    }
                }
            }

            match type_error {
                None => {
                    ctor_values = Some(values);
                    break;
                }
                Some(e) => last_type_error = Some(e),
            }
        }

        let Some(mut result) = ctor_values else {
            if let Some(err) = last_type_error {
                return Err(err);
            } else {
                return self.err(attr, "no matching attribute constructor found");
            }
        };

        for (name, value_expr) in named {
            let prop_ty = info
                .properties
                .iter()
                .find(|(pname, _)| pname == name)
                .map(|(_, ty)| ty)
                .ok_or_else(|| self.error(attr, &format!("attribute has no property `{name}`")))?;
            let value = self.encode_attr_value(prop_ty, value_expr)?;
            result.push((name.clone(), value));
        }

        Ok(result)
    }

    fn encode_attr_value(
        &self,
        ty: &metadata::Type,
        value: &syn::Expr,
    ) -> Result<metadata::Value, Error> {
        match ty {
            metadata::Type::String => match value {
                syn::Expr::Lit(syn::ExprLit {
                    lit: syn::Lit::Str(s),
                    ..
                }) => Ok(metadata::Value::Utf8(s.value())),
                _ => self.err(value, "expected string literal"),
            },
            metadata::Type::ClassName(tn) if tn == ("System", "Type") => match value {
                syn::Expr::Path(syn::ExprPath { path, .. }) => match self.encode_path(path)? {
                    metadata::Type::ClassName(tn) | metadata::Type::ValueName(tn) => {
                        Ok(metadata::Value::TypeName(tn))
                    }
                    _ => self.err(value, "expected type name"),
                },
                _ => self.err(value, "expected type path"),
            },
            metadata::Type::ValueName(tn) | metadata::Type::ClassName(tn) => {
                if let syn::Expr::Path(syn::ExprPath { path, .. }) = value
                    && path.leading_colon.is_none()
                    && path.segments.len() == 1
                {
                    let variant_name = path.segments[0].ident.to_string();
                    let inner = self.find_enum_variant_value(tn, &variant_name, value)?;
                    return Ok(metadata::Value::EnumValue(tn.clone(), Box::new(inner)));
                }
                if self.enum_is_flags(tn) {
                    if let Some(names) = collect_bitor_variants(value) {
                        let mut combined: i32 = 0;
                        for name in &names {
                            let inner = self.find_enum_variant_value(tn, name, value)?;
                            let metadata::Value::I32(v) = inner else {
                                return self
                                    .err(value, &format!("expected `{}` variant name", tn.name));
                            };
                            combined |= v;
                        }
                        return Ok(metadata::Value::EnumValue(
                            tn.clone(),
                            Box::new(metadata::Value::I32(combined)),
                        ));
                    }
                    if let syn::Expr::Lit(syn::ExprLit {
                        lit: syn::Lit::Int(int),
                        ..
                    }) = value
                        && let Ok(v) = int.base10_parse::<i32>()
                    {
                        return Ok(metadata::Value::EnumValue(
                            tn.clone(),
                            Box::new(metadata::Value::I32(v)),
                        ));
                    }
                }
                self.err(value, &format!("expected `{}` variant name", tn.name))
            }
            _ => self.encode_value(ty, value),
        }
    }

    fn enum_is_flags(&self, tn: &metadata::TypeName) -> bool {
        if let Some(reference) = self.output.reference() {
            for typedef in reference.get(&tn.namespace, &tn.name) {
                if typedef.category() == metadata::reader::TypeCategory::Enum
                    && metadata::HasAttributes::attributes(&typedef).any(|attr| {
                        attr.name() == "FlagsAttribute"
                            && attr.ctor().parent().namespace() == "System"
                    })
                {
                    return true;
                }
            }
        }
        if let Some(ns) = self.index.namespaces.get(&tn.namespace)
            && let Some(variants) = ns.types.get(&tn.name)
            && let Some((_, Item::Enum(enum_item))) = variants.first()
            && enum_item.attrs.iter().any(|a| a.path().is_ident("flags"))
        {
            return true;
        }
        false
    }

    fn find_enum_variant_value(
        &self,
        tn: &metadata::TypeName,
        variant_name: &str,
        spanned: &syn::Expr,
    ) -> Result<metadata::Value, Error> {
        if let Some(reference) = self.output.reference() {
            for typedef in reference.get(&tn.namespace, &tn.name) {
                if typedef.category() == metadata::reader::TypeCategory::Enum {
                    for field in typedef.fields() {
                        if field.flags().contains(metadata::FieldAttributes::Literal)
                            && field.name() == variant_name
                            && let Some(constant) = field.constant()
                        {
                            return Ok(match constant.value() {
                                metadata::Value::I32(v) => metadata::Value::I32(v),
                                metadata::Value::U32(v) => metadata::Value::I32(v as i32),
                                other => {
                                    return self.err(
                                        spanned,
                                        &format!("unsupported enum constant type: {other:?}"),
                                    );
                                }
                            });
                        }
                    }
                }
            }
        }

        if let Some(ns) = self.index.namespaces.get(&tn.namespace)
            && let Some(variants) = ns.types.get(&tn.name)
            && let Some((_, Item::Enum(enum_item))) = variants.first()
        {
            for variant in &enum_item.variants {
                if variant.ident == variant_name
                    && let Some((_, discriminant)) = &variant.discriminant
                {
                    let result = self
                        .encode_value(&metadata::Type::I32, discriminant)
                        .or_else(|_| {
                            self.encode_value(&metadata::Type::U32, discriminant)
                                .map(|v| match v {
                                    metadata::Value::U32(n) => metadata::Value::I32(n as i32),
                                    other => other,
                                })
                        });
                    return result;
                }
            }
        }

        self.err(spanned, "enum variant not found")
    }

    pub fn resolve_attribute_ref(&self, attr: &syn::Attribute) -> Result<AttributeRef, Error> {
        let path = attr.path();

        let info = self
            .find_attribute_type(path)
            .ok_or_else(|| self.error(attr, "attribute type not found"))?;

        let raw_args: Vec<syn::Expr> = match &attr.meta {
            syn::Meta::Path(_) => vec![],
            syn::Meta::List(_) => attr
                .parse_args_with(
                    syn::punctuated::Punctuated::<syn::Expr, syn::Token![,]>::parse_terminated,
                )
                .map_err(|e| {
                    let start = e.span().start();
                    Error::new(&e.to_string(), &self.file.source, start.line, start.column)
                })?
                .into_iter()
                .collect(),
            syn::Meta::NameValue(_) => {
                return self.err(attr, "attribute cannot use top-level `name = value` syntax");
            }
        };

        let split = self.split_args(&raw_args)?;

        let args = self.resolve_attribute_args(attr, &info, &split.positional, &split.named)?;

        Ok(AttributeRef {
            type_name: info.type_name,
            args,
        })
    }

    pub fn encode_named_attribute(
        &mut self,
        has_attribute: metadata::writer::HasAttribute,
        attr_ref: &AttributeRef,
    ) {
        let attribute_typeref = self
            .output
            .TypeRef(&attr_ref.type_name.namespace, &attr_ref.type_name.name);

        let signature = metadata::Signature {
            flags: metadata::MethodCallAttributes::HASTHIS,
            return_type: metadata::Type::Void,
            types: attr_ref
                .args
                .iter()
                .filter(|(name, _)| name.is_empty())
                .map(|(_, v)| v.ty())
                .collect(),
        };

        let ctor = self.output.MemberRef(
            ".ctor",
            &signature,
            metadata::writer::MemberRefParent::TypeRef(attribute_typeref),
        );

        self.output.Attribute(
            has_attribute,
            metadata::writer::AttributeType::MemberRef(ctor),
            &attr_ref.args,
        );
    }

    pub fn encode_native_typedef_attribute(&mut self, target: metadata::writer::HasAttribute) {
        let attr_ref = AttributeRef {
            type_name: metadata::TypeName::named(METADATA_NAMESPACE, "NativeTypedefAttribute"),
            args: vec![],
        };
        self.encode_named_attribute(target, &attr_ref);
    }

    pub fn emit_pseudo_attribute(
        &mut self,
        target: metadata::writer::HasAttribute,
        pseudo: &PseudoAttr,
        attr: &syn::Attribute,
    ) -> Result<(), Error> {
        let attr_ref = if matches!(attr.meta, syn::Meta::Path(_)) {
            AttributeRef {
                type_name: metadata::TypeName::named(METADATA_NAMESPACE, pseudo.metadata),
                args: vec![],
            }
        } else {
            self.resolve_pseudo_attr_ref(attr, pseudo)?
        };
        self.encode_named_attribute(target, &attr_ref);
        Ok(())
    }

    fn resolve_pseudo_attr_ref(
        &self,
        attr: &syn::Attribute,
        pseudo: &PseudoAttr,
    ) -> Result<AttributeRef, Error> {
        let info = self
            .find_in_reference(METADATA_NAMESPACE, pseudo.metadata)
            .or_else(|| self.find_in_index(METADATA_NAMESPACE, pseudo.metadata))
            .ok_or_else(|| self.error(attr, "pseudo-attribute type not found"))?;

        let raw_args: Vec<syn::Expr> = match &attr.meta {
            syn::Meta::Path(_) => vec![],
            syn::Meta::List(_) => attr
                .parse_args_with(
                    syn::punctuated::Punctuated::<syn::Expr, syn::Token![,]>::parse_terminated,
                )
                .map_err(|e| {
                    let start = e.span().start();
                    Error::new(&e.to_string(), &self.file.source, start.line, start.column)
                })?
                .into_iter()
                .collect(),
            syn::Meta::NameValue(_) => {
                return self.err(attr, "attribute cannot use top-level `name = value` syntax");
            }
        };

        let split = self.split_args(&raw_args)?;
        let args = if let Some(prop) = pseudo.prop {
            if split.positional.len() != 1 || !split.named.is_empty() {
                return self.err(attr, &format!("`{}` takes a single value", pseudo.short));
            }
            let named = [(prop.to_string(), split.positional[0])];
            self.resolve_attribute_args(attr, &info, &[], &named)?
        } else {
            self.resolve_attribute_args(attr, &info, &split.positional, &split.named)?
        };

        Ok(AttributeRef {
            type_name: info.type_name,
            args,
        })
    }

    pub fn emit_arch_attribute(&mut self, target: metadata::writer::HasAttribute, arch_bits: i32) {
        let attr_ref = AttributeRef {
            type_name: metadata::TypeName::named(
                METADATA_NAMESPACE,
                "SupportedArchitectureAttribute",
            ),
            args: vec![(String::new(), metadata::Value::I32(arch_bits))],
        };
        self.encode_named_attribute(target, &attr_ref);
    }

    pub fn emit_align_attribute(&mut self, target: metadata::writer::HasAttribute, alignment: u16) {
        let attr_ref = AttributeRef {
            type_name: metadata::TypeName::named(METADATA_NAMESPACE, "AlignmentAttribute"),
            args: vec![(String::new(), metadata::Value::I32(alignment as i32))],
        };
        self.encode_named_attribute(target, &attr_ref);
    }

    pub fn emit_bitfield_attribute(
        &mut self,
        target: metadata::writer::HasAttribute,
        name: &str,
        offset: u32,
        width: u32,
    ) {
        let attr_ref = AttributeRef {
            type_name: metadata::TypeName::named(METADATA_NAMESPACE, "NativeBitfieldAttribute"),
            args: vec![
                (String::new(), metadata::Value::Utf8(name.to_string())),
                (String::new(), metadata::Value::I64(offset as i64)),
                (String::new(), metadata::Value::I64(width as i64)),
            ],
        };
        self.encode_named_attribute(target, &attr_ref);
    }

    pub fn is_guid_attribute(&self, attr: &syn::Attribute) -> bool {
        self.find_attribute_type(attr.path())
            .is_some_and(|info| &info.type_name == ("Windows.Foundation.Metadata", "GuidAttribute"))
    }

    pub fn is_exclusive_to_attribute(&self, attr: &syn::Attribute) -> bool {
        self.find_attribute_type(attr.path()).is_some_and(|info| {
            &info.type_name == ("Windows.Foundation.Metadata", "ExclusiveToAttribute")
        })
    }

    pub fn encode_guid_pseudo_attrs(
        &mut self,
        target: metadata::writer::HasAttribute,
        attrs: &[syn::Attribute],
    ) -> Result<bool, Error> {
        let already_has_guid = attrs.iter().any(|attr| {
            self.is_guid_attribute(attr)
                || attr.path().is_ident("guid")
                || attr.path().is_ident("no_guid")
        });

        for attr in attrs {
            if attr.path().is_ident("guid") {
                let lit: syn::LitInt = attr
                    .parse_args()
                    .map_err(|_| self.error(attr, "`#[guid]` requires a single u128 literal"))?;
                let v = parse_guid_u128(&lit)
                    .map_err(|_| self.error(attr, "invalid u128 literal in `#[guid]`"))?;
                let (d1, d2, d3, d4) = guid::u128_to_guid(v);
                guid::emit_guid_attribute(self.output, target, d1, d2, d3, d4);
            } else if attr.path().is_ident("no_guid") && !matches!(attr.meta, syn::Meta::Path(_)) {
                return self.err(attr, "`#[no_guid]` attribute does not accept arguments");
            }
        }

        Ok(already_has_guid)
    }

    pub fn encode_attrs(
        &mut self,
        has_attribute: metadata::writer::HasAttribute,
        attrs: &[syn::Attribute],
        skip: &[&str],
    ) -> Result<(), Error> {
        for attr in attrs {
            let path = attr.path();

            if path.is_ident("win32") || path.is_ident("winrt") || path.is_ident("arch") {
                continue;
            }

            if skip.iter().any(|s| path.is_ident(s)) {
                continue;
            }

            // A naturalized pseudo-attribute (short SAL/IDL spelling) maps to its metadata
            // attribute via the shared table; the fully-qualified spelling still resolves
            // generically below.
            if let Some(pseudo) = path
                .get_ident()
                .and_then(|i| pseudo_by_short(&i.to_string()))
            {
                self.emit_pseudo_attribute(has_attribute, pseudo, attr)?;
                continue;
            }

            let attr_ref = self.resolve_attribute_ref(attr)?;
            self.encode_named_attribute(has_attribute, &attr_ref);
        }

        Ok(())
    }
}