Spreadsheet Editor: Row Filters

This patch adds support for filtering rows based on rules and values.
Filters will work for any attribute data source, they are a property
of the spreadsheet rather than of the attribute system. The properties
displayed in the row filter can depend on data type of the currently
visible column with that name. If the name is no longer visible, the
row filter filter is grayed out, but it will remember the value until
a column with its name is visible again.

Note: The comments in `screen.c` combined with tagging the sidebar
for redraw after the main region point to a lack of understanding
or technical debt, that is a point to improve in the future.

**Future Improvements**
* T89272: A search menu for visible columns when adding a new filter.
* T89273: Possibly a "Range" operation.

Differential Revision: https://developer.blender.org/D10959

1 files changed, 75 insertions, 0 deletions

diff --git a/source/blender/editors/space_spreadsheet/spreadsheet_ops.cc b/source/blender/editors/space_spreadsheet/spreadsheet_ops.cc
index 770bd207e8d..fcbc37346e6 100644
--- a/source/blender/editors/space_spreadsheet/spreadsheet_ops.cc
+++ b/source/blender/editors/space_spreadsheet/spreadsheet_ops.cc
@@ -14,8 +14,83 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
+#include "BLI_listbase.h"
+
+#include "MEM_guardedalloc.h"
+
+#include "BKE_context.h"
+
+#include "RNA_access.h"
+#include "RNA_define.h"
+
+#include "ED_screen.h"
+
+#include "WM_api.h"
+#include "WM_types.h"
+
 #include "spreadsheet_intern.hh"
+#include "spreadsheet_row_filter.hh"
+
+using namespace blender::ed::spreadsheet;
+
+static int row_filter_add_exec(bContext *C, wmOperator *UNUSED(op))
+{
+  SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
+
+  SpreadsheetRowFilter *row_filter = spreadsheet_row_filter_new();
+  BLI_addtail(&sspreadsheet->row_filters, row_filter);
+
+  WM_event_add_notifier(C, NC_SPACE | ND_SPACE_SPREADSHEET, sspreadsheet);
+
+  return OPERATOR_FINISHED;
+}
+
+static void SPREADSHEET_OT_add_row_filter_rule(wmOperatorType *ot)
+{
+  ot->name = "Add Row Filter";
+  ot->description = "Add a filter to remove rows from the displayed data";
+  ot->idname = "SPREADSHEET_OT_add_row_filter_rule";
+
+  ot->exec = row_filter_add_exec;
+  ot->poll = ED_operator_spreadsheet_active;
+
+  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
+}
+
+static int row_filter_remove_exec(bContext *C, wmOperator *op)
+{
+  SpaceSpreadsheet *sspreadsheet = CTX_wm_space_spreadsheet(C);
+
+  SpreadsheetRowFilter *row_filter = (SpreadsheetRowFilter *)BLI_findlink(
+      &sspreadsheet->row_filters, RNA_int_get(op->ptr, "index"));
+  if (row_filter == nullptr) {
+    return OPERATOR_CANCELLED;
+  }
+
+  BLI_remlink(&sspreadsheet->row_filters, row_filter);
+  spreadsheet_row_filter_free(row_filter);
+
+  WM_event_add_notifier(C, NC_SPACE | ND_SPACE_SPREADSHEET, sspreadsheet);
+
+  return OPERATOR_FINISHED;
+}
+
+static void SPREADSHEET_OT_remove_row_filter_rule(wmOperatorType *ot)
+{
+  ot->name = "Remove Row Filter";
+  ot->description = "Remove a row filter from the rules";
+  ot->idname = "SPREADSHEET_OT_remove_row_filter_rule";
+
+  ot->exec = row_filter_remove_exec;
+  ot->poll = ED_operator_spreadsheet_active;
+
+  ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
+
+  RNA_def_int(ot->srna, "index", 0, 0, INT_MAX, "Index", "", 0, INT_MAX);
+}
 
 void spreadsheet_operatortypes()
 {
+  WM_operatortype_append(SPREADSHEET_OT_add_row_filter_rule);
+  WM_operatortype_append(SPREADSHEET_OT_remove_row_filter_rule);
 }