dear-imgui-winit 0.18.0

Winit platform backend for dear-imgui-rs
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
use std::cell::RefCell;
use std::rc::{Rc, Weak};
use std::sync::Arc;

use dear_imgui_rs::{ContextId, ContextLifecycle};
use winit::window::{Window, WindowId};

use super::WinitPlatformError;
use super::coordinates::{
    observe_client_geometry, request_client_geometry, viewport_target_dpi_scale,
};
use super::runtime::RuntimeControl;
use super::viewport_data::{ClientGeometryReconciliationAction, ViewportData};

struct RegisteredRuntime {
    context_raw: *mut dear_imgui_rs::sys::ImGuiContext,
    context_id: ContextId,
    control: Weak<RuntimeControl>,
}

thread_local! {
    static RUNTIMES: RefCell<Vec<RegisteredRuntime>> = const { RefCell::new(Vec::new()) };
}

pub(super) struct ViewportEntry {
    identity: ViewportIdentity,
    data: Box<ViewportData>,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) struct FailedViewport {
    identity: ViewportIdentity,
    viewport_id: u32,
    platform_user_data: usize,
    platform_handle: usize,
    platform_handle_raw: usize,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) struct ViewportIdentity {
    context: usize,
    address: usize,
}

impl ViewportIdentity {
    pub(super) fn capture(
        context: *mut dear_imgui_rs::sys::ImGuiContext,
        viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
    ) -> Self {
        Self {
            context: context as usize,
            address: viewport as usize,
        }
    }

    pub(super) unsafe fn resolve(self) -> Option<*mut dear_imgui_rs::sys::ImGuiViewport> {
        let viewport = unsafe {
            dear_imgui_rs::sys::ImGuiContext_FindLiveViewportByAddress(
                self.context as *mut dear_imgui_rs::sys::ImGuiContext,
                self.address,
            )
        };
        (!viewport.is_null()).then_some(viewport)
    }
}

impl FailedViewport {
    unsafe fn capture(
        context: *mut dear_imgui_rs::sys::ImGuiContext,
        viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
    ) -> Self {
        let viewport_ref = unsafe { &*viewport };
        Self {
            identity: ViewportIdentity::capture(context, viewport),
            viewport_id: viewport_ref.ID,
            platform_user_data: viewport_ref.PlatformUserData as usize,
            platform_handle: viewport_ref.PlatformHandle as usize,
            platform_handle_raw: viewport_ref.PlatformHandleRaw as usize,
        }
    }

    fn matches_address(self, viewport: *mut dear_imgui_rs::sys::ImGuiViewport) -> bool {
        self.identity.address == viewport as usize
    }

    unsafe fn reassert_close(self) -> bool {
        let Some(viewport) = (unsafe { self.identity.resolve() }) else {
            return false;
        };
        let viewport_ref = unsafe { &mut *viewport };
        if viewport_ref.ID != self.viewport_id
            || viewport_ref.PlatformUserData as usize != self.platform_user_data
            || viewport_ref.PlatformHandle as usize != self.platform_handle
            || viewport_ref.PlatformHandleRaw as usize != self.platform_handle_raw
        {
            return false;
        }
        viewport_ref.PlatformRequestClose = true;
        true
    }
}

impl ViewportEntry {
    fn data_ptr(&self) -> *mut ViewportData {
        std::ptr::from_ref::<ViewportData>(&self.data).cast_mut()
    }

    fn matches_viewport(&self, viewport: *mut dear_imgui_rs::sys::ImGuiViewport) -> bool {
        viewport as usize == self.identity.address
    }

    unsafe fn resolve_viewport(&self) -> Option<*mut dear_imgui_rs::sys::ImGuiViewport> {
        unsafe { self.identity.resolve() }
    }

