microsoft-webui-desktop 3.0.3

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

use std::fmt::Write;

use anyhow::Result;
use webview2_com::Microsoft::Web::WebView2::Win32::ICoreWebView2;
use webview2_com::{CoTaskMemPWSTR, ExecuteScriptCompletedHandler};

/// Physical measurements of native controls, translated at the CSS boundary.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub(in crate::windows) struct Metrics {
    pub(in crate::windows) left: i32,
    pub(in crate::windows) right: i32,
    pub(in crate::windows) height: i32,
    pub(in crate::windows) dpi: u32,
    pub(in crate::windows) minimum_height: u32,
}

impl Metrics {
    pub(in crate::windows) fn script(self) -> String {
        let mut script = String::with_capacity(1800);
        let _ = write!(
            script,
            "(()=>{{const left={},right={},height={};",
            logical(self.left, self.dpi),
            logical(self.right, self.dpi),
            logical(self.height, self.dpi).max(self.minimum_height),
        );
        script.push_str(
            "const key=Symbol.for('webui.titlebar.metrics');\
             const existing=window[key];\
             if(existing&&typeof existing.update==='function'){existing.update(left,right,height);return;}\
             const state={left,right,height,observer:null};\
             const apply=()=>{const root=document.documentElement;if(!root)return false;\
             const rtl=getComputedStyle(root).direction==='rtl';\
             const start=(rtl?state.right:state.left)+'px';\
             const end=(rtl?state.left:state.right)+'px';\
             const top=state.height+'px';\
             if(root.style.getPropertyValue('--webui-titlebar-inset-start')!==start)\
             root.style.setProperty('--webui-titlebar-inset-start',start);\
             if(root.style.getPropertyValue('--webui-titlebar-inset-end')!==end)\
             root.style.setProperty('--webui-titlebar-inset-end',end);\
             if(root.style.getPropertyValue('--webui-titlebar-height')!==top)\
             root.style.setProperty('--webui-titlebar-height',top);\
             if(!state.observer){state.observer=new MutationObserver(apply);\
             state.observer.observe(root,{attributes:true,attributeFilter:['dir','class','style']});}\
             return true;};\
             window[key]={update(l,r,h){state.left=l;state.right=r;state.height=h;apply();}};\
             if(!apply()){const pending=new MutationObserver(()=>{if(apply())pending.disconnect();});\
             pending.observe(document,{childList:true,subtree:true});}\
             if(document.readyState==='loading')document.addEventListener('DOMContentLoaded',apply,{once:true});\
             })();",
        );
        script
    }

    pub(in crate::windows) fn publish(self, webview: &ICoreWebView2) -> Result<()> {
        let script = CoTaskMemPWSTR::from(self.script().as_str());
        let completion = ExecuteScriptCompletedHandler::create(Box::new(|result, _| {
            if let Err(error) = result {
                eprintln!("WebUI: failed to apply native titlebar safe areas: {error}");
            }
            Ok(())
        }));
        // SAFETY: The live WebView2 copies script text and retains its handler.
        unsafe { webview.ExecuteScript(*script.as_ref().as_pcwstr(), &completion)? };
        Ok(())
    }
}

fn logical(value: i32, dpi: u32) -> u32 {
    let pixels = u32::try_from(value).unwrap_or(0);
    let logical = (u64::from(pixels) * 96).div_ceil(u64::from(dpi.max(1)));
    u32::try_from(logical).unwrap_or(u32::MAX)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn physical_safe_areas_round_outward_at_every_scale() {
        assert_eq!(logical(138, 96), 138);
        assert_eq!(logical(207, 144), 138);
        assert_eq!(logical(173, 120), 139);
        assert_eq!(logical(72, 144), 48);
        assert_eq!(logical(-1, 96), 0);
    }

    #[test]
    fn script_maps_physical_sides_to_document_direction_before_paint() {
        let script = Metrics {
            left: 0,
            right: 207,
            height: 72,
            dpi: 144,
            minimum_height: 0,
        }
        .script();
        assert!(script.contains("left=0,right=138,height=48"));
        assert!(script.contains("(rtl?state.right:state.left)"));
        assert!(script.contains("(rtl?state.left:state.right)"));
        assert!(script.contains("pending.disconnect()"));
        assert!(script.contains("'DOMContentLoaded',apply,{once:true}"));
    }

    #[test]
    fn taller_application_bands_do_not_shrink_to_the_native_caption_height() {
        let script = Metrics {
            height: 48,
            dpi: 96,
            minimum_height: 64,
            ..Default::default()
        }
        .script();
        assert!(script.contains("height=64"));
    }

    #[test]
    fn native_safe_areas_change_with_dpi_and_disappear_in_fullscreen() {
        let windowed = Metrics {
            left: 0,
            right: 207,
            height: 48,
            dpi: 144,
            minimum_height: 64,
        }
        .script();
        assert!(windowed.contains("left=0,right=138,height=64"));
        let fullscreen = Metrics {
            dpi: 144,
            ..Default::default()
        }
        .script();
        assert!(fullscreen.contains("left=0,right=0,height=0"));
    }

    #[test]
    fn direction_changes_reuse_one_bounded_root_observer() {
        let script = Metrics::default().script();
        assert!(script.contains("Symbol.for('webui.titlebar.metrics')"));
        assert!(script.contains("existing.update(left,right,height)"));
        assert!(script.contains("if(!state.observer)"));
        assert!(script.contains("attributeFilter:['dir','class','style']"));
        assert!(script.contains("getComputedStyle(root).direction==='rtl'"));
        assert!(script.contains("getPropertyValue('--webui-titlebar-inset-start')!==start"));
        assert!(script.contains("state.observer.observe(root,"));
        assert!(!script.contains("innerHTML"));
    }
}