tao 0.35.2

Cross-platform window manager library.
Documentation
// Copyright 2014-2021 The winit contributors
// Copyright 2021-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0

#![cfg(target_os = "ios")]

use std::os::raw::c_void;

use crate::{
  event_loop::{EventLoop, EventLoopWindowTarget},
  monitor::{MonitorHandle, VideoMode},
  platform_impl::set_badge_count,
  window::{Window, WindowBuilder},
};

/// Additional methods on [`EventLoop`] that are specific to iOS.
pub trait EventLoopExtIOS {
  /// Returns the [`Idiom`] (phone/tablet/tv/etc) for the current device.
  fn idiom(&self) -> Idiom;
}

impl<T: 'static> EventLoopExtIOS for EventLoop<T> {
  fn idiom(&self) -> Idiom {
    self.event_loop.idiom()
  }
}

/// Additional methods on [`Window`] that are specific to iOS.
pub trait WindowExtIOS {
  /// Returns a pointer to the [`UIWindow`] that is used by this window.
  ///
  /// The pointer will become invalid when the [`Window`] is destroyed.
  ///
  /// [`UIWindow`]: https://developer.apple.com/documentation/uikit/uiwindow?language=objc
  fn ui_window(&self) -> *mut c_void;

  /// Returns a pointer to the [`UIViewController`] that is used by this window.
  ///
  /// The pointer will become invalid when the [`Window`] is destroyed.
  ///
  /// [`UIViewController`]: https://developer.apple.com/documentation/uikit/uiviewcontroller?language=objc
  fn ui_view_controller(&self) -> *mut c_void;

  /// Returns a pointer to the [`UIView`] that is used by this window.
  ///
  /// The pointer will become invalid when the [`Window`] is destroyed.
  ///
  /// [`UIView`]: https://developer.apple.com/documentation/uikit/uiview?language=objc
  fn ui_view(&self) -> *mut c_void;

  /// Sets the [`contentScaleFactor`] of the underlying [`UIWindow`] to `scale_factor`.
  ///
  /// The default value is device dependent, and it's recommended GLES or Metal applications set
  /// this to [`MonitorHandle::scale_factor()`].
  ///
  /// [`UIWindow`]: https://developer.apple.com/documentation/uikit/uiwindow?language=objc
  /// [`contentScaleFactor`]: https://developer.apple.com/documentation/uikit/uiview/1622657-contentscalefactor?language=objc
  fn set_scale_factor(&self, scale_factor: f64);

  /// Sets the valid orientations for the [`Window`].
  ///
  /// The default value is [`ValidOrientations::LandscapeAndPortrait`].
  ///
  /// This changes the value returned by
  /// [`-[UIViewController supportedInterfaceOrientations]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621435-supportedinterfaceorientations?language=objc),
  /// and then calls
  /// [`-[UIViewController attemptRotationToDeviceOrientation]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621400-attemptrotationtodeviceorientati?language=objc).
  fn set_valid_orientations(&self, valid_orientations: ValidOrientations);

  /// Sets whether the [`Window`] prefers the home indicator hidden.
  ///
  /// The default is to prefer showing the home indicator.
  ///
  /// This changes the value returned by
  /// [`-[UIViewController prefersHomeIndicatorAutoHidden]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/2887510-prefershomeindicatorautohidden?language=objc),
  /// and then calls
  /// [`-[UIViewController setNeedsUpdateOfHomeIndicatorAutoHidden]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/2887509-setneedsupdateofhomeindicatoraut?language=objc).
  ///
  /// This only has an effect on iOS 11.0+.
  fn set_prefers_home_indicator_hidden(&self, hidden: bool);

  /// Sets the screen edges for which the system gestures will take a lower priority than the
  /// application's touch handling.
  ///
  /// This changes the value returned by
  /// [`-[UIViewController preferredScreenEdgesDeferringSystemGestures]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/2887512-preferredscreenedgesdeferringsys?language=objc),
  /// and then calls
  /// [`-[UIViewController setNeedsUpdateOfScreenEdgesDeferringSystemGestures]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/2887507-setneedsupdateofscreenedgesdefer?language=objc).
  ///
  /// This only has an effect on iOS 11.0+.
  fn set_preferred_screen_edges_deferring_system_gestures(&self, edges: ScreenEdge);

  /// Sets whether the [`Window`] prefers the status bar hidden.
  ///
  /// The default is to prefer showing the status bar.
  ///
  /// This changes the value returned by
  /// [`-[UIViewController prefersStatusBarHidden]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621440-prefersstatusbarhidden?language=objc),
  /// and then calls
  /// [`-[UIViewController setNeedsStatusBarAppearanceUpdate]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621354-setneedsstatusbarappearanceupdat?language=objc).
  fn set_prefers_status_bar_hidden(&self, hidden: bool);

