test/source/blender/windowmanager/wm_event_system.hh

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

/** \file
 * \ingroup wm
 */

#pragma once

#include "WM_api.hh"

struct ARegion;
struct bToolRef;
struct GHOST_TabletData;
struct ScrArea;
struct wmEvent;
struct wmKeyMap;
struct wmKeyMapItem;

namespace blender::wm {
enum class OpCallContext : int8_t;
}

#ifdef WITH_XR_OPENXR
struct wmXrActionData;
#endif

/* #wmKeyMap is in `DNA_windowmanager.h`, it's saveable. */

/** Custom types for handlers, for signaling, freeing. */
enum eWM_EventHandlerType {
  WM_HANDLER_TYPE_GIZMO = 1,
  WM_HANDLER_TYPE_UI,
  WM_HANDLER_TYPE_OP,
  WM_HANDLER_TYPE_DROPBOX,
  WM_HANDLER_TYPE_KEYMAP,
};

using EventHandlerPoll = bool (*)(const wmWindow *win,
                                  const ScrArea *area,
                                  const ARegion *region,
                                  const wmEvent *event);

struct wmEventHandler {
  wmEventHandler *next, *prev;

  eWM_EventHandlerType type;
  eWM_EventHandlerFlag flag;

  EventHandlerPoll poll;
};

/** Run after the keymap item runs. */
struct wmEventHandler_KeymapPost {
  void (*post_fn)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data);
  void *user_data;
};

/** Support for a getter function that looks up the keymap each access. */
struct wmEventHandler_KeymapDynamic {
  wmEventHandler_KeymapDynamicFn keymap_fn;
  void *user_data;
};

/** #WM_HANDLER_TYPE_KEYMAP. */
struct wmEventHandler_Keymap {
  wmEventHandler head;

  /** Pointer to builtin/custom keymaps (never NULL). */
  wmKeyMap *keymap;

  wmEventHandler_KeymapPost post;
  wmEventHandler_KeymapDynamic dynamic;

  bToolRef *keymap_tool;
};

/** #WM_HANDLER_TYPE_GIZMO. */
struct wmEventHandler_Gizmo {
  wmEventHandler head;

  /** Gizmo handler (never NULL). */
  struct wmGizmoMap *gizmo_map;
};

/** #WM_HANDLER_TYPE_UI. */
struct wmEventHandler_UI {
  wmEventHandler head;

  /** Callback receiving events. */
  wmUIHandlerFunc handle_fn;
  /** Callback when handler is removed. */
  wmUIHandlerRemoveFunc remove_fn;
  /** User data pointer. */
  void *user_data;

  /** Store context for this handler for derived/modal handlers. */
  struct {
    ScrArea *area;
    ARegion *region;
    /**
     * Temporary, floating regions stored in #Screen::regionbase.
     * Used for menus, popovers & dialogs.
     */
    ARegion *region_popup;
  } context;
};

/** #WM_HANDLER_TYPE_OP. */
struct wmEventHandler_Op {
  wmEventHandler head;

  /** Operator can be NULL. */
  wmOperator *op;

  /** Hack, special case for file-select. */
  bool is_fileselect;

  /** Store context for this handler for derived/modal handlers. */
  struct {
    /**
     * To override the window, and hence the screen.
     * Set for few cases only, usually window/screen can be taken from current context.
     */
    wmWindow *win;

    ScrArea *area;
    ARegion *region;
    short region_type;
  } context;
};

/** #WM_HANDLER_TYPE_DROPBOX. */
struct wmEventHandler_Dropbox {
  wmEventHandler head;

  /** Never NULL. */
  ListBase *dropboxes;
};

/* `wm_event_system.cc` */

void wm_event_free_all(wmWindow *win);
void wm_event_free(wmEvent *event);
void wm_event_free_handler(wmEventHandler *handler);

/**
 * Goes over entire hierarchy: events -> window -> screen -> area -> region.
 *
 * \note Called in main loop.
 */
void wm_event_do_handlers(bContext *C);

/**
 * Windows store their own event queues #wmWindow.event_queue (no #bContext here).
 */
void wm_event_add_ghostevent(wmWindowManager *wm,
                             wmWindow *win,
                             int type,
                             const void *customdata,
                             const uint64_t event_time_ms);
#ifdef WITH_XR_OPENXR
void wm_event_add_xrevent(wmWindow *win, wmXrActionData *actiondata, short val);
#endif

void wm_event_do_depsgraph(bContext *C, bool is_after_open_file);
/**
 * Was part of #wm_event_do_notifiers,
 * split out so it can be called once before entering the #WM_main loop.
 * This ensures operators don't run before the UI and depsgraph are initialized.
 */
void wm_event_do_refresh_wm_and_depsgraph(bContext *C);
/**
 * Called in main-loop.
 */
void wm_event_do_notifiers(bContext *C);

void wm_event_handler_ui_cancel_ex(bContext *C,
                                   wmWindow *win,
                                   ARegion *region,
                                   bool reactivate_button);

/* `wm_event_query.cc`. */

/**
 * Applies the global tablet pressure correction curve.
 */
float wm_pressure_curve(float raw_pressure);
void wm_tablet_data_from_ghost(const GHOST_TabletData *tablet_data, wmTabletData *wmtab);

/* `wm_dropbox.cc`. */

void wm_dropbox_free();
/**
 * Additional work to cleanly end dragging. Additional because this doesn't actually remove the
 * drag items. Should be called whenever dragging is stopped
 * (successful or not, also when canceled).
 */
void wm_drags_exit(wmWindowManager *wm, wmWindow *win);
void wm_drop_prepare(bContext *C, wmDrag *drag, wmDropBox *drop);
void wm_drop_end(bContext *C, wmDrag *drag, wmDropBox *drop);
/**
 * Called in inner handler loop, region context.
 */
void wm_drags_check_ops(bContext *C, const wmEvent *event);
/**
 * The operator of a dropbox should always be executed in the context determined by the mouse
 * coordinates. The dropbox poll should check the context area and region as needed.
 * So this always returns #blender::wm::OpCallContext::InvokeDefault.
 */
blender::wm::OpCallContext wm_drop_operator_context_get(const wmDropBox *drop);
/**
 * Called in #wm_draw_window_onscreen.
 */
void wm_drags_draw(bContext *C, wmWindow *win);