WM_types.hh

Go to the documentation of this file.

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

 
#pragma once
 
struct ID;
struct ImBuf;
struct bContext;
struct bContextStore;
struct GreasePencil;
struct GreasePencilLayerTreeNode;
struct ReportList;
struct wmDrag;
struct wmDropBox;
struct wmEvent;
struct wmOperator;
struct wmWindowManager;
 
#include <memory>
#include <string>
 
#include "BLI_compiler_attrs.h"
#include "BLI_utildefines.h"
#include "BLI_vector.hh"
 
#include "DNA_listBase.h"
#include "DNA_uuid_types.h"
#include "DNA_vec_types.h"
#include "DNA_xr_types.h"
 
#include "BKE_wm_runtime.hh"  // IWYU pragma: export
 
#include "RNA_types.hh"
 
/* Exported types for WM. */
#include "gizmo/WM_gizmo_types.hh"  // IWYU pragma: export
#include "wm_cursors.hh"            // IWYU pragma: export
#include "wm_event_types.hh"        // IWYU pragma: export
 
/* Include external gizmo API's. */
#include "gizmo/WM_gizmo_api.hh"  // IWYU pragma: export
 
namespace blender::asset_system {
class AssetRepresentation;
}
using AssetRepresentationHandle = blender::asset_system::AssetRepresentation;
 
using wmGenericUserDataFreeFn = void (*)(void *data);
 
struct wmGenericUserData {
  void *data;
  wmGenericUserDataFreeFn free_fn;
  bool use_free;
};
 
using wmGenericCallbackFn = void (*)(bContext *C, void *user_data);
 
struct wmGenericCallback {
  wmGenericCallbackFn exec;
  void *user_data;
  wmGenericUserDataFreeFn free_user_data;
};
 
/* ************** wmOperatorType ************************ */

enum {
  OPTYPE_REGISTER = (1 << 0),
  OPTYPE_UNDO = (1 << 1),
  OPTYPE_BLOCKING = (1 << 2),
  OPTYPE_MACRO = (1 << 3),

  OPTYPE_GRAB_CURSOR_XY = (1 << 4),
  OPTYPE_GRAB_CURSOR_X = (1 << 5),
  OPTYPE_GRAB_CURSOR_Y = (1 << 6),

  OPTYPE_PRESET = (1 << 7),

  OPTYPE_INTERNAL = (1 << 8),

  OPTYPE_LOCK_BYPASS = (1 << 9),
  OPTYPE_UNDO_GROUPED = (1 << 10),

  OPTYPE_DEPENDS_ON_CURSOR = (1 << 11),

  OPTYPE_MODAL_PRIORITY = (1 << 12),
};

enum eWM_CursorWrapAxis {
  WM_CURSOR_WRAP_NONE = 0,
  WM_CURSOR_WRAP_X,
  WM_CURSOR_WRAP_Y,
  WM_CURSOR_WRAP_XY,
};

namespace blender::wm {
enum class OpCallContext : int8_t {
  /* If there's invoke, call it, otherwise exec. */
  InvokeDefault,
  InvokeRegionWin,
  InvokeRegionChannels,
  InvokeRegionPreview,
  InvokeArea,
  InvokeScreen,
  /* Only call exec. */
  ExecDefault,
  ExecRegionWin,
  ExecRegionChannels,
  ExecRegionPreview,
  ExecArea,
  ExecScreen,
};
}
 
#define WM_OP_CONTEXT_HAS_AREA(type) \
  (CHECK_TYPE_INLINE(type, blender::wm::OpCallContext), \
   !ELEM(type, blender::wm::OpCallContext::InvokeScreen, blender::wm::OpCallContext::ExecScreen))
#define WM_OP_CONTEXT_HAS_REGION(type) \
  (WM_OP_CONTEXT_HAS_AREA(type) && \
   !ELEM(type, blender::wm::OpCallContext::InvokeArea, blender::wm::OpCallContext::ExecArea))

enum eOperatorPropTags {
  OP_PROP_TAG_ADVANCED = (1 << 0),
};
#define OP_PROP_TAG_ADVANCED ((eOperatorPropTags)OP_PROP_TAG_ADVANCED)
 
