GHOST_SystemWayland.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2020-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "../GHOST_Types.h"
#include "GHOST_System.hh"
#include "GHOST_WindowWayland.hh"
 
#ifdef WITH_GHOST_WAYLAND_DYNLOAD
#  include <wayland_dynload_client.h>
#endif
#include <wayland-client.h>
 
#ifdef WITH_GHOST_WAYLAND_LIBDECOR
#  ifdef WITH_GHOST_WAYLAND_DYNLOAD
#    include <wayland_dynload_libdecor.h>
#  endif
#  include <libdecor.h>
#endif
 
#include <mutex>
#include <string>
 
#ifdef USE_EVENT_BACKGROUND_THREAD
#  include <atomic>
#  include <thread>
#endif
 
class GHOST_WindowWayland;
 
bool ghost_wl_display_report_error_if_set(wl_display *display);
 
bool ghost_wl_output_own(const struct wl_output *wl_output);
void ghost_wl_output_tag(struct wl_output *wl_output);
struct GWL_Output *ghost_wl_output_user_data(struct wl_output *wl_output);

bool ghost_wl_surface_own_with_null_check(const struct wl_surface *wl_surface);
bool ghost_wl_surface_own(const struct wl_surface *wl_surface);
void ghost_wl_surface_tag(struct wl_surface *wl_surface);
GHOST_WindowWayland *ghost_wl_surface_user_data(struct wl_surface *wl_surface);
 
bool ghost_wl_surface_own_cursor_pointer(const struct wl_surface *wl_surface);
void ghost_wl_surface_tag_cursor_pointer(struct wl_surface *wl_surface);
 
bool ghost_wl_surface_own_cursor_tablet(const struct wl_surface *wl_surface);
void ghost_wl_surface_tag_cursor_tablet(struct wl_surface *wl_surface);
 
/* Scaling to: translates from WAYLAND into GHOST (viewport local) coordinates.
 * Scaling from: performs the reverse translation.
 *
 * Scaling "to" is used to map WAYLAND location cursor coordinates to GHOST coordinates.
 * Scaling "from" is used to clamp cursor coordinates in WAYLAND local coordinates. */
 
struct GWL_WindowScaleParams;
wl_fixed_t gwl_window_scale_wl_fixed_to(const GWL_WindowScaleParams &scale_params,
                                        wl_fixed_t value);
wl_fixed_t gwl_window_scale_wl_fixed_from(const GWL_WindowScaleParams &scale_params,
                                          wl_fixed_t value);
 
/* Avoid this where possible as scaling integers often incurs rounding errors.
 * Scale #wl_fixed_t where possible.
 *
 * In general scale by large values where this is less likely to be a problem. */
 
int gwl_window_scale_int_to(const GWL_WindowScaleParams &scale_params, int value);
int gwl_window_scale_int_from(const GWL_WindowScaleParams &scale_params, int value);
 
#define FRACTIONAL_DENOMINATOR 120
 
#ifdef WITH_GHOST_WAYLAND_DYNLOAD
bool ghost_wl_dynload_libraries_init(bool use_window_frame);
void ghost_wl_dynload_libraries_exit();
#endif
 
struct GWL_Output {

  struct {
    wl_output *output = nullptr;
  } wl;

  struct {
    struct zxdg_output_v1 *output = nullptr;
  } xdg;
 
  GHOST_SystemWayland *system = nullptr;

  int32_t size_native[2] = {0, 0};
  int32_t size_mm[2] = {0, 0};

  int32_t size_logical[2] = {0, 0};
  bool has_size_logical = false;

  int32_t position_logical[2] = {0, 0};
  bool has_position_logical = false;
 
  int transform = 0;
  int scale = 1;
  int scale_fractional = (1 * FRACTIONAL_DENOMINATOR);
  bool has_scale_fractional = false;
 
  std::string make;
  std::string model;
};
 
class GHOST_SystemWayland : public GHOST_System {
 public:
  GHOST_SystemWayland(bool background);
  GHOST_SystemWayland() : GHOST_SystemWayland(true) {};
 
  ~GHOST_SystemWayland() override;
 
  GHOST_TSuccess init() override;
 
  bool processEvents(bool waitForEvent) override;
 
  bool setConsoleWindowState(GHOST_TConsoleWindowState action) override;
 
  GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const override;
 
  GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const override;
 
  char *getClipboard(bool selection) const override;
 
  void putClipboard(const char *buffer, bool selection) const override;

  GHOST_TSuccess hasClipboardImage() const override;

  uint *getClipboardImage(int *r_width, int *r_height) const override;

  GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const override;
 
  uint8_t getNumDisplays() const override;
 
  uint64_t getMilliSeconds() const override;
 
  GHOST_TSuccess getCursorPositionClientRelative(const GHOST_IWindow *window,
                                                 int32_t &x,
                                                 int32_t &y) const override;
  GHOST_TSuccess setCursorPositionClientRelative(GHOST_IWindow *window,
                                                 int32_t x,
                                                 int32_t y) override;
 