  /// Sets the badge count on iOS launcher. 0 hides the count
  fn set_badge_count(&self, count: i32);

  /// Returns the identifier of the UIScene tied to this UIWindow.
  fn scene_identifier(&self) -> String;
}

impl WindowExtIOS for Window {
  #[inline]
  fn ui_window(&self) -> *mut c_void {
    self.window.ui_window() as _
  }

  #[inline]
  fn ui_view_controller(&self) -> *mut c_void {
    self.window.ui_view_controller() as _
  }

  #[inline]
  fn ui_view(&self) -> *mut c_void {
    self.window.ui_view() as _
  }

  #[inline]
  fn set_scale_factor(&self, scale_factor: f64) {
    self.window.set_scale_factor(scale_factor)
  }

  #[inline]
  fn set_valid_orientations(&self, valid_orientations: ValidOrientations) {
    self.window.set_valid_orientations(valid_orientations)
  }

  #[inline]
  fn set_prefers_home_indicator_hidden(&self, hidden: bool) {
    self.window.set_prefers_home_indicator_hidden(hidden)
  }

  #[inline]
  fn set_preferred_screen_edges_deferring_system_gestures(&self, edges: ScreenEdge) {
    self
      .window
      .set_preferred_screen_edges_deferring_system_gestures(edges)
  }

  #[inline]
  fn set_prefers_status_bar_hidden(&self, hidden: bool) {
    self.window.set_prefers_status_bar_hidden(hidden)
  }

  #[inline]
  fn set_badge_count(&self, count: i32) {
    self.window.set_badge_count(count)
  }

  #[inline]
  fn scene_identifier(&self) -> String {
    self.window.scene_identifier()
  }
}

pub trait EventLoopWindowTargetExtIOS {
  /// Sets the badge count on iOS launcher. 0 hides the count
  fn set_badge_count(&self, count: i32);
}

impl<T> EventLoopWindowTargetExtIOS for EventLoopWindowTarget<T> {
  fn set_badge_count(&self, count: i32) {
    set_badge_count(count)
  }
}

/// Additional methods on [`WindowBuilder`] that are specific to iOS.
pub trait WindowBuilderExtIOS {
  /// Sets the root view class used by the [`Window`], otherwise a barebones [`UIView`] is provided.
  ///
  /// An instance of the class will be initialized by calling [`-[UIView initWithFrame:]`](https://developer.apple.com/documentation/uikit/uiview/1622488-initwithframe?language=objc).
  ///
  /// [`UIView`]: https://developer.apple.com/documentation/uikit/uiview?language=objc
  fn with_root_view_class(self, root_view_class: *const c_void) -> WindowBuilder;

  /// Sets the [`contentScaleFactor`] of the underlying [`UIWindow`] to `scale_factor`.
  ///
  /// The default value is device dependent, and it's recommended GLES or Metal applications set
  /// this to [`MonitorHandle::scale_factor()`].
  ///
  /// [`UIWindow`]: https://developer.apple.com/documentation/uikit/uiwindow?language=objc
  /// [`contentScaleFactor`]: https://developer.apple.com/documentation/uikit/uiview/1622657-contentscalefactor?language=objc
  fn with_scale_factor(self, scale_factor: f64) -> WindowBuilder;

  /// Sets the valid orientations for the [`Window`].
  ///
  /// The default value is [`ValidOrientations::LandscapeAndPortrait`].
  ///
  /// This sets the initial value returned by
  /// [`-[UIViewController supportedInterfaceOrientations]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621435-supportedinterfaceorientations?language=objc).
  fn with_valid_orientations(self, valid_orientations: ValidOrientations) -> WindowBuilder;

  /// Sets whether the [`Window`] prefers the home indicator hidden.
  ///
  /// The default is to prefer showing the home indicator.
  ///
  /// This sets the initial value returned by
  /// [`-[UIViewController prefersHomeIndicatorAutoHidden]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/2887510-prefershomeindicatorautohidden?language=objc).
  ///
  /// This only has an effect on iOS 11.0+.
  fn with_prefers_home_indicator_hidden(self, hidden: bool) -> WindowBuilder;

  /// Sets the screen edges for which the system gestures will take a lower priority than the
  /// application's touch handling.
  ///
  /// This sets the initial value returned by
  /// [`-[UIViewController preferredScreenEdgesDeferringSystemGestures]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/2887512-preferredscreenedgesdeferringsys?language=objc).
  ///
  /// This only has an effect on iOS 11.0+.
  fn with_preferred_screen_edges_deferring_system_gestures(
    self,
    edges: ScreenEdge,
  ) -> WindowBuilder;

  /// Sets whether the [`Window`] prefers the status bar hidden.
  ///
  /// The default is to prefer showing the status bar.
  ///
  /// This sets the initial value returned by
  /// [`-[UIViewController prefersStatusBarHidden]`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621440-prefersstatusbarhidden?language=objc).
  fn with_prefers_status_bar_hidden(self, hidden: bool) -> WindowBuilder;

