cbf-compositor 0.1.0-alpha.1

Scene-based browser surface compositor for CBF applications.
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

use cbf::data::{
    context_menu::ContextMenu,
    drag::{DragOperation, DragStartRequest},
    ime::ImeBoundsUpdate,
};
#[cfg(feature = "chrome")]
use cbf_chrome::data::choice_menu::ChromeChoiceMenu;

use crate::{
    error::CompositorError,
    model::{CompositionItemId, HitTestPolicy, HitTestRegionSnapshot, Rect, SurfaceTarget},
    window::WindowHost,
};

#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) enum PlatformSurfaceHandle {
    MacCaContextId(u32),
}

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub(crate) struct PlatformInputState {
    pub(crate) active_item_id: Option<CompositionItemId>,
    pub(crate) hover_item_id: Option<CompositionItemId>,
    pub(crate) pointer_capture_item_id: Option<CompositionItemId>,
}

#[derive(Debug, Clone, PartialEq)]
pub(crate) struct PlatformSceneItem {
    pub(crate) item_id: CompositionItemId,
    pub(crate) target: SurfaceTarget,
    pub(crate) bounds: Rect,
    pub(crate) visible: bool,
    pub(crate) hit_test: HitTestPolicy,
    pub(crate) hit_test_snapshot: Option<HitTestRegionSnapshot>,
    pub(crate) surface: Option<PlatformSurfaceHandle>,
    pub(crate) ime_bounds: Option<ImeBoundsUpdate>,
}

pub(crate) trait PlatformWindowHost {
    fn sync_scene(&mut self, items: &[PlatformSceneItem]) -> Result<(), CompositorError>;

    fn set_active_item(
        &mut self,
        _item_id: Option<CompositionItemId>,
    ) -> Result<(), CompositorError> {
        Err(CompositorError::PlatformUnsupported)
    }

    fn show_context_menu(
        &mut self,
        target: SurfaceTarget,
        menu: ContextMenu,
    ) -> Result<(), CompositorError>;

    #[cfg(feature = "chrome")]
    fn show_choice_menu(
        &mut self,
        target: SurfaceTarget,
        menu: ChromeChoiceMenu,
    ) -> Result<(), CompositorError>;

    fn start_native_drag(
        &mut self,
        target: SurfaceTarget,
        request: DragStartRequest,
    ) -> Result<bool, CompositorError>;

    fn set_external_drag_operation(
        &mut self,
        _target: SurfaceTarget,
        _operation: DragOperation,
    ) -> Result<(), CompositorError> {
        Ok(())
    }

    #[allow(dead_code)]
    fn input_state(&self) -> PlatformInputState {
        PlatformInputState::default()
    }
}

pub(crate) fn attach_window_host<W, E>(
    window: &W,
    emit: E,
) -> Result<Box<dyn PlatformWindowHost>, CompositorError>
where
    W: WindowHost,
    E: FnMut(cbf::command::BrowserCommand) + 'static,
{
    #[cfg(all(target_os = "macos", feature = "chrome"))]
    {
        crate::platform::macos::attach_macos_window_host(window, emit)
    }

    #[cfg(not(all(target_os = "macos", feature = "chrome")))]
    {
        _ = window;
        _ = emit;
        crate::platform::unsupported::attach_unsupported_window_host()
    }
}