Cleanup: move public event queries into their own file

event_system.c has been collecting a lot of different functionality,
move generic query/access functions into their own file,
since these are used by operators and other parts of the windowing code
and aren't part of low level event handling.

Also move public last-property API to wm_operators.c.

1 files changed, 9 insertions, 460 deletions

diff --git a/source/blender/windowmanager/intern/wm_event_system.c b/source/blender/windowmanager/intern/wm_event_system.c
index bc068173327..974b5f9da38 100644
--- a/source/blender/windowmanager/intern/wm_event_system.c
+++ b/source/blender/windowmanager/intern/wm_event_system.c
@@ -70,7 +70,6 @@
 #include "RNA_access.h"
 
 #include "UI_interface.h"
-#include "UI_view2d.h"
 
 #include "PIL_time.h"
 
@@ -84,8 +83,6 @@
 #include "wm_event_system.h"
 #include "wm_event_types.h"
 
-#include "RNA_enum_types.h"
-
 #include "DEG_depsgraph.h"
 #include "DEG_depsgraph_query.h"
 
@@ -762,86 +759,6 @@ void WM_operator_region_active_win_set(bContext *C)
   }
 }
 
-int WM_event_modifier_flag(const wmEvent *event)
-{
-  int flag = 0;
-  if (event->ctrl) {
-    flag |= KM_CTRL;
-  }
-  if (event->alt) {
-    flag |= KM_ALT;
-  }
-  if (event->shift) {
-    flag |= KM_SHIFT;
-  }
-  if (event->oskey) {
-    flag |= KM_OSKEY;
-  }
-  return flag;
-}
-
-/* for debugging only, getting inspecting events manually is tedious */
-void WM_event_print(const wmEvent *event)
-{
-  if (event) {
-    const char *unknown = "UNKNOWN";
-    const char *type_id = unknown;
-    const char *val_id = unknown;
-
-    RNA_enum_identifier(rna_enum_event_type_items, event->type, &type_id);
-    RNA_enum_identifier(rna_enum_event_value_items, event->val, &val_id);
-
-    printf(
-        "wmEvent  type:%d / %s, val:%d / %s,\n"
-        "         shift:%d, ctrl:%d, alt:%d, oskey:%d, keymodifier:%d,\n"
-        "         mouse:(%d,%d), ascii:'%c', utf8:'%.*s', keymap_idname:%s, pointer:%p\n",
-        event->type,
-        type_id,
-        event->val,
-        val_id,
-        event->shift,
-        event->ctrl,
-        event->alt,
-        event->oskey,
-        event->keymodifier,
-        event->x,
-        event->y,
-        event->ascii,
-        BLI_str_utf8_size(event->utf8_buf),
-        event->utf8_buf,
-        event->keymap_idname,
-        (const void *)event);
-
-#ifdef WITH_INPUT_NDOF
-    if (ISNDOF(event->type)) {
-      const wmNDOFMotionData *ndof = event->customdata;
-      if (event->type == NDOF_MOTION) {
-        printf("   ndof: rot: (%.4f %.4f %.4f), tx: (%.4f %.4f %.4f), dt: %.4f, progress: %u\n",
-               UNPACK3(ndof->rvec),
-               UNPACK3(ndof->tvec),
-               ndof->dt,
-               ndof->progress);
-      }
-      else {
-        /* ndof buttons printed already */
-      }
-    }
-#endif /* WITH_INPUT_NDOF */
-
-    if (event->tablet_data) {
-      const wmTabletData *wmtab = event->tablet_data;
-      printf(" tablet: active: %d, pressure %.4f, tilt: (%.4f %.4f)\n",
-             wmtab->Active,
-             wmtab->Pressure,
-             wmtab->Xtilt,
-             wmtab->Ytilt);
-    }
-  }
-  else {
-    printf("wmEvent - NULL\n");
-  }
-}
-
 /**
  * Show the report in the info header.
  */
@@ -861,16 +778,6 @@ void WM_report_banner_show(void)
   wm_reports->reporttimer->customdata = rti;
 }
 