    unsafe fn native_ownership_loss(
        &self,
        viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
    ) -> Option<&'static str> {
        debug_assert!(self.matches_viewport(viewport));
        let viewport = unsafe { &*viewport };
        if viewport.PlatformUserData != self.data_ptr().cast() {
            Some("PlatformUserData")
        } else if viewport.PlatformHandle != self.data.window_ptr().cast_mut().cast() {
            Some("PlatformHandle")
        } else if !viewport.PlatformHandleRaw.is_null() {
            Some("PlatformHandleRaw")
        } else {
            None
        }
    }

    unsafe fn native_fields_are_owned(&self) -> bool {
        let Some(viewport) = (unsafe { self.resolve_viewport() }) else {
            return false;
        };
        unsafe { self.native_ownership_loss(viewport).is_none() }
    }

    fn viewport_id(&self) -> Option<u32> {
        let viewport = unsafe { self.resolve_viewport()? };
        Some(unsafe { (*viewport).ID })
    }

    pub(super) fn detach_and_drop(self) {
        // Resolve through Dear ImGui's complete internal viewport list before touching native
        // storage. `PlatformIO.Viewports` intentionally omits hidden viewports, and a destroyed
        // viewport must never be reached through the address retained by this sidecar.
        if let Some(viewport) = unsafe { self.resolve_viewport() } {
            // SAFETY: the native registry returned this exact still-live viewport address.
            let viewport = unsafe { &mut *viewport };
            if viewport.PlatformUserData == self.data_ptr().cast() {
                viewport.PlatformUserData = std::ptr::null_mut();
            }
            if viewport.PlatformHandle == self.data.window_ptr().cast_mut().cast() {
                viewport.PlatformHandle = std::ptr::null_mut();
            }
        }
    }
}

pub(super) fn register_runtime(control: &Rc<RuntimeControl>) {
    RUNTIMES.with(|runtimes| {
        let mut runtimes = runtimes.borrow_mut();
        runtimes.retain(|entry| entry.control.strong_count() > 0);
        debug_assert!(
            !runtimes
                .iter()
                .any(|entry| entry.context_id == control.binding().id())
        );
        runtimes.push(RegisteredRuntime {
            context_raw: control.context_raw(),
            context_id: control.binding().id(),
            control: Rc::downgrade(control),
        });
    });
}

pub(super) fn unregister_runtime(context: ContextId) {
    RUNTIMES.with(|runtimes| {
        runtimes
            .borrow_mut()
            .retain(|entry| entry.context_id != context);
    });
}

pub(super) fn runtime_for_context(
    context_raw: *mut dear_imgui_rs::sys::ImGuiContext,
) -> Option<Rc<RuntimeControl>> {
    if context_raw.is_null() {
        return None;
    }

    RUNTIMES.with(|runtimes| {
        let mut runtimes = runtimes.borrow_mut();
        runtimes.retain(|entry| entry.control.strong_count() > 0);
        runtimes
            .iter()
            .find(|entry| entry.context_raw == context_raw)
            .and_then(|entry| entry.control.upgrade())
    })
}

pub(super) fn with_current_runtime<R>(
    callback: impl FnOnce(&Rc<RuntimeControl>) -> R,
) -> Option<R> {
    // SAFETY: this reads the current Context pointer without dereferencing it.
    let context_raw = unsafe { dear_imgui_rs::sys::igGetCurrentContext() };
    let control = runtime_for_context(context_raw)?;
    if !control.is_callback_accessible() {
        return None;
    }

    match control.binding().lifecycle() {
        ContextLifecycle::Alive => control
            .binding()
            .try_with_bound_context(|| callback(&control))
            .ok(),
        ContextLifecycle::Dropping if control.teardown_callbacks_active() => {
            // The platform attachment opened this narrow callback window from a
            // ContextTeardown capability and verified that this raw Context is current.
            Some(callback(&control))
        }
        ContextLifecycle::Dropping | ContextLifecycle::NativeDestroyed => None,
        _ => None,
    }
}

pub(super) fn insert_viewport_data(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
    data: ViewportData,
) -> Result<*mut ViewportData, WinitPlatformError> {
    if viewport.is_null() {
        return Err(WinitPlatformError::ForeignPlatformUserData);
    }

    let mut viewports = control.viewports.borrow_mut();
    if viewports
        .iter()
        .any(|entry| entry.matches_viewport(viewport))
    {
        return Err(WinitPlatformError::ForeignPlatformUserData);
    }

    let mut data = Box::new(data);
    let data_ptr = std::ptr::from_mut::<ViewportData>(&mut data);
    viewports.push(ViewportEntry {
        identity: ViewportIdentity::capture(control.context_raw(), viewport),
        data,
    });
    Ok(data_ptr)
}

pub(super) fn record_failed_viewport(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
) {
    if viewport.is_null() {
        return;
    }
    let failure = unsafe { FailedViewport::capture(control.context_raw(), viewport) };
    clear_failed_viewport(control, viewport);
    control.failed_viewports.borrow_mut().push(failure);
    unsafe { (*viewport).PlatformRequestClose = true };
}