  GHOST_TSuccess getCursorPosition(int32_t &x, int32_t &y) const override;
  GHOST_TSuccess setCursorPosition(int32_t x, int32_t y) override;
 
  uint32_t getCursorPreferredLogicalSize() const override;
 
  void getMainDisplayDimensions(uint32_t &width, uint32_t &height) const override;
 
  void getAllDisplayDimensions(uint32_t &width, uint32_t &height) const override;
 
  GHOST_IContext *createOffscreenContext(GHOST_GPUSettings gpu_settings) override;
 
  GHOST_TSuccess disposeContext(GHOST_IContext *context) override;
 
  GHOST_IWindow *createWindow(const char *title,
                              int32_t left,
                              int32_t top,
                              uint32_t width,
                              uint32_t height,
                              GHOST_TWindowState state,
                              GHOST_GPUSettings gpu_settings,
                              const bool exclusive,
                              const bool is_dialog,
                              const GHOST_IWindow *parent_window) override;
 
  GHOST_TCapabilityFlag getCapabilities() const override;
 
  void setMultitouchGestures(const bool use) override;
 
  /* WAYLAND utility functions (share window/system logic). */
 
  GHOST_TSuccess cursor_shape_set(GHOST_TStandardCursor shape);
 
  GHOST_TSuccess cursor_shape_check(GHOST_TStandardCursor cursor_shape);
 
  GHOST_TSuccess cursor_shape_custom_set(const GHOST_CursorGenerator &cg);
 
  GHOST_TSuccess cursor_bitmap_get(GHOST_CursorBitmapRef *bitmap);
 
  GHOST_TSuccess cursor_visibility_set(bool visible);
 
  bool cursor_grab_use_software_display_get(const GHOST_TGrabCursorMode mode);
 
#ifdef USE_EVENT_BACKGROUND_THREAD
  GHOST_TimerManager *ghost_timer_manager();
#endif
 
  /* WAYLAND direct-data access. */
 
  struct wl_display *wl_display_get();
  struct wl_compositor *wl_compositor_get();
  struct zwp_primary_selection_device_manager_v1 *wp_primary_selection_manager_get();
  struct xdg_activation_v1 *xdg_activation_manager_get();
  struct zwp_pointer_gestures_v1 *wp_pointer_gestures_get();
  struct wp_fractional_scale_manager_v1 *wp_fractional_scale_manager_get();
  struct wp_viewporter *wp_viewporter_get();
 
#ifdef WITH_GHOST_WAYLAND_LIBDECOR
  libdecor *libdecor_context_get();
#endif
  struct xdg_wm_base *xdg_decor_shell_get();
  struct zxdg_decoration_manager_v1 *xdg_decor_manager_get();
  /* End `xdg_decor`. */
 
  const std::vector<GWL_Output *> &outputs_get() const;
 
  struct wl_shm *wl_shm_get() const;
 
  void ime_begin(const GHOST_WindowWayland *win,
                 int32_t x,
                 int32_t y,
                 int32_t w,
                 int32_t h,
                 bool completed) const;
  void ime_end(const GHOST_WindowWayland *win) const;
 
  bool use_window_frame_get();
 
  static const char *xdg_app_id_get();
 
  /* WAYLAND utility functions. */

  uint64_t ms_from_input_time(const uint32_t timestamp_as_uint);

  GHOST_TSuccess pushEvent_maybe_pending(const GHOST_IEvent *event);

  void seat_active_set(const struct GWL_Seat *seat);
 
  struct wl_seat *wl_seat_active_get_with_input_serial(uint32_t &serial);

  bool output_unref(struct wl_output *wl_output);
 
  void output_scale_update(GWL_Output *output);

  bool window_surface_unref(const wl_surface *wl_surface);
 
  bool window_cursor_grab_set(const GHOST_TGrabCursorMode mode,
                              const GHOST_TGrabCursorMode mode_current,
                              int32_t init_grab_xy[2],
                              const GHOST_Rect *wrap_bounds,
                              GHOST_TAxisFlag wrap_axis,
                              wl_surface *wl_surface,
                              const struct GWL_WindowScaleParams &scale_params);
 
#ifdef WITH_GHOST_WAYLAND_LIBDECOR
  static bool use_libdecor_runtime();
#endif
 
#ifdef USE_EVENT_BACKGROUND_THREAD
  /* NOTE: allocate mutex so `const` functions can lock the mutex. */

  std::mutex *server_mutex = nullptr;

  std::mutex *timer_mutex = nullptr;
 
  std::thread::id main_thread_id;
 
  std::atomic<bool> has_pending_actions_for_window = false;
#endif
 
 private:
  void display_destroy_and_free_all();
 
  struct GWL_Display *display_;
};