-bool WM_event_is_last_mousemove(const wmEvent *event)
-{
-  while ((event = event->next)) {
-    if (ELEM(event->type, MOUSEMOVE, INBETWEEN_MOUSEMOVE)) {
-      return false;
-    }
-  }
-  return true;
-}
-
 #ifdef WITH_INPUT_NDOF
 void WM_ndof_deadzone_set(float deadzone)
 {
@@ -1301,105 +1208,6 @@ static void wm_region_mouse_co(bContext *C, wmEvent *event)
   }
 }
 
-#if 1 /* may want to disable operator remembering previous state for testing */
-
-static bool operator_last_properties_init_impl(wmOperator *op, IDProperty *last_properties)
-{
-  bool changed = false;
-  IDPropertyTemplate val = {0};
-  IDProperty *replaceprops = IDP_New(IDP_GROUP, &val, "wmOperatorProperties");
-  PropertyRNA *iterprop;
-
-  CLOG_INFO(WM_LOG_OPERATORS, 1, "loading previous properties for '%s'", op->type->idname);
-
-  iterprop = RNA_struct_iterator_property(op->type->srna);
-
-  RNA_PROP_BEGIN (op->ptr, itemptr, iterprop) {
-    PropertyRNA *prop = itemptr.data;
-    if ((RNA_property_flag(prop) & PROP_SKIP_SAVE) == 0) {
-      if (!RNA_property_is_set(op->ptr, prop)) { /* don't override a setting already set */
-        const char *identifier = RNA_property_identifier(prop);
-        IDProperty *idp_src = IDP_GetPropertyFromGroup(last_properties, identifier);
-        if (idp_src) {
-          IDProperty *idp_dst = IDP_CopyProperty(idp_src);
-
-          /* note - in the future this may need to be done recursively,
-           * but for now RNA doesn't access nested operators */
-          idp_dst->flag |= IDP_FLAG_GHOST;
-
-          /* add to temporary group instead of immediate replace,
-           * because we are iterating over this group */
-          IDP_AddToGroup(replaceprops, idp_dst);
-          changed = true;
-        }
-      }
-    }
-  }
-  RNA_PROP_END;
-
-  IDP_MergeGroup(op->properties, replaceprops, true);
-  IDP_FreeProperty(replaceprops);
-  return changed;
-}
-
-bool WM_operator_last_properties_init(wmOperator *op)
-{
-  bool changed = false;
-  if (op->type->last_properties) {
-    changed |= operator_last_properties_init_impl(op, op->type->last_properties);
-    for (wmOperator *opm = op->macro.first; opm; opm = opm->next) {
-      IDProperty *idp_src = IDP_GetPropertyFromGroup(op->type->last_properties, opm->idname);
-      if (idp_src) {
-        changed |= operator_last_properties_init_impl(opm, idp_src);
-      }
-    }
-  }
-  return changed;
-}
-
-bool WM_operator_last_properties_store(wmOperator *op)
-{
-  if (op->type->last_properties) {
-    IDP_FreeProperty(op->type->last_properties);
-    op->type->last_properties = NULL;
-  }
-
-  if (op->properties) {
-    CLOG_INFO(WM_LOG_OPERATORS, 1, "storing properties for '%s'", op->type->idname);
-    op->type->last_properties = IDP_CopyProperty(op->properties);
-  }
-
-  if (op->macro.first != NULL) {
-    for (wmOperator *opm = op->macro.first; opm; opm = opm->next) {
-      if (opm->properties) {
-        if (op->type->last_properties == NULL) {
-          op->type->last_properties = IDP_New(
-              IDP_GROUP, &(IDPropertyTemplate){0}, "wmOperatorProperties");
-        }
-        IDProperty *idp_macro = IDP_CopyProperty(opm->properties);
-        STRNCPY(idp_macro->name, opm->type->idname);
-        IDP_ReplaceInGroup(op->type->last_properties, idp_macro);
-      }
-    }
-  }
-
-  return (op->type->last_properties != NULL);
-}
-
-#else
-
-bool WM_operator_last_properties_init(wmOperator *UNUSED(op))
-{
-  return false;
-}
-
-bool WM_operator_last_properties_store(wmOperator *UNUSED(op))
-{
-  return false;
-}
-
-#endif
-
 /**
  * Also used for exec when 'event' is NULL.
  */