pub(super) fn clear_failed_viewport(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
) {
    if viewport.is_null() {
        return;
    }
    control
        .failed_viewports
        .borrow_mut()
        .retain(|failure| !failure.matches_address(viewport));
}

pub(super) fn reassert_failed_viewports(control: &RuntimeControl) {
    control
        .failed_viewports
        .borrow_mut()
        .retain(|failure| unsafe { failure.reassert_close() });
}

pub(super) fn owns_viewport_data(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
    data: *mut ViewportData,
) -> bool {
    if viewport.is_null() || data.is_null() {
        return false;
    }
    control.viewports.borrow().iter().any(|entry| {
        entry.matches_viewport(viewport)
            && std::ptr::eq(entry.data_ptr(), data)
            && unsafe { entry.native_fields_are_owned() }
    })
}

pub(super) fn with_viewport_data<R>(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
    callback: impl FnOnce(&ViewportData) -> R,
) -> Option<R> {
    if viewport.is_null() {
        return None;
    }
    let viewports = control.viewports.borrow();
    let entry = viewports.iter().find(|entry| {
        entry.matches_viewport(viewport)
            // SAFETY: `viewport` is live for the callback or Context-bound event routing call.
            && unsafe { entry.native_fields_are_owned() }
    })?;
    Some(callback(&entry.data))
}

/// Resolves a native Winit window through the authoritative runtime registry.
///
/// Dear ImGui's public `PlatformIO.Viewports` vector is a per-frame visible snapshot and may omit
/// hidden or transitional viewports. Event routing must therefore resolve by the Winit window ID
/// first, then validate the retained native ownership before exposing the viewport pointer.
pub(super) fn with_viewport_data_for_window<R>(
    control: &RuntimeControl,
    window_id: WindowId,
    callback: impl FnOnce(*mut dear_imgui_rs::sys::ImGuiViewport, &ViewportData) -> R,
) -> Option<R> {
    let viewports = control.viewports.borrow();
    let entry = viewports
        .iter()
        .find(|entry| !entry.data.is_main() && entry.data.window().id() == window_id)?;
    let viewport = unsafe { entry.resolve_viewport()? };
    if unsafe { entry.native_ownership_loss(viewport).is_some() } {
        return None;
    }
    Some(callback(viewport, &entry.data))
}

pub(super) fn window_for_viewport(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
) -> Option<Arc<Window>> {
    with_viewport_data(control, viewport, |data| Arc::clone(data.window()))
}

pub(super) fn secondary_viewport_windows(control: &RuntimeControl) -> Vec<Arc<Window>> {
    control
        .viewports
        .borrow()
        .iter()
        .filter(|entry| !entry.data.is_main())
        .map(|entry| Arc::clone(entry.data.window()))
        .collect()
}

pub(super) fn request_geometry_refresh_for_window(
    control: &RuntimeControl,
    window_id: WindowId,
    position: bool,
    size: bool,
) -> bool {
    if let Some(entry) = control
        .viewports
        .borrow()
        .iter()
        .find(|entry| entry.data.window().id() == window_id)
    {
        entry.data.request_geometry_refresh(position, size);
        true
    } else {
        false
    }
}

pub(super) fn apply_pending_geometry_refresh(control: &RuntimeControl) {
    for entry in control.viewports.borrow().iter() {
        let mut refresh = entry.data.take_geometry_refresh();
        if refresh.is_empty() {
            continue;
        }
        let Some(viewport) = (unsafe { entry.resolve_viewport() }) else {
            continue;
        };
        if unsafe { entry.native_ownership_loss(viewport).is_some() } {
            continue;
        }
        if entry.data.has_client_geometry_reconciliation() {
            let window = entry.data.window();
            let Some(observed) = observe_client_geometry(window) else {
                entry.data.cancel_client_geometry_reconciliation();
                refresh.position = true;
                refresh.size = true;
                unsafe {
                    (*viewport).PlatformRequestMove |= refresh.position;
                    (*viewport).PlatformRequestResize |= refresh.size;
                }
                continue;
            };
            let Some(decision) = entry.data.observe_client_geometry_reconciliation(
                window.is_visible() == Some(true),
                observed.position,
                observed.size,
                observed.decoration_offset,
            ) else {
                continue;
            };
            match decision.action {
                ClientGeometryReconciliationAction::Wait => {
                    // Waiting for a native geometry or visibility event must not consume the
                    // transaction's only refresh. The event that makes progress requests the
                    // main-window redraw, so retaining this state does not create a busy loop.
                    entry
                        .data
                        .request_geometry_refresh(refresh.position, refresh.size);
                    continue;
                }
                ClientGeometryReconciliationAction::ApplyTarget => {
                    let dpi_scale = unsafe { viewport_target_dpi_scale(viewport) };
                    request_client_geometry(window, decision.position, decision.size, dpi_scale);
                    continue;
                }
                ClientGeometryReconciliationAction::PublishNative => {
                    refresh.position = true;
                    refresh.size = true;
                }
            }
        }
        unsafe {
            (*viewport).PlatformRequestMove |= refresh.position;
            (*viewport).PlatformRequestResize |= refresh.size;
        }
    }
}