  /// Sets the identifier of the UIScene that is requesting the creation of this new scene,
  /// establishing a relationship between the two scenes.
  ///
  /// By default the system uses the foreground scene.
  fn with_requesting_scene_identifier(self, identifier: String) -> WindowBuilder;
}

impl WindowBuilderExtIOS for WindowBuilder {
  #[inline]
  fn with_root_view_class(mut self, root_view_class: *const c_void) -> WindowBuilder {
    self.platform_specific.root_view_class = unsafe { &*(root_view_class as *const _) };
    self
  }

  #[inline]
  fn with_scale_factor(mut self, scale_factor: f64) -> WindowBuilder {
    self.platform_specific.scale_factor = Some(scale_factor);
    self
  }

  #[inline]
  fn with_valid_orientations(mut self, valid_orientations: ValidOrientations) -> WindowBuilder {
    self.platform_specific.valid_orientations = valid_orientations;
    self
  }

  #[inline]
  fn with_prefers_home_indicator_hidden(mut self, hidden: bool) -> WindowBuilder {
    self.platform_specific.prefers_home_indicator_hidden = hidden;
    self
  }

  #[inline]
  fn with_preferred_screen_edges_deferring_system_gestures(
    mut self,
    edges: ScreenEdge,
  ) -> WindowBuilder {
    self
      .platform_specific
      .preferred_screen_edges_deferring_system_gestures = edges;
    self
  }

  #[inline]
  fn with_prefers_status_bar_hidden(mut self, hidden: bool) -> WindowBuilder {
    self.platform_specific.prefers_status_bar_hidden = hidden;
    self
  }

  #[inline]
  fn with_requesting_scene_identifier(mut self, identifier: String) -> WindowBuilder {
    self
      .platform_specific
      .requesting_scene_identifier
      .replace(identifier);
    self
  }
}

/// Additional methods on [`MonitorHandle`] that are specific to iOS.
pub trait MonitorHandleExtIOS {
  /// Returns a pointer to the [`UIScreen`] that is used by this monitor.
  ///
  /// [`UIScreen`]: https://developer.apple.com/documentation/uikit/uiscreen?language=objc
  fn ui_screen(&self) -> *mut c_void;

  /// Returns the preferred [`VideoMode`] for this monitor.
  ///
  /// This translates to a call to [`-[UIScreen preferredMode]`](https://developer.apple.com/documentation/uikit/uiscreen/1617823-preferredmode?language=objc).
  fn preferred_video_mode(&self) -> VideoMode;
}

impl MonitorHandleExtIOS for MonitorHandle {
  #[inline]
  fn ui_screen(&self) -> *mut c_void {
    self.inner.ui_screen() as _
  }

  #[inline]
  fn preferred_video_mode(&self) -> VideoMode {
    self.inner.preferred_video_mode()
  }
}

/// Valid orientations for a particular [`Window`].
#[non_exhaustive]
#[derive(Clone, Copy, Debug)]
pub enum ValidOrientations {
  /// Excludes `PortraitUpsideDown` on iphone
  LandscapeAndPortrait,

  Landscape,

  /// Excludes `PortraitUpsideDown` on iphone
  Portrait,
}

impl Default for ValidOrientations {
  #[inline]
  fn default() -> ValidOrientations {
    ValidOrientations::LandscapeAndPortrait
  }
}

/// The device [idiom].
///
/// [idiom]: https://developer.apple.com/documentation/uikit/uidevice/1620037-userinterfaceidiom?language=objc
#[non_exhaustive]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Idiom {
  Unspecified,

  /// iPhone and iPod touch.
  Phone,

  /// iPad.
  Pad,

  /// tvOS and Apple TV.
  TV,
  CarPlay,
}

bitflags! {
    /// The [edges] of a screen.
    ///
    /// [edges]: https://developer.apple.com/documentation/uikit/uirectedge?language=objc
    #[derive(Clone, Copy ,Default)]
    pub struct ScreenEdge: u8 {
        const NONE   = 0;
        const TOP    = 1 << 0;
        const LEFT   = 1 << 1;
        const BOTTOM = 1 << 2;
        const RIGHT  = 1 << 3;
        const ALL = ScreenEdge::TOP.bits() | ScreenEdge::LEFT.bits()
            | ScreenEdge::BOTTOM.bits() | ScreenEdge::RIGHT.bits();
    }
}

pub(crate) fn operating_system_version() -> (isize, isize, isize) {
  let process_info = objc2_foundation::NSProcessInfo::processInfo();
  let version = process_info.operatingSystemVersion();
  (
    version.majorVersion,
    version.minorVersion,
    version.patchVersion,
  )
}