      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

    use std::ops::Deref;
    use std::sync::{Arc, Mutex};
    use wayland_client::cursor::{is_available, load_theme, CursorTheme};
    use wayland_client::protocol::{wl_compositor, wl_pointer, wl_seat, wl_shm, wl_surface};
    use wayland_client::{NewProxy, Proxy, QueueToken};

    use wayland_client::protocol::wl_compositor::RequestsTrait as CompositorRequests;
    use wayland_client::protocol::wl_pointer::RequestsTrait as PointerRequests;
    use wayland_client::protocol::wl_seat::RequestsTrait as SeatRequests;
    use wayland_client::protocol::wl_surface::RequestsTrait as SurfaceRequests;

    /// Wrapper managing a system theme for pointer images
    ///
    /// You can use it to initialize new pointers in order
    /// to theme them.
    ///
    /// Is is also clone-able in case you need to handle several
    /// pointer theming from different places.
    ///
    /// Note that it is however not `Send` nor `Sync`
    pub struct ThemeManager {
        theme: Arc<Mutex<CursorTheme>>,
        compositor: Proxy<wl_compositor::WlCompositor>,
    }

    impl ThemeManager {
        /// Load a system pointer theme
        ///
        /// Will use the default theme of the system if name is `None`.
        ///
        /// Fails if `libwayland-cursor` is not available.
        pub fn init(
            name: Option<&str>,
            compositor: Proxy<wl_compositor::WlCompositor>,
            shm: &Proxy<wl_shm::WlShm>,
        ) -> Result<ThemeManager, ()> {
            if !is_available() {
                return Err(());
            }

            Ok(ThemeManager {
                compositor,
                theme: Arc::new(Mutex::new(load_theme(name, 16, &shm))),
            })
        }

        /// Wrap a pointer to theme it
        pub fn theme_pointer(&self, pointer: Proxy<wl_pointer::WlPointer>) -> ThemedPointer {
            let surface = self
                .compositor
                .create_surface(|surface| surface.implement(|_, _| {}, ()))
                .unwrap();
            ThemedPointer {
                pointer,
                inner: Arc::new(Mutex::new(PointerInner {
                    surface,
                    theme: self.theme.clone(),
                    last_serial: 0,
                })),
            }
        }

        /// Initialize a new pointer as a ThemedPointer with an adapter implementation
        ///
        /// You need to provide an implementation as if implementing a `wl_pointer`, but
        /// it will receive as `meta` argument a `ThemedPointer` wrapping your pointer,
        /// rather than a `Proxy<WlPointer>`.
        pub fn theme_pointer_with_impl<Impl, UD>(
            &self,
            seat: &Proxy<wl_seat::WlSeat>,
            mut implementation: Impl,
            user_data: UD,
        ) -> ThemedPointer
        where
            Impl: FnMut(wl_pointer::Event, ThemedPointer) + Send + 'static,
            UD: Send + Sync + 'static,
        {
            let surface = self
                .compositor
                .create_surface(|surface| surface.implement(|_, _| {}, ()))
                .unwrap();

            let inner = Arc::new(Mutex::new(PointerInner {
                surface,
                theme: self.theme.clone(),
                last_serial: 0,
            }));
            let inner2 = inner.clone();

            let pointer = seat
                .get_pointer(|pointer| {
                    pointer.implement(
                        move |event, ptr| {
                            implementation(
                                event,
                                ThemedPointer {
                                    pointer: ptr,
                                    inner: inner.clone(),
                                },
                            )
                        },
                        user_data,
                    )
                })
                .unwrap();

            ThemedPointer {
                pointer,
                inner: inner2,
            }
        }

        /// Initialize a new pointer as a ThemedPointer with an adapter implementation
        ///
        /// Like `theme_pointer_with_impl` but allows you to have a non-`Send` implementation.
        ///
        /// **Unsafe** for the same reasons as `NewProxy::implement_nonsend`.
        pub unsafe fn theme_pointer_with_nonsend_impl<Impl, UD>(
            &self,
            pointer: NewProxy<wl_pointer::WlPointer>,
            mut implementation: Impl,
            user_data: UD,
            token: &QueueToken,
        ) -> ThemedPointer
        where
            Impl: FnMut(wl_pointer::Event, ThemedPointer) + 'static,
            UD: Send + Sync + 'static,
        {
            let surface = self
                .compositor
                .create_surface(|surface| surface.implement(|_, _| {}, ()))
                .unwrap();

            let inner = Arc::new(Mutex::new(PointerInner {
                surface,
                theme: self.theme.clone(),
                last_serial: 0,
            }));
            let inner2 = inner.clone();

            let pointer = pointer.implement_nonsend(
                move |event, ptr| {
                    implementation(
                        event,
                        ThemedPointer {
                            pointer: ptr,
                            inner: inner.clone(),
                        },
                    )
                },
                user_data,
                token,
            );

            ThemedPointer {
                pointer,
                inner: inner2,
            }
        }
    }

    struct PointerInner {
        surface: Proxy<wl_surface::WlSurface>,
        theme: Arc<Mutex<CursorTheme>>,
        last_serial: u32,
    }

    /// Wrapper of a themed pointer
    ///
    /// You can access the underlying `Proxy<wl_pointer::WlPointer>` via
    /// deref. It will *not* release the proxy when dropped.
    ///
    /// Just like `Proxy`, this is a `Rc`-like wrapper. You can clone it
    /// to have several handles to the same theming machinery of a pointer.
    pub struct ThemedPointer {
        pointer: Proxy<wl_pointer::WlPointer>,
        inner: Arc<Mutex<PointerInner>>,
    }

    impl ThemedPointer {
        /// Change the cursor to the given cursor name
        ///
        /// Possible names depend on the theme. Does nothing and returns
        /// `Err(())` if given name is not available.
        ///
        /// If this is done as an answer to an input event, you need to provide
        /// the associated serial otherwise the server may ignore the request.
        pub fn set_cursor(&self, name: &str, serial: Option<u32>) -> Result<(), ()> {
            let mut inner = self.inner.lock().unwrap();
            let PointerInner {
                ref theme,
                ref surface,
                ref mut last_serial,
            } = *inner;

            let theme = theme.lock().unwrap();
            let cursor = theme.get_cursor(name).ok_or(())?;
            let buffer = cursor.frame_buffer(0).ok_or(())?;
            let (w, h, hx, hy) = cursor
                .frame_info(0)
                .map(|(w, h, hx, hy, _)| (w as i32, h as i32, hx as i32, hy as i32))
                .unwrap_or((0, 0, 0, 0));

            if let Some(s) = serial {
                *last_serial = s;
            }

            surface.attach(Some(&buffer), 0, 0);
            if surface.version() >= 4 {
                surface.damage_buffer(0, 0, w, h);
            } else {
                // surface is old and does not support damage_buffer, so we damage
                // in surface coordinates and hope it is not rescaled
                surface.damage(0, 0, w, h);
            }
            surface.commit();
            self.pointer.set_cursor(*last_serial, Some(surface), hx, hy);

            Ok(())
        }
    }

    impl Clone for ThemedPointer {
        fn clone(&self) -> ThemedPointer {
            ThemedPointer {
                pointer: self.pointer.clone(),
                inner: self.inner.clone(),
            }
        }
    }

    impl Deref for ThemedPointer {
        type Target = Proxy<wl_pointer::WlPointer>;
        fn deref(&self) -> &Proxy<wl_pointer::WlPointer> {
            &self.pointer
        }
    }

    impl Drop for PointerInner {
        fn drop(&mut self) {
            self.surface.destroy();
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)