/* -------------------------------------------------------------------- */

enum wmEventModifierFlag : uint8_t {
  KM_SHIFT = (1 << 0),
  KM_CTRL = (1 << 1),
  KM_ALT = (1 << 2),
  KM_OSKEY = (1 << 3),
  KM_HYPER = (1 << 4),
};
ENUM_OPERATORS(wmEventModifierFlag, KM_HYPER);

#define KM_MOD_NUM 5

enum {
  KM_TEXTINPUT = -2,
};

enum {
  KM_ANY = -1,
  KM_NOTHING = 0,
  KM_PRESS = 1,
  KM_RELEASE = 2,
  KM_CLICK = 3,
  KM_DBL_CLICK = 4,
  KM_PRESS_DRAG = 5,
};
#define KM_MOD_HELD 1

enum {
  KM_DIRECTION_N = 1,
  KM_DIRECTION_NE = 2,
  KM_DIRECTION_E = 3,
  KM_DIRECTION_SE = 4,
  KM_DIRECTION_S = 5,
  KM_DIRECTION_SW = 6,
  KM_DIRECTION_W = 7,
  KM_DIRECTION_NW = 8,
};

 
/* ************** UI Handler ***************** */
 
#define WM_UI_HANDLER_CONTINUE 0
#define WM_UI_HANDLER_BREAK 1
 
/* ************** Notifiers ****************** */
 
struct wmNotifier {
  wmNotifier *next, *prev;
 
  const wmWindow *window;
 
  unsigned int category, data, subtype, action;
 
  void *reference;
};
 
/* 4 levels
 *
 * 0xFF000000; category
 * 0x00FF0000; data
 * 0x0000FF00; data subtype (unused?)
 * 0x000000FF; action
 */
 
/* Category. */
#define NOTE_CATEGORY 0xFF000000
#define NOTE_CATEGORY_TAG_CLEARED NOTE_CATEGORY
#define NC_WM (1 << 24)
#define NC_WINDOW (2 << 24)
#define NC_WORKSPACE (3 << 24)
#define NC_SCREEN (4 << 24)
#define NC_SCENE (5 << 24)
#define NC_OBJECT (6 << 24)
#define NC_MATERIAL (7 << 24)
#define NC_TEXTURE (8 << 24)
#define NC_LAMP (9 << 24)
#define NC_GROUP (10 << 24)
#define NC_IMAGE (11 << 24)
#define NC_BRUSH (12 << 24)
#define NC_TEXT (13 << 24)
#define NC_WORLD (14 << 24)
#define NC_ANIMATION (15 << 24)
/* When passing a space as reference data with this (e.g. `WM_event_add_notifier(..., space)`),
 * the notifier will only be sent to this space. That avoids unnecessary updates for unrelated
 * spaces. */
#define NC_SPACE (16 << 24)
#define NC_GEOM (17 << 24)
#define NC_NODE (18 << 24)
#define NC_ID (19 << 24)
#define NC_PAINTCURVE (20 << 24)
#define NC_MOVIECLIP (21 << 24)
#define NC_MASK (22 << 24)
#define NC_GPENCIL (23 << 24)
#define NC_LINESTYLE (24 << 24)
#define NC_CAMERA (25 << 24)
#define NC_LIGHTPROBE (26 << 24)
/* Changes to asset data in the current .blend. */
#define NC_ASSET (27 << 24)
/* Changes to the active viewer path. */
#define NC_VIEWER_PATH (28 << 24)
 
/* Data type, 256 entries is enough, it can overlap. */
#define NOTE_DATA 0x00FF0000
 
/* NC_WM (window-manager). */
#define ND_FILEREAD (1 << 16)
#define ND_FILESAVE (2 << 16)
#define ND_DATACHANGED (3 << 16)
#define ND_HISTORY (4 << 16)
#define ND_JOB (5 << 16)
#define ND_UNDO (6 << 16)
#define ND_XR_DATA_CHANGED (7 << 16)
#define ND_LIB_OVERRIDE_CHANGED (8 << 16)
 