@@ -1954,42 +1762,6 @@ void WM_event_remove_handlers(bContext *C, ListBase *handlers)
   }
 }
 
-/* do userdef mappings */
-int WM_userdef_event_map(int kmitype)
-{
-  switch (kmitype) {
-    case WHEELOUTMOUSE:
-      return (U.uiflag & USER_WHEELZOOMDIR) ? WHEELUPMOUSE : WHEELDOWNMOUSE;
-    case WHEELINMOUSE:
-      return (U.uiflag & USER_WHEELZOOMDIR) ? WHEELDOWNMOUSE : WHEELUPMOUSE;
-  }
-
-  return kmitype;
-}
-
-/**
- * Use so we can check if 'wmEvent.type' is released in modal operators.
- *
- * An alternative would be to add a 'wmEvent.type_nokeymap'... or similar.
- */
-int WM_userdef_event_type_from_keymap_type(int kmitype)
-{
-  switch (kmitype) {
-    case EVT_TWEAK_L:
-      return LEFTMOUSE;
-    case EVT_TWEAK_M:
-      return MIDDLEMOUSE;
-    case EVT_TWEAK_R:
-      return RIGHTMOUSE;
-    case WHEELOUTMOUSE:
-      return (U.uiflag & USER_WHEELZOOMDIR) ? WHEELUPMOUSE : WHEELDOWNMOUSE;
-    case WHEELINMOUSE:
-      return (U.uiflag & USER_WHEELZOOMDIR) ? WHEELDOWNMOUSE : WHEELUPMOUSE;
-  }
-
-  return kmitype;
-}
-
 static bool wm_eventmatch(const wmEvent *winevent, const wmKeyMapItem *kmi)
 {
   if (kmi->flag & KMI_INACTIVE) {
@@ -4099,91 +3871,6 @@ void WM_event_add_mousemove(const bContext *C)
   window->addmousemove = 1;
 }
 
-/* for modal callbacks, check configuration for how to interpret exit with tweaks  */
-bool WM_event_is_modal_tweak_exit(const wmEvent *event, int tweak_event)
-{
-  /* if the release-confirm userpref setting is enabled,
-   * tweak events can be canceled when mouse is released
-   */
-  if (U.flag & USER_RELEASECONFIRM) {
-    /* option on, so can exit with km-release */
-    if (event->val == KM_RELEASE) {
-      switch (tweak_event) {
-        case EVT_TWEAK_L:
-        case EVT_TWEAK_M:
-        case EVT_TWEAK_R:
-          return 1;
-      }
-    }
-    else {
-      /* if the initial event wasn't a tweak event then
-       * ignore USER_RELEASECONFIRM setting: see [#26756] */
-      if (ELEM(tweak_event, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R) == 0) {
-        return 1;
-      }
-    }
-  }
-  else {
-    /* this is fine as long as not doing km-release, otherwise
-     * some items (i.e. markers) being tweaked may end up getting
-     * dropped all over
-     */
-    if (event->val != KM_RELEASE) {
-      return 1;
-    }
-  }
-
-  return 0;
-}
-
-bool WM_event_type_mask_test(const int event_type, const enum eEventType_Mask mask)
-{
-  /* Keyboard. */
-  if (mask & EVT_TYPE_MASK_KEYBOARD) {
-    if (ISKEYBOARD(event_type)) {
-      return true;
-    }
-  }
-  else if (mask & EVT_TYPE_MASK_KEYBOARD_MODIFIER) {
-    if (ISKEYMODIFIER(event_type)) {
-      return true;
-    }
-  }
-
-  /* Mouse. */
-  if (mask & EVT_TYPE_MASK_MOUSE) {
-    if (ISMOUSE(event_type)) {
-      return true;
-    }
-  }
-  else if (mask & EVT_TYPE_MASK_MOUSE_WHEEL) {
-    if (ISMOUSE_WHEEL(event_type)) {
-      return true;
-    }
-  }
-  else if (mask & EVT_TYPE_MASK_MOUSE_GESTURE) {
-    if (ISMOUSE_GESTURE(event_type)) {
-      return true;
-    }
-  }
-
-  /* Tweak. */
-  if (mask & EVT_TYPE_MASK_TWEAK) {
-    if (ISTWEAK(event_type)) {
-      return true;
-    }
-  }
-
-  /* Action Zone. */
-  if (mask & EVT_TYPE_MASK_ACTIONZONE) {
-    if (IS_EVENT_ACTIONZONE(event_type)) {
-      return true;
-    }
-  }
-
-  return false;
-}
-
 /** \} */
 
 /* -------------------------------------------------------------------- */
@@ -4421,22 +4108,6 @@ static void wm_eventemulation(wmEvent *event, bool test_only)
   }
 }
 
