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
use super::*;
use std::collections::BTreeMap;

/// A reader of type information from Windows Metadata
pub struct TypeReader {
    types: BTreeMap<&'static str, BTreeMap<&'static str, TypeRow>>,
    nested: BTreeMap<tables::TypeDef, BTreeMap<&'static str, tables::TypeDef>>,
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug)]
enum TypeRow {
    TypeDef(tables::TypeDef),
    Function(tables::MethodDef),
    Constant(tables::Field),
}

impl TypeReader {
    pub fn get() -> &'static Self {
        use std::{mem::MaybeUninit, sync::Once};
        static ONCE: Once = Once::new();
        static mut VALUE: MaybeUninit<TypeReader> = MaybeUninit::uninit();

        ONCE.call_once(|| {
            // This is safe because `Once` provides thread-safe one-time initialization
            unsafe { VALUE = MaybeUninit::new(Self::new()) }
        });

        // This is safe because `call_once` has already been called.
        unsafe { &*VALUE.as_ptr() }
    }

    /// Insert WinRT metadata at the given paths
    ///
    /// # Panics
    ///
    /// This function panics if the if the files where the windows metadata are stored cannot be read.
    fn new() -> Self {
        let files = workspace_winmds();

        let mut types = BTreeMap::<&'static str, BTreeMap<&'static str, TypeRow>>::default();

        let mut nested =
            BTreeMap::<tables::TypeDef, BTreeMap<&'static str, tables::TypeDef>>::new();

        for file in files {
            let row_count = file.type_def_table().row_count;

            for row in 0..row_count {
                let def = tables::TypeDef(Row::new(row, TableIndex::TypeDef, file));
                let namespace = def.namespace();
                let name = trim_tick(def.name());

                if namespace.is_empty() {
                    continue;
                }

                let flags = def.flags();
                let extends = def.extends();

                if extends == ("System", "Attribute") {
                    continue;
                }

                types
                    .entry(namespace)
                    .or_default()
                    .entry(name)
                    .or_insert_with(|| TypeRow::TypeDef(def));

                if flags.interface() || flags.windows_runtime() {
                    continue;
                }

                if extends == ("", "") {
                    continue;
                }

                if extends != ("System", "Object") {
                    continue;
                }

                for field in def.fields() {
                    let name = field.name();

                    types
                        .entry(namespace)
                        .or_default()
                        .entry(name)
                        .or_insert_with(|| TypeRow::Constant(field));
                }

                for method in def.methods() {
                    let name = method.name();

                    types
                        .entry(namespace)
                        .or_default()
                        .entry(name)
                        .or_insert_with(|| TypeRow::Function(method));
                }
            }

            let row_count = file.nested_class_table().row_count;

            for row in 0..row_count {
                let row = tables::NestedClass(Row::new(row, TableIndex::NestedClass, file));
                let enclosed = row.nested_type();
                let enclosing = row.enclosing_type();
                let name = enclosed.name();

                nested.entry(enclosing).or_default().insert(name, enclosed);
            }
        }

        let exclude = &[
            ("Windows.Foundation", "HResult"),
            ("Windows.Win32.Com", "IUnknown"),
            ("Windows.Win32.Direct2D", "D2D_MATRIX_3X2_F"),
            ("Windows.Win32.SystemServices", "LARGE_INTEGER"),
            ("Windows.Win32.SystemServices", "ULARGE_INTEGER"),
            // TODO: remove once this is fixed: https://github.com/microsoft/win32metadata/issues/30
            ("Windows.Win32", "CFunctionDiscoveryNotificationWrapper"),
        ];

        for (namespace, name) in exclude {
            if let Some(value) = types.get_mut(*namespace) {
                value.remove(*name);
            }
        }

        Self { types, nested }
    }

    pub fn find_namespace(&'static self, find: &str) -> Option<&'static str> {
        self.types
            .keys()
            .find(|namespace| *namespace == &find)
            .copied()
    }

    /// Get all the namespace names that the [`TypeReader`] knows about
    pub fn namespaces(&'static self) -> impl Iterator<Item = &'static str> {
        self.types.keys().copied()
    }

    /// Get all types for a given namespace
    ///
    /// # Panics
    ///
    /// Panics if the namespace does not exist
    pub fn namespace_types(
        &'static self,
        namespace: &str,
    ) -> impl Iterator<Item = ElementType> + '_ {
        self.types[namespace]
            .values()
            .map(move |row| self.to_element_type(row))
    }

    // TODO: how to make this return an iterator?
    pub fn nested_types(&'static self, enclosing: &tables::TypeDef) -> Vec<tables::TypeDef> {
        self.nested
            .get(enclosing)
            .iter()
            .flat_map(|t| t.values())
            .copied()
            .collect()
    }

    pub fn resolve_type(&'static self, namespace: &str, name: &str) -> ElementType {
        if let Some(types) = self.types.get(namespace) {
            if let Some(row) = types.get(trim_tick(name)) {
                return self.to_element_type(row);
            }
        }

        panic!("Could not find type `{}.{}`", namespace, name);
    }

    fn to_element_type(&'static self, row: &TypeRow) -> ElementType {
        match row {
            TypeRow::TypeDef(row) => ElementType::from_type_def(*row, Vec::new()),
            TypeRow::Function(row) => ElementType::Function(types::Function(*row)),
            TypeRow::Constant(row) => ElementType::Constant(types::Constant(*row)),
        }
    }

    pub fn resolve_type_def(&'static self, namespace: &str, name: &str) -> tables::TypeDef {
        if let Some(types) = self.types.get(namespace) {
            if let Some(TypeRow::TypeDef(row)) = types.get(trim_tick(name)) {
                return *row;
            }
        }

        panic!("Could not find type def `{}.{}`", namespace, name);
    }

    pub fn resolve_type_ref(&'static self, type_ref: &tables::TypeRef) -> tables::TypeDef {
        if let ResolutionScope::TypeRef(scope) = type_ref.scope() {
            if let Some(scope) = self.nested.get(&scope.resolve()) {
                scope[type_ref.name()]
            } else {
                // TODO: workaround for https://github.com/microsoft/win32metadata/issues/127
                self.resolve_type_def("Windows.Win32.WindowsAccessibility", "IUIAutomation6")
            }
        } else {
            self.resolve_type_def(type_ref.namespace(), type_ref.name())
        }
    }

    #[cfg(test)]
    pub fn get_class(namespace: &str, name: &str) -> types::Class {
        if let ElementType::Class(value) = Self::get().resolve_type(namespace, name) {
            value.clone()
        } else {
            unexpected!();
        }
    }

    #[cfg(test)]
    pub fn get_struct(namespace: &str, name: &str) -> types::Struct {
        if let ElementType::Struct(value) = Self::get().resolve_type(namespace, name) {
            value.clone()
        } else {
            unexpected!();
        }
    }

    #[cfg(test)]
    pub fn get_enum(namespace: &str, name: &str) -> types::Enum {
        if let ElementType::Enum(value) = Self::get().resolve_type(namespace, name) {
            value.clone()
        } else {
            unexpected!();
        }
    }

    #[cfg(test)]
    pub fn get_interface(namespace: &str, name: &str) -> types::Interface {
        if let ElementType::Interface(value) = Self::get().resolve_type(namespace, name) {
            value.clone()
        } else {
            unexpected!();
        }
    }
}

fn trim_tick(name: &str) -> &str {
    match name.as_bytes().get(name.len() - 2) {
        Some(c) if *c == b'`' => &name[..name.len() - 2],
        _ => name,
    }
}