/* NC_SCREEN. */
#define ND_LAYOUTBROWSE (1 << 16)
#define ND_LAYOUTDELETE (2 << 16)
#define ND_ANIMPLAY (4 << 16)
#define ND_GPENCIL (5 << 16)
#define ND_LAYOUTSET (6 << 16)
#define ND_SKETCH (7 << 16)
#define ND_WORKSPACE_SET (8 << 16)
#define ND_WORKSPACE_DELETE (9 << 16)
 
/* NC_SCENE Scene. */
#define ND_SCENEBROWSE (1 << 16)
#define ND_MARKERS (2 << 16)
#define ND_FRAME (3 << 16)
#define ND_RENDER_OPTIONS (4 << 16)
#define ND_NODES (5 << 16)
#define ND_SEQUENCER (6 << 16)
/* NOTE: If an object was added, removed, merged/joined, ..., it is not enough to notify with
 * this. This affects the layer so also send a layer change notifier (e.g. ND_LAYER_CONTENT)! */
#define ND_OB_ACTIVE (7 << 16)
/* See comment on ND_OB_ACTIVE. */
#define ND_OB_SELECT (8 << 16)
#define ND_OB_VISIBLE (9 << 16)
#define ND_OB_RENDER (10 << 16)
#define ND_MODE (11 << 16)
#define ND_RENDER_RESULT (12 << 16)
#define ND_COMPO_RESULT (13 << 16)
#define ND_KEYINGSET (14 << 16)
#define ND_TOOLSETTINGS (15 << 16)
#define ND_LAYER (16 << 16)
#define ND_FRAME_RANGE (17 << 16)
#define ND_WORLD (92 << 16)
#define ND_LAYER_CONTENT (101 << 16)
 
/* NC_OBJECT Object. */
#define ND_TRANSFORM (18 << 16)
#define ND_OB_SHADING (19 << 16)
#define ND_POSE (20 << 16)
#define ND_BONE_ACTIVE (21 << 16)
#define ND_BONE_SELECT (22 << 16)
#define ND_DRAW (23 << 16)
#define ND_MODIFIER (24 << 16)
#define ND_KEYS (25 << 16)
#define ND_CONSTRAINT (26 << 16)
#define ND_PARTICLE (27 << 16)
#define ND_POINTCACHE (28 << 16)
#define ND_PARENT (29 << 16)
#define ND_LOD (30 << 16)
#define ND_DRAW_RENDER_VIEWPORT (31 << 16)
#define ND_SHADERFX (32 << 16)
/* For updating motion paths in 3dview. */
#define ND_DRAW_ANIMVIZ (33 << 16)
#define ND_BONE_COLLECTION (34 << 16)
 
/* NC_MATERIAL Material. */
#define ND_SHADING (30 << 16)
#define ND_SHADING_DRAW (31 << 16)
#define ND_SHADING_LINKS (32 << 16)
#define ND_SHADING_PREVIEW (33 << 16)
 
/* NC_LAMP Light. */
#define ND_LIGHTING (40 << 16)
#define ND_LIGHTING_DRAW (41 << 16)
 
/* NC_WORLD World. */
#define ND_WORLD_DRAW (45 << 16)
 
/* NC_TEXT Text. */
#define ND_CURSOR (50 << 16)
#define ND_DISPLAY (51 << 16)
 
/* NC_ANIMATION Animato. */
#define ND_KEYFRAME (70 << 16)
#define ND_KEYFRAME_PROP (71 << 16)
#define ND_ANIMCHAN (72 << 16)
#define ND_NLA (73 << 16)
#define ND_NLA_ACTCHANGE (74 << 16)
#define ND_FCURVES_ORDER (75 << 16)
#define ND_NLA_ORDER (76 << 16)
#define ND_KEYFRAME_AUTO (77 << 16)
 
/* NC_GPENCIL. */
#define ND_GPENCIL_EDITMODE (85 << 16)
 
/* NC_GEOM Geometry. */
/* Mesh, Curve, MetaBall, Armature, etc. */
#define ND_SELECT (90 << 16)
#define ND_DATA (91 << 16)
#define ND_VERTEX_GROUP (92 << 16)
 