#[cfg(target_os = "windows")]
pub(super) fn viewport_id_for_native_window(
    control: &RuntimeControl,
    native_window: usize,
) -> Option<u32> {
    control
        .viewports
        .borrow()
        .iter()
        .find(|entry| entry.data.native_window_id() == native_window)
        .and_then(ViewportEntry::viewport_id)
}

pub(super) fn remove_viewport_data(
    control: &RuntimeControl,
    viewport: *mut dear_imgui_rs::sys::ImGuiViewport,
) -> bool {
    if viewport.is_null() {
        return false;
    }

    let entry = {
        let mut viewports = control.viewports.borrow_mut();
        let Some(index) = viewports.iter().position(|entry| {
            entry.matches_viewport(viewport)
                // SAFETY: the callback supplies a live viewport for the current Context.
                && unsafe { entry.native_fields_are_owned() }
        }) else {
            return false;
        };
        viewports.remove(index)
    };
    entry.detach_and_drop();
    true
}

fn discard_destroyed_viewport_data(control: &RuntimeControl) {
    control.viewports.borrow_mut().retain(|entry| {
        // SAFETY: callers hold the current live Context. Native code compares the retained
        // integer address against that Context's authoritative internal viewport list.
        unsafe { entry.resolve_viewport().is_some() }
    });
}

pub(super) unsafe fn preflight_viewport_ownership(
    control: &RuntimeControl,
    platform_io: *const dear_imgui_rs::sys::ImGuiPlatformIO,
) -> Result<(), WinitPlatformError> {
    if platform_io.is_null() {
        return Err(WinitPlatformError::ContextMismatch);
    }
    let native_viewports = unsafe { &(*platform_io).Viewports };
    let count = usize::try_from(native_viewports.Size)
        .map_err(|_| WinitPlatformError::ForeignPlatformUserData)?;
    if native_viewports.Capacity < native_viewports.Size
        || count > 0 && native_viewports.Data.is_null()
    {
        return Err(WinitPlatformError::ForeignPlatformUserData);
    }
    let native_viewports = if count == 0 {
        &[][..]
    } else {
        unsafe { std::slice::from_raw_parts(native_viewports.Data, count) }
    };
    discard_destroyed_viewport_data(control);
    let entries = control.viewports.borrow();

    for entry in entries.iter() {
        let Some(viewport) = (unsafe { entry.resolve_viewport() }) else {
            continue;
        };
        if let Some(field) = unsafe { entry.native_ownership_loss(viewport) } {
            return Err(WinitPlatformError::ViewportOwnershipLost {
                viewport_id: unsafe { (*viewport).ID },
                field,
            });
        }
    }
    for &viewport in native_viewports {
        if viewport.is_null() {
            return Err(WinitPlatformError::ForeignPlatformUserData);
        }
        let viewport = unsafe { &*viewport };
        let viewport_ptr = std::ptr::from_ref(viewport).cast_mut();
        if (!viewport.PlatformUserData.is_null()
            || !viewport.PlatformHandle.is_null()
            || !viewport.PlatformHandleRaw.is_null())
            && !entries.iter().any(|entry| {
                entry.matches_viewport(viewport_ptr) && unsafe { entry.native_fields_are_owned() }
            })
        {
            let field = if !viewport.PlatformUserData.is_null() {
                "PlatformUserData"
            } else if !viewport.PlatformHandle.is_null() {
                "PlatformHandle"
            } else {
                "PlatformHandleRaw"
            };
            return Err(WinitPlatformError::ViewportOwnershipLost {
                viewport_id: viewport.ID,
                field,
            });
        }
    }
    Ok(())
}