-/* applies the global tablet pressure correction curve */
-float wm_pressure_curve(float pressure)
-{
-  if (U.pressure_threshold_max != 0.0f) {
-    pressure /= U.pressure_threshold_max;
-  }
-
-  CLAMP(pressure, 0.0f, 1.0f);
-
-  if (U.pressure_softness != 0.0f) {
-    pressure = powf(pressure, powf(4.0f, -U.pressure_softness));
-  }
-
-  return pressure;
-}
-
 /* adds customdata to event */
 static void update_tablet_data(wmWindow *win, wmEvent *event)
 {
@@ -5024,96 +4695,12 @@ void WM_set_locked_interface(wmWindowManager *wm, bool lock)
   BKE_spacedata_draw_locks(lock);
 }
 
-#ifdef WITH_INPUT_NDOF
+/** \} */
 
 /* -------------------------------------------------------------------- */
-/** \name NDOF Utility Functions
+/** \name Event / Keymap Matching API
  * \{ */
 
-void WM_event_ndof_pan_get(const wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom)
-{
-  int z_flag = use_zoom ? NDOF_ZOOM_INVERT : NDOF_PANZ_INVERT_AXIS;
-  r_pan[0] = ndof->tvec[0] * ((U.ndof_flag & NDOF_PANX_INVERT_AXIS) ? -1.0f : 1.0f);
-  r_pan[1] = ndof->tvec[1] * ((U.ndof_flag & NDOF_PANY_INVERT_AXIS) ? -1.0f : 1.0f);
-  r_pan[2] = ndof->tvec[2] * ((U.ndof_flag & z_flag) ? -1.0f : 1.0f);
-}
-
-void WM_event_ndof_rotate_get(const wmNDOFMotionData *ndof, float r_rot[3])
-{
-  r_rot[0] = ndof->rvec[0] * ((U.ndof_flag & NDOF_ROTX_INVERT_AXIS) ? -1.0f : 1.0f);
-  r_rot[1] = ndof->rvec[1] * ((U.ndof_flag & NDOF_ROTY_INVERT_AXIS) ? -1.0f : 1.0f);
-  r_rot[2] = ndof->rvec[2] * ((U.ndof_flag & NDOF_ROTZ_INVERT_AXIS) ? -1.0f : 1.0f);
-}
-
-float WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3])
-{
-  float angle;
-  angle = normalize_v3_v3(axis, ndof->rvec);
-
-  axis[0] = axis[0] * ((U.ndof_flag & NDOF_ROTX_INVERT_AXIS) ? -1.0f : 1.0f);
-  axis[1] = axis[1] * ((U.ndof_flag & NDOF_ROTY_INVERT_AXIS) ? -1.0f : 1.0f);
-  axis[2] = axis[2] * ((U.ndof_flag & NDOF_ROTZ_INVERT_AXIS) ? -1.0f : 1.0f);
-
-  return ndof->dt * angle;
-}
-
-void WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4])
-{
-  float axis[3];
-  float angle;
-
-  angle = WM_event_ndof_to_axis_angle(ndof, axis);
-  axis_angle_to_quat(q, axis, angle);
-}
-#endif /* WITH_INPUT_NDOF */
-
-/* if this is a tablet event, return tablet pressure and set *pen_flip
- * to 1 if the eraser tool is being used, 0 otherwise */
-float WM_event_tablet_data(const wmEvent *event, int *pen_flip, float tilt[2])
-{
-  int erasor = 0;
-  float pressure = 1;
-
-  if (tilt) {
-    zero_v2(tilt);
-  }
-
-  if (event->tablet_data) {
-    const wmTabletData *wmtab = event->tablet_data;
-
-    erasor = (wmtab->Active == EVT_TABLET_ERASER);
-    if (wmtab->Active != EVT_TABLET_NONE) {
-      pressure = wmtab->Pressure;
-      if (tilt) {
-        tilt[0] = wmtab->Xtilt;
-        tilt[1] = wmtab->Ytilt;
-      }
-    }
-  }
-
-  if (pen_flip) {
-    (*pen_flip) = erasor;
-  }
-
-  return pressure;
-}
-
-bool WM_event_is_tablet(const struct wmEvent *event)
-{
-  return (event->tablet_data) ? true : false;
-}
-
-#ifdef WITH_INPUT_IME
-/* most os using ctrl/oskey + space to switch ime, avoid added space */
-bool WM_event_is_ime_switch(const struct wmEvent *event)
-{
-  return event->val == KM_PRESS && event->type == SPACEKEY &&
-         (event->ctrl || event->oskey || event->shift || event->alt);
-}
-#endif
-
-/** \} */
-
 wmKeyMap *WM_event_get_keymap_from_handler(wmWindowManager *wm, wmEventHandler_Keymap *handler)
 {
   wmKeyMap *keymap;
@@ -5141,10 +4728,10 @@ wmKeyMapItem *WM_event_match_keymap_item(bContext *C, wmKeyMap *keymap, const wm
   return NULL;
 }
 
-static wmKeyMapItem *wm_kmi_from_event(bContext *C,
-                                       wmWindowManager *wm,
-                                       ListBase *handlers,
-                                       const wmEvent *event)
+wmKeyMapItem *WM_event_match_keymap_item_from_handlers(bContext *C,
+                                                       wmWindowManager *wm,
+                                                       ListBase *handlers,
+                                                       const wmEvent *event)
 {
   LISTBASE_FOREACH (wmEventHandler *, handler_base, handlers) {
     /* during this loop, ui handlers for nested menus can tag multiple handlers free */
@@ -5167,6 +4754,8 @@ static wmKeyMapItem *wm_kmi_from_event(bContext *C,
   return NULL;
 }
 
+/** \} */
+
 /* -------------------------------------------------------------------- */
 /** \name Cursor Keymap Status
  *
@@ -5379,7 +4968,7 @@ void WM_window_cursor_keymap_status_refresh(bContext *C, wmWindow *win)
     wm_eventemulation(&test_event, true);
     wmKeyMapItem *kmi = NULL;
     for (int handler_index = 0; handler_index < ARRAY_SIZE(handlers); handler_index++) {
-      kmi = wm_kmi_from_event(C, wm, handlers[handler_index], &test_event);
+      kmi = WM_event_match_keymap_item_from_handlers(C, wm, handlers[handler_index], &test_event);
       if (kmi) {
         break;
       }
@@ -5475,43 +5064,3 @@ bool WM_window_modal_keymap_status_draw(bContext *UNUSED(C), wmWindow *win, uiLa
 }
 
 /** \} */
-
-/* -------------------------------------------------------------------- */
-/** \name Event Click/Drag Checks
- *
- * Values under this limit are detected as clicks.
- *
- * \{ */
-
-int WM_event_drag_threshold(const struct wmEvent *event)
-{
-  int drag_threshold;
-  if (WM_event_is_tablet(event)) {
-    drag_threshold = U.drag_threshold_tablet;
-  }
-  else if (ISMOUSE(event->prevtype)) {
-    drag_threshold = U.drag_threshold_mouse;
-  }
-  else {
-    /* Typically keyboard, could be NDOF button or other less common types. */
-    drag_threshold = U.drag_threshold;
-  }
-  return drag_threshold * U.dpi_fac;
-}
-
-bool WM_event_drag_test_with_delta(const wmEvent *event, const int drag_delta[2])
-{
-  const int drag_threshold = WM_event_drag_threshold(event);
-  return abs(drag_delta[0]) > drag_threshold || abs(drag_delta[1]) > drag_threshold;
-}
-
-bool WM_event_drag_test(const wmEvent *event, const int prev_xy[2])
-{
-  const int drag_delta[2] = {
-      prev_xy[0] - event->x,
-      prev_xy[1] - event->y,
-  };
-  return WM_event_drag_test_with_delta(event, drag_delta);
-}
-
-/** \} */