/* NC_NODE Nodes. */
 
/* Influences which menus node assets are included in. */
#define ND_NODE_ASSET_DATA (1 << 16)
#define ND_NODE_GIZMO (2 << 16)
 
/* NC_SPACE. */
#define ND_SPACE_CONSOLE (1 << 16)     /* General redraw. */
#define ND_SPACE_INFO_REPORT (2 << 16) /* Update for reports, could specify type. */
#define ND_SPACE_INFO (3 << 16)
#define ND_SPACE_IMAGE (4 << 16)
#define ND_SPACE_FILE_PARAMS (5 << 16)
#define ND_SPACE_FILE_LIST (6 << 16)
#define ND_SPACE_ASSET_PARAMS (7 << 16)
#define ND_SPACE_NODE (8 << 16)
#define ND_SPACE_OUTLINER (9 << 16)
#define ND_SPACE_VIEW3D (10 << 16)
#define ND_SPACE_PROPERTIES (11 << 16)
#define ND_SPACE_TEXT (12 << 16)
#define ND_SPACE_TIME (13 << 16)
#define ND_SPACE_GRAPH (14 << 16)
#define ND_SPACE_DOPESHEET (15 << 16)
#define ND_SPACE_NLA (16 << 16)
#define ND_SPACE_SEQUENCER (17 << 16)
#define ND_SPACE_NODE_VIEW (18 << 16)
/* Sent to a new editor type after it's replaced an old one. */
#define ND_SPACE_CHANGED (19 << 16)
#define ND_SPACE_CLIP (20 << 16)
#define ND_SPACE_FILE_PREVIEW (21 << 16)
#define ND_SPACE_SPREADSHEET (22 << 16)
/* Not a space itself, but a part of another space. */
#define ND_REGIONS_ASSET_SHELF (23 << 16)
 
/* NC_ASSET. */
/* Denotes that the AssetList is done reading some previews. NOT that the preview generation of
 * assets is done. */
#define ND_ASSET_LIST (1 << 16)
#define ND_ASSET_LIST_PREVIEW (2 << 16)
#define ND_ASSET_LIST_READING (3 << 16)
/* Catalog data changed, requiring a redraw of catalog UIs. Note that this doesn't denote a
 * reloading of asset libraries & their catalogs should happen. That only happens on explicit user
 * action. */
#define ND_ASSET_CATALOGS (4 << 16)
 
/* Subtype, 256 entries too. */
#define NOTE_SUBTYPE 0x0000FF00
 
/* Subtype scene mode. */
#define NS_MODE_OBJECT (1 << 8)
 
#define NS_EDITMODE_MESH (2 << 8)
#define NS_EDITMODE_CURVE (3 << 8)
#define NS_EDITMODE_SURFACE (4 << 8)
#define NS_EDITMODE_TEXT (5 << 8)
#define NS_EDITMODE_MBALL (6 << 8)
#define NS_EDITMODE_LATTICE (7 << 8)
#define NS_EDITMODE_ARMATURE (8 << 8)
#define NS_MODE_POSE (9 << 8)
#define NS_MODE_PARTICLE (10 << 8)
#define NS_EDITMODE_CURVES (11 << 8)
#define NS_EDITMODE_GREASE_PENCIL (12 << 8)
#define NS_EDITMODE_POINTCLOUD (13 << 8)
 
/* Subtype 3d view editing. */
#define NS_VIEW3D_GPU (16 << 8)
#define NS_VIEW3D_SHADING (17 << 8)
 
/* Subtype layer editing. */
#define NS_LAYER_COLLECTION (24 << 8)
 
/* Action classification. */
#define NOTE_ACTION (0x000000FF)
#define NA_EDITED 1
#define NA_EVALUATED 2
#define NA_ADDED 3
#define NA_REMOVED 4
#define NA_RENAME 5
#define NA_SELECTED 6
#define NA_ACTIVATED 7
#define NA_PAINTING 8
#define NA_JOB_FINISHED 9
 
/* ************** Gesture Manager data ************** */
 
namespace blender::wm::gesture {
constexpr float POLYLINE_CLICK_RADIUS = 15.0f;
}

