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
use std::{collections::HashMap, os::fd::OwnedFd};
use enumflags2::{bitflags, BitFlags};
use futures_util::{Stream, TryFutureExt};
use serde::Deserialize;
use serde_repr::{Deserialize_repr, Serialize_repr};
use zbus::zvariant::{
self, DeserializeDict, ObjectPath, OwnedObjectPath, OwnedValue, SerializeDict, Type, Value,
};
use super::{HandleToken, Request, Session};
use crate::{proxy::Proxy, Error, WindowIdentifier};
#[derive(Serialize_repr, Deserialize_repr, PartialEq, Eq, Debug, Copy, Clone, Type)]
#[bitflags]
#[repr(u32)]
/// Supported capabilities
pub enum Capabilities {
/// Keyboard
Keyboard,
/// Pointer
Pointer,
/// Touchscreen
Touchscreen,
}
#[derive(Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
struct CreateSessionOptions {
handle_token: HandleToken,
session_handle_token: HandleToken,
capabilities: BitFlags<Capabilities>,
}
#[derive(Debug, DeserializeDict, Type)]
#[zvariant(signature = "dict")]
struct CreateSessionResponse {
session_handle: OwnedObjectPath,
capabilities: BitFlags<Capabilities>,
}
#[derive(Default, Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
struct GetZonesOptions {
handle_token: HandleToken,
}
#[derive(Default, Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
struct SetPointerBarriersOptions {
handle_token: HandleToken,
}
#[derive(Default, Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
struct EnableOptions {}
#[derive(Default, Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
struct DisableOptions {}
#[derive(Default, Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
struct ReleaseOptions {
activation_id: u32,
cursor_position: (f64, f64),
}
/// Indicates that an input capturing session was disabled.
#[derive(Debug, Deserialize, Type)]
#[zvariant(signature = "(oa{sv})")]
pub struct Disabled(OwnedObjectPath, HashMap<String, OwnedValue>);
impl Disabled {
/// Session that was disabled.
pub fn session_handle(&self) -> ObjectPath<'_> {
self.0.as_ref()
}
/// Optional information
pub fn options(&self) -> &HashMap<String, OwnedValue> {
&self.1
}
}
#[derive(Debug, DeserializeDict, Type)]
#[zvariant(signature = "dict")]
struct DeactivatedOptions {
activation_id: u32,
}
/// Indicates that an input capturing session was disabled.
#[derive(Debug, Deserialize, Type)]
#[zvariant(signature = "(oa{sv})")]
pub struct Deactivated(OwnedObjectPath, DeactivatedOptions);
impl Deactivated {
/// Session that was deactivated.
pub fn session_handle(&self) -> ObjectPath<'_> {
self.0.as_ref()
}
/// The same activation_id number as in the corresponding "Activated"
/// signal.
pub fn activation_id(&self) -> u32 {
self.1.activation_id
}
}
#[derive(Debug, DeserializeDict, Type)]
#[zvariant(signature = "dict")]
struct ActivatedOptions {
activation_id: u32,
cursor_position: (f32, f32),
barrier_id: BarrierID,
}
/// Indicates that an input capturing session was disabled.
#[derive(Debug, Deserialize, Type)]
#[zvariant(signature = "(oa{sv})")]
pub struct Activated(OwnedObjectPath, ActivatedOptions);
impl Activated {
/// Session that was activated.
pub fn session_handle(&self) -> ObjectPath<'_> {
self.0.as_ref()
}
/// A number that can be used to synchronize with the transport-layer.
pub fn activation_id(&self) -> u32 {
self.1.activation_id
}
/// The current cursor position in the same coordinate space as the zones.
pub fn cursor_position(&self) -> (f32, f32) {
self.1.cursor_position
}
/// The barrier id of the barrier that triggered
pub fn barrier_id(&self) -> BarrierID {
self.1.barrier_id
}
}
#[derive(Debug, DeserializeDict, Type)]
#[zvariant(signature = "dict")]
struct ZonesChangedOptions {
zone_set: u32,
}
/// Indicates that an input capturing session was disabled.
#[derive(Debug, Deserialize, Type)]
#[zvariant(signature = "(oa{sv})")]
pub struct ZonesChanged(OwnedObjectPath, ZonesChangedOptions);
impl ZonesChanged {
/// Session that was deactivated.
pub fn session_handle(&self) -> ObjectPath<'_> {
self.0.as_ref()
}
/// The zone_set ID of the invalidated zone.
pub fn zone_set(&self) -> u32 {
self.1.zone_set
}
}
/// A region of a [`Zones`].
#[derive(Debug, Clone, Copy, Deserialize, Type)]
#[zvariant(signature = "(uuii)")]
pub struct Region(u32, u32, i32, i32);
impl Region {
/// The width.
pub fn width(self) -> u32 {
self.0
}
/// The height
pub fn height(self) -> u32 {
self.1
}
/// The x offset.
pub fn x_offset(self) -> i32 {
self.2
}
/// The y offset.
pub fn y_offset(self) -> i32 {
self.3
}
}
/// A response of [`InputCapture::zones`].
#[derive(Debug, Type, DeserializeDict)]
#[zvariant(signature = "dict")]
pub struct Zones {
zones: Vec<Region>,
zone_set: u32,
}
impl Zones {
/// A list of regions.
pub fn regions(&self) -> &[Region] {
&self.zones
}
/// A unique ID to be used in [`InputCapture::set_pointer_barriers`].
pub fn zone_set(&self) -> u32 {
self.zone_set
}
}
/// A barrier ID.
pub type BarrierID = u32;
#[derive(Debug, SerializeDict, Type)]
#[zvariant(signature = "dict")]
/// Input Barrier.
pub struct Barrier {
barrier_id: BarrierID,
position: (i32, i32, i32, i32),
}
impl Barrier {
/// Create a new barrier.
pub fn new(barrier_id: BarrierID, position: (i32, i32, i32, i32)) -> Self {
Self {
barrier_id,
position,
}
}
}
/// A response to [`InputCapture::set_pointer_barriers`]
#[derive(Debug, DeserializeDict, Type)]
#[zvariant(signature = "dict")]
pub struct SetPointerBarriersResponse {
failed_barriers: Vec<BarrierID>,
}
impl SetPointerBarriersResponse {
/// List of pointer barriers that have been denied
pub fn failed_barriers(&self) -> &[BarrierID] {
&self.failed_barriers
}
}
/// Wrapper of the DBus interface: [`org.freedesktop.portal.InputCapture`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html).
#[doc(alias = "org.freedesktop.portal.InputCapture")]
pub struct InputCapture<'a>(Proxy<'a>);
impl<'a> InputCapture<'a> {
/// Create a new instance of [`InputCapture`].
pub async fn new() -> Result<InputCapture<'a>, Error> {
let proxy = Proxy::new_desktop("org.freedesktop.portal.InputCapture").await?;
Ok(Self(proxy))
}
/// Create an input capture session.
///
/// # Specifications
///
/// See also [`CreateSession`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-createsession).
pub async fn create_session(
&self,
parent_window: &WindowIdentifier,
capabilities: BitFlags<Capabilities>,
) -> Result<(Session<'_>, BitFlags<Capabilities>), Error> {
let options = CreateSessionOptions {
handle_token: Default::default(),
session_handle_token: Default::default(),
capabilities,
};
let (request, proxy) = futures_util::try_join!(
self.0
.request::<CreateSessionResponse>(
&options.handle_token,
"CreateSession",
(parent_window, &options)
)
.into_future(),
Session::from_unique_name(&options.session_handle_token).into_future(),
)?;
let response = request.response()?;
assert_eq!(proxy.path(), &response.session_handle.as_ref());
Ok((proxy, response.capabilities))
}
/// A set of currently available input zones for this session.
///
/// # Specifications
///
/// See also [`GetZones`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-getzones).
#[doc(alias = "GetZones")]
pub async fn zones(&self, session: &Session<'_>) -> Result<Request<Zones>, Error> {
let options = GetZonesOptions::default();
self.0
.request(&options.handle_token, "GetZones", (session, &options))
.await
}
/// Set up zero or more pointer barriers.
///
/// # Specifications
///
/// See also [`SetPointerBarriers`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-setpointerbarriers).
#[doc(alias = "SetPointerBarriers")]
pub async fn set_pointer_barriers(
&self,
session: &Session<'_>,
barriers: &[Barrier],
zone_set: u32,
) -> Result<Request<SetPointerBarriersResponse>, Error> {
let options = SetPointerBarriersOptions::default();
self.0
.request(
&options.handle_token,
"SetPointerBarriers",
&(session, &options, barriers, zone_set),
)
.await
}
/// Enable input capturing.
///
/// # Specifications
///
/// See also [`Enable`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-enable).
pub async fn enable(&self, session: &Session<'_>) -> Result<(), Error> {
let options = EnableOptions::default();
self.0.call("Enable", &(session, &options)).await
}
/// Disable input capturing.
///
/// # Specifications
///
/// See also [`Disable`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-disable).
pub async fn disable(&self, session: &Session<'_>) -> Result<(), Error> {
let options = DisableOptions::default();
self.0.call("Disable", &(session, &options)).await
}
/// Release any ongoing input capture.
///
/// # Specifications
///
/// See also [`Release`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-release).
pub async fn release(
&self,
session: &Session<'_>,
activation_id: u32,
cursor_position: (f64, f64),
) -> Result<(), Error> {
let options = ReleaseOptions {
activation_id,
cursor_position,
};
self.0.call("Release", &(session, &options)).await
}
/// Connect to EIS.
///
/// # Specifications
///
/// See also [`ConnectToEIS`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-connecttoeis).
#[doc(alias = "ConnectToEIS")]
pub async fn connect_to_eis(&self, session: &Session<'_>) -> Result<OwnedFd, Error> {
// `ConnectToEIS` doesn't take any options for now
let options: HashMap<&str, Value<'_>> = HashMap::new();
let fd = self
.0
.call::<zvariant::OwnedFd>("ConnectToEIS", &(session, options))
.await?;
Ok(fd.into())
}
/// Signal emitted when the application will no longer receive captured
/// events.
///
/// # Specifications
///
/// See also [`Disabled`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-disabled).
#[doc(alias = "Disabled")]
pub async fn receive_disabled(&self) -> Result<impl Stream<Item = Disabled>, Error> {
self.0.signal("Disabled").await
}
/// Signal emitted when the application will no longer receive captured
/// events.
///
/// # Specifications
///
/// See also [`Activated`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-activated).
#[doc(alias = "Activated")]
pub async fn receive_activated(&self) -> Result<impl Stream<Item = Activated>, Error> {
self.0.signal("Activated").await
}
/// Signal emitted when the application will no longer receive captured
/// events.
///
/// # Specifications
///
/// See also [`Deactivated`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-deactivated).
#[doc(alias = "Deactivated")]
pub async fn receive_deactivated(&self) -> Result<impl Stream<Item = Deactivated>, Error> {
self.0.signal("Deactivated").await
}
/// Signal emitted when the application will no longer receive captured
/// events.
///
/// # Specifications
///
/// See also [`ZonesChanged`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-zoneschanged).
#[doc(alias = "ZonesChanged")]
pub async fn receive_zones_changed(&self) -> Result<impl Stream<Item = ZonesChanged>, Error> {
self.0.signal("ZonesChanged").await
}
/// Supported capabilities.
///
/// # Specifications
///
/// See also [`SupportedCapabilities`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.InputCapture.html#org-freedesktop-portal-inputcapture-supportedcapabilities).
#[doc(alias = "SupportedCapabilities")]
pub async fn supported_capabilities(&self) -> Result<BitFlags<Capabilities>, Error> {
self.0.property("SupportedCapabilities").await
}
}
impl<'a> std::ops::Deref for InputCapture<'a> {
type Target = zbus::Proxy<'a>;
fn deref(&self) -> &Self::Target {
&self.0
}
}