rfd 0.17.2

Rusty File Dialog
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

#![allow(non_snake_case)]

use std::ffi::c_void;
use windows_sys::core::{HRESULT, PCWSTR, PWSTR};
pub use windows_sys::{
    core::GUID,
    Win32::{
        Foundation::HWND,
        UI::Shell::{Common::COMDLG_FILTERSPEC, FILEOPENDIALOGOPTIONS, SIGDN, SIGDN_FILESYSPATH},
    },
};

pub(crate) type Result<T> = std::result::Result<T, HRESULT>;

#[inline]
pub(super) fn wrap_err(hresult: HRESULT) -> Result<()> {
    if hresult >= 0 {
        Ok(())
    } else {
        Err(hresult)
    }
}

#[inline]
unsafe fn read_to_string(ptr: *const u16) -> String {
    let mut cursor = ptr;

    while *cursor != 0 {
        cursor = cursor.add(1);
    }

    let slice = std::slice::from_raw_parts(ptr, cursor.offset_from(ptr) as usize);
    String::from_utf16(slice).unwrap()
}

#[repr(C)]
pub(super) struct Interface<T> {
    vtable: *mut T,
}

impl<T> Interface<T> {
    #[inline]
    pub(super) fn vtbl(&self) -> &T {
        unsafe { &*self.vtable }
    }
}

#[repr(C)]
pub(super) struct IUnknownV {
    __query_interface: usize,
    __add_ref: usize,
    pub(super) release: unsafe extern "system" fn(this: *mut c_void) -> u32,
}

pub(super) type IUnknown = Interface<IUnknownV>;

#[inline]
fn drop_impl(ptr: *mut c_void) {
    unsafe {
        ((*ptr.cast::<IUnknown>()).vtbl().release)(ptr);
    }
}

#[repr(C)]
pub(super) struct IShellItemV {
    base: IUnknownV,
    BindToHandler: unsafe extern "system" fn(
        this: *mut c_void,
        pbc: *mut c_void,
        bhid: *const GUID,
        riid: *const GUID,
        ppv: *mut *mut c_void,
    ) -> HRESULT,
    GetParent: unsafe extern "system" fn(this: *mut c_void, ppsi: *mut *mut c_void) -> HRESULT,
    GetDisplayName: unsafe extern "system" fn(
        this: *mut c_void,
        sigdnname: SIGDN,
        ppszname: *mut PWSTR,
    ) -> HRESULT,
    GetAttributes: usize,
    Compare: unsafe extern "system" fn(
        this: *mut c_void,
        psi: *mut c_void,
        hint: u32,
        piorder: *mut i32,
    ) -> HRESULT,
}

#[repr(transparent)]
pub(super) struct IShellItem(pub(super) *mut Interface<IShellItemV>);

impl IShellItem {
    pub(super) fn get_path(&self) -> Result<std::path::PathBuf> {
        let filename = unsafe {
            let mut dname = std::mem::MaybeUninit::uninit();
            wrap_err(((*self.0).vtbl().GetDisplayName)(
                self.0.cast(),
                SIGDN_FILESYSPATH,
                dname.as_mut_ptr(),
            ))?;

            let dname = dname.assume_init();
            let fname = read_to_string(dname);
            windows_sys::Win32::System::Com::CoTaskMemFree(dname.cast());
            fname
        };

        Ok(filename.into())
    }
}

impl Drop for IShellItem {
    fn drop(&mut self) {
        drop_impl(self.0.cast());
    }
}

#[repr(C)]
struct IShellItemArrayV {
    base: IUnknownV,
    BindToHandler: unsafe extern "system" fn(
        this: *mut c_void,
        pbc: *mut c_void,
        bhid: *const GUID,
        riid: *const GUID,
        ppvout: *mut *mut c_void,
    ) -> HRESULT,
    GetPropertyStore: usize,
    GetPropertyDescriptionList: usize,
    GetAttributes: usize,
    GetCount: unsafe extern "system" fn(this: *mut c_void, pdwnumitems: *mut u32) -> HRESULT,
    GetItemAt: unsafe extern "system" fn(
        this: *mut c_void,
        dwindex: u32,
        ppsi: *mut IShellItem,
    ) -> HRESULT,
    EnumItems:
        unsafe extern "system" fn(this: *mut c_void, ppenumshellitems: *mut *mut c_void) -> HRESULT,
}

#[repr(transparent)]
pub(super) struct IShellItemArray(*mut Interface<IShellItemArrayV>);

impl IShellItemArray {
    #[inline]
    pub(super) fn get_count(&self) -> Result<u32> {
        let mut count = 0;
        unsafe {
            wrap_err(((*self.0).vtbl().GetCount)(self.0.cast(), &mut count))?;
        }
        Ok(count)
    }

    #[inline]
    pub(super) fn get_item_at(&self, index: u32) -> Result<IShellItem> {
        let mut item = std::mem::MaybeUninit::uninit();
        unsafe {
            wrap_err(((*self.0).vtbl().GetItemAt)(
                self.0.cast(),
                index,
                item.as_mut_ptr(),
            ))?;
            Ok(item.assume_init())
        }
    }
}