#define WM_GESTURE_LINES 1
#define WM_GESTURE_RECT 2
#define WM_GESTURE_CROSS_RECT 3
#define WM_GESTURE_LASSO 4
#define WM_GESTURE_CIRCLE 5
#define WM_GESTURE_STRAIGHTLINE 6
#define WM_GESTURE_POLYLINE 7

struct wmGesture {
  wmGesture *next, *prev;
  int event_type;
  uint8_t event_modifier;
  short event_keymodifier;
  int type;
  rcti winrct;
  int points;
  int points_alloc;
  int modal_state;
  bool draw_active_side;
  blender::int2 mval;

  uint is_active : 1;
  uint is_active_prev : 1;
  uint wait_for_input : 1;
  uint move : 1;
  uint use_snap : 1;
  uint use_flip : 1;
  uint use_smooth : 1;

  void *customdata;

  wmGenericUserData user_data;
};
 
/* ************** wmEvent ************************ */
 
enum eWM_EventFlag {
  WM_EVENT_SCROLL_INVERT = (1 << 0),
  WM_EVENT_IS_REPEAT = (1 << 1),
  WM_EVENT_IS_CONSECUTIVE = (1 << 2),
  WM_EVENT_FORCE_DRAG_THRESHOLD = (1 << 3),
};
ENUM_OPERATORS(eWM_EventFlag, WM_EVENT_FORCE_DRAG_THRESHOLD);
 
struct wmTabletData {
  int active;
  float pressure;
  blender::float2 tilt;
  char is_motion_absolute;
};

struct wmEvent {
  wmEvent *next, *prev;

  wmEventType type;
  short val;
  int xy[2];
  int mval[2];
  char utf8_buf[6];

  wmEventModifierFlag modifier;

  int8_t direction;

  wmEventType keymodifier;

  wmTabletData tablet;
 
  eWM_EventFlag flag;
 
  /* Custom data. */

  short custom;
  short customdata_free;
  void *customdata;
 
  /* Previous State. */

  wmEventType prev_type;
  short prev_val;
  int prev_xy[2];
 
  /* Previous Press State (when `val == KM_PRESS`). */

  wmEventType prev_press_type;
  int prev_press_xy[2];
  wmEventModifierFlag prev_press_modifier;
  wmEventType prev_press_keymodifier;
};

#define WM_EVENT_CURSOR_MOTION_THRESHOLD ((float)U.move_threshold * UI_SCALE_FAC)

enum wmProgress {
  P_NOT_STARTED = 0,
  P_STARTING,    /* <-- */
  P_IN_PROGRESS, /* <-- only these are sent for NDOF motion. */
  P_FINISHING,   /* <-- */
  P_FINISHED,
};
 
#ifdef WITH_INPUT_NDOF
struct wmNDOFMotionData {
  /* Awfully similar to #GHOST_TEventNDOFMotionData. */
  float tvec[3];
  float rvec[3];
  float time_delta;
  wmProgress progress;
};
#endif /* WITH_INPUT_NDOF */
 
#ifdef WITH_XR_OPENXR
/* Similar to GHOST_XrPose. */
struct wmXrPose {
  float position[3];
  /* Blender convention (w, x, y, z). */
  float orientation_quat[4];
};
 
struct wmXrActionState {
  union {
    bool state_boolean;
    float state_float;
    float state_vector2f[2];
    wmXrPose state_pose;
  };
  int type; /* #eXrActionType. */
};
 
struct wmXrActionData {
  char action_set[64];
  char action[64];
  char user_path[64];
  char user_path_other[64];
  eXrActionType type;
  float state[2];
  float state_other[2];

  float float_threshold;

  float controller_loc[3];
  float controller_rot[4];
  float controller_loc_other[3];
  float controller_rot_other[4];

  wmOperatorType *ot;
  IDProperty *op_properties;

  bool bimanual;
};
#endif

enum wmTimerFlags {
  WM_TIMER_NO_FREE_CUSTOM_DATA = 1 << 0,
 
  /* Internal flags, should not be used outside of WM code. */
  WM_TIMER_TAGGED_FOR_REMOVAL = 1 << 16,
};
ENUM_OPERATORS(wmTimerFlags, WM_TIMER_TAGGED_FOR_REMOVAL)
 
struct wmTimer {
  wmTimer *next, *prev;

  wmWindow *win;

  double time_step;
  wmEventType event_type;
  wmTimerFlags flags;
  void *customdata;

  double time_duration;
  double time_delta;

  double time_last;
  double time_next;
  double time_start;
  bool sleep;
};
 
enum wmPopupSize {
  WM_POPUP_SIZE_SMALL = 0,
  WM_POPUP_SIZE_LARGE,
};
 
enum wmPopupPosition {
  WM_POPUP_POSITION_MOUSE = 0,
  WM_POPUP_POSITION_CENTER,
};

struct wmJobWorkerStatus {
  bool do_update;

  bool stop;

  float progress;

  ReportList *reports;
};
 
struct wmOperatorType {
  const char *name;
  const char *idname;
  const char *translation_context;
  const char *description;
  const char *undo_group;

  wmOperatorStatus (*exec)(bContext *C, wmOperator *op) ATTR_WARN_UNUSED_RESULT;

  bool (*check)(bContext *C, wmOperator *op);

  wmOperatorStatus (*invoke)(bContext *C,
                             wmOperator *op,
                             const wmEvent *event) ATTR_WARN_UNUSED_RESULT;

  void (*cancel)(bContext *C, wmOperator *op);

  wmOperatorStatus (*modal)(bContext *C,
                            wmOperator *op,
                            const wmEvent *event) ATTR_WARN_UNUSED_RESULT;

  bool (*poll)(bContext *C) ATTR_WARN_UNUSED_RESULT;

  bool (*poll_property)(const bContext *C,
                        wmOperator *op,
                        const PropertyRNA *prop) ATTR_WARN_UNUSED_RESULT;

  void (*ui)(bContext *C, wmOperator *op);
  bool (*ui_poll)(wmOperatorType *ot, PointerRNA *ptr);

  std::string (*get_name)(wmOperatorType *ot, PointerRNA *ptr);

  std::string (*get_description)(bContext *C, wmOperatorType *ot, PointerRNA *ptr);

  bool (*depends_on_cursor)(bContext &C, wmOperatorType &ot, PointerRNA *ptr);

  StructRNA *srna;

  IDProperty *last_properties;

  PropertyRNA *prop;

  ListBase macro;

  wmKeyMap *modalkeymap;

  bool (*pyop_poll)(bContext *C, wmOperatorType *ot) ATTR_WARN_UNUSED_RESULT;

  ExtensionRNA rna_ext;

  int cursor_pending;

  short flag;
};

struct wmOperatorCallParams {
  wmOperatorType *optype;
  PointerRNA *opptr;
  blender::wm::OpCallContext opcontext;
};
 
#ifdef WITH_INPUT_IME
/* *********** Input Method Editor (IME) *********** */
struct wmIMEData {
  std::string result;
  std::string composite;

  int cursor_pos;
  int sel_start;
  int sel_end;
};
#endif
 
/* **************** Paint Cursor ******************* */
 
using wmPaintCursorDraw = void (*)(bContext *C,
                                   const blender::int2 &xy,
                                   const blender::float2 &tilt,
                                   void *customdata);
 
/* *************** Drag and drop *************** */
 
enum eWM_DragDataType : int8_t {
  WM_DRAG_ID,
  WM_DRAG_ASSET,
  WM_DRAG_ASSET_LIST,
  WM_DRAG_RNA,
  WM_DRAG_PATH,
  WM_DRAG_NAME,
  WM_DRAG_STRING,
  WM_DRAG_COLOR,
  WM_DRAG_DATASTACK,
  WM_DRAG_ASSET_CATALOG,
  WM_DRAG_GREASE_PENCIL_LAYER,
  WM_DRAG_GREASE_PENCIL_GROUP,
  WM_DRAG_NODE_TREE_INTERFACE,
  WM_DRAG_BONE_COLLECTION,
  WM_DRAG_SHAPE_KEY,
};
 