impl Drop for IShellItemArray {
    fn drop(&mut self) {
        drop_impl(self.0.cast());
    }
}

#[repr(C)]
pub(super) struct IModalWindowV {
    base: IUnknownV,
    pub(super) Show: unsafe extern "system" fn(this: *mut c_void, owner: HWND) -> HRESULT,
}

/// <https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nn-shobjidl_core-ifiledialog>
#[repr(C)]
pub(super) struct IFileDialogV {
    pub(super) base: IModalWindowV,
    pub(super) SetFileTypes: unsafe extern "system" fn(
        this: *mut c_void,
        cfiletypes: u32,
        rgfilterspec: *const COMDLG_FILTERSPEC,
    ) -> HRESULT,
    SetFileTypeIndex: unsafe extern "system" fn(this: *mut c_void, ifiletype: u32) -> HRESULT,
    GetFileTypeIndex: unsafe extern "system" fn(this: *mut c_void, pifiletype: *mut u32) -> HRESULT,
    Advise: unsafe extern "system" fn(
        this: *mut c_void,
        pfde: *mut c_void,
        pdwcookie: *mut u32,
    ) -> HRESULT,
    Unadvise: unsafe extern "system" fn(this: *mut c_void, dwcookie: u32) -> HRESULT,
    pub(super) SetOptions:
        unsafe extern "system" fn(this: *mut c_void, fos: FILEOPENDIALOGOPTIONS) -> HRESULT,
    GetOptions:
        unsafe extern "system" fn(this: *mut c_void, pfos: *mut FILEOPENDIALOGOPTIONS) -> HRESULT,
    SetDefaultFolder: unsafe extern "system" fn(this: *mut c_void, psi: *mut c_void) -> HRESULT,
    pub(super) SetFolder: unsafe extern "system" fn(this: *mut c_void, psi: *mut c_void) -> HRESULT,
    GetFolder: unsafe extern "system" fn(this: *mut c_void, ppsi: *mut *mut c_void) -> HRESULT,
    GetCurrentSelection:
        unsafe extern "system" fn(this: *mut c_void, ppsi: *mut *mut c_void) -> HRESULT,
    pub(super) SetFileName:
        unsafe extern "system" fn(this: *mut c_void, pszname: PCWSTR) -> HRESULT,
    GetFileName: unsafe extern "system" fn(this: *mut c_void, pszname: *mut PWSTR) -> HRESULT,
    pub(super) SetTitle: unsafe extern "system" fn(this: *mut c_void, psztitle: PCWSTR) -> HRESULT,
    SetOkButtonLabel: unsafe extern "system" fn(this: *mut c_void, psztext: PCWSTR) -> HRESULT,
    SetFileNameLabel: unsafe extern "system" fn(this: *mut c_void, pszlabel: PCWSTR) -> HRESULT,
    pub(super) GetResult:
        unsafe extern "system" fn(this: *mut c_void, ppsi: *mut IShellItem) -> HRESULT,
    AddPlace: unsafe extern "system" fn(
        this: *mut c_void,
        psi: *mut c_void,
        fdap: windows_sys::Win32::UI::Shell::FDAP,
    ) -> HRESULT,
    pub(super) SetDefaultExtension:
        unsafe extern "system" fn(this: *mut c_void, pszdefaultextension: PCWSTR) -> HRESULT,
    Close: unsafe extern "system" fn(this: *mut c_void, hr: HRESULT) -> HRESULT,
    SetClientGuid: unsafe extern "system" fn(this: *mut c_void, guid: *const GUID) -> HRESULT,
    ClearClientData: unsafe extern "system" fn(this: *mut c_void) -> HRESULT,
    SetFilter: unsafe extern "system" fn(this: *mut c_void, pfilter: *mut c_void) -> HRESULT,
}

#[repr(transparent)]
pub(super) struct IFileDialog(pub(super) *mut Interface<IFileDialogV>);

impl Drop for IFileDialog {
    fn drop(&mut self) {
        drop_impl(self.0.cast());
    }
}

/// <https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nn-shobjidl_core-ifileopendialog>
#[repr(C)]
pub(super) struct IFileOpenDialogV {
    pub(super) base: IFileDialogV,
    /// <https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-ifileopendialog-getresults>
    GetResults:
        unsafe extern "system" fn(this: *mut c_void, ppenum: *mut IShellItemArray) -> HRESULT,
    GetSelectedItems:
        unsafe extern "system" fn(this: *mut c_void, ppsai: *mut *mut c_void) -> HRESULT,
}

#[repr(transparent)]
pub(super) struct IFileOpenDialog(pub(super) *mut Interface<IFileOpenDialogV>);

impl IFileOpenDialog {
    #[inline]
    pub(super) fn get_results(&self) -> Result<IShellItemArray> {
        let mut res = std::mem::MaybeUninit::uninit();
        unsafe {
            wrap_err((((*self.0).vtbl()).GetResults)(
                self.0.cast(),
                res.as_mut_ptr(),
            ))?;
            Ok(res.assume_init())
        }
    }
}

impl Drop for IFileOpenDialog {
    fn drop(&mut self) {
        drop_impl(self.0.cast());
    }
}