enum eWM_DragFlags {
  WM_DRAG_NOP = 0,
  WM_DRAG_FREE_DATA = 1,
};
ENUM_OPERATORS(eWM_DragFlags, WM_DRAG_FREE_DATA)
 
/* NOTE: structs need not exported? */
 
struct wmDragID {
  wmDragID *next, *prev;
  ID *id;
  ID *from_parent;
};
 
struct wmDragAsset {
  const AssetRepresentationHandle *asset;
  AssetImportSettings import_settings;
};
 
struct wmDragAssetCatalog {
  bUUID drag_catalog_id;
};

struct wmDragAssetListItem {
  wmDragAssetListItem *next, *prev;
 
  union {
    ID *local_id;
    wmDragAsset *external_info;
  } asset_data;
 
  bool is_external;
};
 
struct wmDragPath {
  blender::Vector<std::string> paths;
  /* File type of each path in #paths. */
  blender::Vector<int> file_types; /* #eFileSel_File_Types. */
  /* Bit flag of file types in #paths. */
  int file_types_bit_flag; /* #eFileSel_File_Types. */
  std::string tooltip;
};
 
struct wmDragGreasePencilLayer {
  GreasePencil *grease_pencil;
  GreasePencilLayerTreeNode *node;
};
 
using WMDropboxTooltipFunc = std::string (*)(bContext *C,
                                             wmDrag *drag,
                                             const int xy[2],
                                             wmDropBox *drop);
 
struct wmDragActiveDropState {
  wmDragActiveDropState();
  ~wmDragActiveDropState();

  wmDropBox *active_dropbox;

  ScrArea *area_from;
  ARegion *region_from;

  std::unique_ptr<bContextStore> ui_context;

  const char *disabled_info;
  bool free_disabled_info;
 
  std::string tooltip;
};
 
struct wmDrag {
  wmDrag *next, *prev;
 
  int icon;
  eWM_DragDataType type;
  void *poin;

  const ImBuf *imb;
  float imbuf_scale;
  int preview_icon_id; /* BIFIconID */
 
  wmDragActiveDropState drop_state;
 
  eWM_DragFlags flags;

  ListBase ids;
  ListBase asset_items;
};

struct wmDropBox {
  wmDropBox *next, *prev;

  bool (*poll)(bContext *C, wmDrag *drag, const wmEvent *event);

  void (*on_drag_start)(bContext *C, wmDrag *drag);

  void (*on_enter)(wmDropBox *drop, wmDrag *drag);

  void (*on_exit)(wmDropBox *drop, wmDrag *drag);

  void (*copy)(bContext *C, wmDrag *drag, wmDropBox *drop);

  void (*cancel)(Main *bmain, wmDrag *drag, wmDropBox *drop);

  void (*draw_droptip)(bContext *C, wmWindow *win, wmDrag *drag, const int xy[2]);

  void (*draw_in_view)(bContext *C, wmWindow *win, wmDrag *drag, const int xy[2]);

  void *draw_data;

  WMDropboxTooltipFunc tooltip;

  wmOperatorType *ot;
  char opname[64];

  IDProperty *properties;
  PointerRNA *ptr;
};

struct wmTooltipState {
  wmTimer *timer;
  ScrArea *area_from;
  ARegion *region_from;
  ARegion *region;
  ARegion *(*init)(
      bContext *C, ARegion *region, int *pass, double *pass_delay, bool *r_exit_on_event);
  bool exit_on_event;
  int event_xy[2];
  int pass;
};
 
/* *************** migrated stuff, clean later? ************** */
 
struct RecentFile {
  RecentFile *next, *prev;
  char *filepath;
};
 
/* Logging. */
struct CLG_LogRef;
/* `wm_init_exit.cc`. */
 
extern CLG_LogRef *WM_LOG_OPERATORS;
extern CLG_LogRef *WM_LOG_EVENTS;
extern CLG_LogRef *WM_LOG_TOOL_GIZMO;
extern CLG_LogRef *WM_LOG_MSGBUS_PUB;
extern CLG_LogRef *WM_LOG_MSGBUS_SUB;