Blender V5.3
spreadsheet_row_filter_ui.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include <cstring>
6#include <fmt/format.h>
7#include <sstream>
8
9#include "BLI_listbase.hh"
10#include "BLI_string_ref.hh"
11#include "BLI_string_utf8.hh"
12
13#include "DNA_screen_types.h"
14#include "DNA_space_types.h"
15
16#include "BKE_screen.hh"
17
18#include "RNA_access.hh"
19#include "RNA_prototypes.hh"
20
21#include "UI_interface.hh"
23#include "UI_resources.hh"
24
25#include "BLT_translation.hh"
26
27#include "WM_api.hh"
28#include "WM_types.hh"
29
30#include "ED_spreadsheet.hh"
31
32#include "spreadsheet_intern.hh"
34
36
37static void filter_panel_id_fn(void * /*row_filter_v*/, char *r_name)
38{
39 /* All row filters use the same panel ID. */
40 BLI_strncpy_utf8(r_name, "SPREADSHEET_PT_filter", BKE_ST_MAXNAME);
41}
42
43static std::string operation_string(const eSpreadsheetColumnValueType data_type,
44 const eSpreadsheetFilterOperation operation)
45{
47 return "=";
48 }
49
50 switch (operation) {
52 return "=";
54 return ">";
56 return "<";
57 }
59 return "";
60}
61
62static std::string value_string(const SpreadsheetRowFilter &row_filter,
63 const eSpreadsheetColumnValueType data_type)
64{
65 switch (data_type) {
69 return std::to_string(row_filter.value_int);
71 std::ostringstream result;
72 result.precision(3);
73 result << std::fixed << row_filter.value_float;
74 return result.str();
75 }
77 std::ostringstream result;
78 result << "(" << row_filter.value_int2[0] << ", " << row_filter.value_int2[1] << ")";
79 return result.str();
80 }
82 std::ostringstream result;
83 return fmt::format("({}, {}, {})",
84 row_filter.value_int3[0],
85 row_filter.value_int3[1],
86 row_filter.value_int3[2]);
87 }
89 std::ostringstream result;
90 result.precision(3);
91 result << std::fixed << "(" << row_filter.value_float2[0] << ", "
92 << row_filter.value_float2[1] << ")";
93 return result.str();
94 }
96 std::ostringstream result;
97 result.precision(3);
98 result << std::fixed << "(" << row_filter.value_float3[0] << ", "
99 << row_filter.value_float3[1] << ", " << row_filter.value_float3[2] << ")";
100 return result.str();
101 }
103 std::ostringstream result;
104 result.precision(3);
105 result << std::fixed << "(" << row_filter.value_float4[0] << ", "
106 << row_filter.value_float4[1] << ", " << row_filter.value_float4[2] << ", "
107 << row_filter.value_float4[3] << ")";
108 return result.str();
109 }
111 return (row_filter.flag & SPREADSHEET_ROW_FILTER_BOOL_VALUE) ? IFACE_("True") :
112 IFACE_("False");
114 if (row_filter.value_string != nullptr) {
115 return row_filter.value_string;
116 }
117 return "";
120 std::ostringstream result;
121 result.precision(3);
122 result << std::fixed << "(" << row_filter.value_color[0] << ", " << row_filter.value_color[1]
123 << ", " << row_filter.value_color[2] << ", " << row_filter.value_color[3] << ")";
124 return result.str();
125 }
127 return row_filter.value_string;
132 return "";
133 }
135 return "";
136}
137
139 const SpaceSpreadsheet &sspreadsheet, const StringRef column_name)
140{
141 const SpreadsheetTable *table = get_active_table(sspreadsheet);
142 if (!table) {
143 return nullptr;
144 }
145 for (const SpreadsheetColumn *column : Span{table->columns, table->num_columns}) {
146 if (column->display_name == column_name) {
147 return column;
148 }
149 }
150 return nullptr;
151}
152
154{
155 ui::Layout &layout = *panel->layout;
157 PointerRNA *filter_ptr = ui::panel_custom_data_get(panel);
158 const SpreadsheetRowFilter *filter = static_cast<SpreadsheetRowFilter *>(filter_ptr->data);
159 const StringRef column_name = filter->column_name;
161
162 const SpreadsheetColumn *column = lookup_visible_column_for_filter(*sspreadsheet, column_name);
163 if (!(sspreadsheet->filter_flag & SPREADSHEET_FILTER_ENABLE) ||
164 (column == nullptr && !column_name.is_empty()))
165 {
166 layout.active_set(false);
167 }
168
169 ui::Layout *row = &layout.row(true);
171 row->prop(filter_ptr, "enabled", ui::ITEM_R_ICON_ONLY, "", ICON_NONE);
172
173 if (column_name.is_empty()) {
174 row->label(IFACE_("Filter"), ICON_NONE);
175 }
176 else if (column == nullptr) {
177 row->label(column_name.data(), ICON_NONE);
178 }
179 else {
181 std::stringstream ss;
182 ss << column_name;
183 ss << " ";
184 ss << operation_string(data_type, operation);
185 ss << " ";
186 ss << value_string(*filter, data_type);
187 row->label(ss.str(), ICON_NONE);
188 }
189
190 row = &layout.row(true);
192 const int current_index = BLI_findindex(&sspreadsheet->row_filters, filter);
193 PointerRNA op_ptr = row->op("SPREADSHEET_OT_remove_row_filter_rule", "", ICON_X);
194 RNA_int_set(&op_ptr, "index", current_index);
195 /* Some padding so the X isn't too close to the drag icon. */
196 layout.separator(0.25f);
197}
198
200{
201 ui::Layout &layout = *panel->layout;
203 PointerRNA *filter_ptr = ui::panel_custom_data_get(panel);
204 SpreadsheetRowFilter *filter = static_cast<SpreadsheetRowFilter *>(filter_ptr->data);
205 const StringRef column_name = filter->column_name;
207
208 const SpreadsheetColumn *column = lookup_visible_column_for_filter(*sspreadsheet, column_name);
209 if (!(sspreadsheet->filter_flag & SPREADSHEET_FILTER_ENABLE) ||
211 (column == nullptr && !column_name.is_empty()))
212 {
213 layout.active_set(false);
214 }
215
216 layout.use_property_split_set(true);
217 layout.use_property_decorate_set(false);
218
219 layout.prop(filter_ptr, "column_name", UI_ITEM_NONE, IFACE_("Column"), ICON_NONE);
220
221 /* Don't draw settings for filters with no corresponding visible column. */
222 if (column == nullptr || column_name.is_empty()) {
223 return;
224 }
225
226 switch (static_cast<eSpreadsheetColumnValueType>(column->data_type)) {
228 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
229 layout.prop(filter_ptr, "value_int8", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
230 break;
233 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
234 layout.prop(filter_ptr, "value_int", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
235 break;
237 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
238 layout.prop(filter_ptr, "value_int2", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
239 break;
241 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
242 layout.prop(filter_ptr, "value_int3", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
243 break;
245 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
246 layout.prop(filter_ptr, "value_float", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
247 if (operation == SPREADSHEET_ROW_FILTER_EQUAL) {
248 layout.prop(filter_ptr, "threshold", UI_ITEM_NONE, std::nullopt, ICON_NONE);
249 }
250 break;
252 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
253 layout.prop(filter_ptr, "value_float2", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
254 if (operation == SPREADSHEET_ROW_FILTER_EQUAL) {
255 layout.prop(filter_ptr, "threshold", UI_ITEM_NONE, std::nullopt, ICON_NONE);
256 }
257 break;
259 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
260 layout.prop(filter_ptr, "value_float3", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
261 if (operation == SPREADSHEET_ROW_FILTER_EQUAL) {
262 layout.prop(filter_ptr, "threshold", UI_ITEM_NONE, std::nullopt, ICON_NONE);
263 }
264 break;
266 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
267 layout.prop(filter_ptr, "value_float4", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
268 if (operation == SPREADSHEET_ROW_FILTER_EQUAL) {
269 layout.prop(filter_ptr, "threshold", UI_ITEM_NONE, std::nullopt, ICON_NONE);
270 }
271 break;
273 layout.prop(filter_ptr, "value_boolean", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
274 break;
276 layout.prop(filter_ptr, "value_string", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
277 break;
280 layout.prop(filter_ptr, "operation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
281 layout.prop(filter_ptr, "value_color", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
282 if (operation == SPREADSHEET_ROW_FILTER_EQUAL) {
283 layout.prop(filter_ptr, "threshold", UI_ITEM_NONE, std::nullopt, ICON_NONE);
284 }
285 break;
287 layout.prop(filter_ptr, "value_string", UI_ITEM_NONE, IFACE_("Value"), ICON_NONE);
288 break;
293 layout.label(IFACE_("Unsupported column type"), ICON_STATUS_ERROR);
294 break;
295 }
296}
297
299{
300 ui::Layout &layout = *panel->layout;
301 ARegion *region = CTX_wm_region(C);
302 bScreen *screen = CTX_wm_screen(C);
304 ListBaseT<SpreadsheetRowFilter> *row_filters = &sspreadsheet->row_filters;
305
306 if (!(sspreadsheet->filter_flag & SPREADSHEET_FILTER_ENABLE)) {
307 layout.active_set(false);
308 }
309
310 layout.op("SPREADSHEET_OT_add_row_filter_rule", std::nullopt, ICON_ADD);
311
312 const bool panels_match = ui::panel_list_matches_data(region, row_filters, filter_panel_id_fn);
313
314 if (!panels_match) {
316 for (SpreadsheetRowFilter &row_filter : *row_filters) {
317 char panel_idname[MAX_NAME];
318 filter_panel_id_fn(&row_filter, panel_idname);
319
320 PointerRNA *filter_ptr = MEM_new<PointerRNA>("panel customdata");
321 *filter_ptr = RNA_pointer_create_discrete(
322 &screen->id, RNA_SpreadsheetRowFilter, &row_filter);
323
324 ui::panel_add_instanced(C, region, &region->panels, panel_idname, filter_ptr);
325 }
326 }
327 else {
328 /* Assuming there's only one group of instanced panels, update the custom data pointers. */
329 Panel *panel_iter = region->panels.first();
330 for (SpreadsheetRowFilter &row_filter : *row_filters) {
331
332 /* Move to the next instanced panel corresponding to the next filter. */
333 while ((panel_iter->type == nullptr) || !(panel_iter->type->flag & PANEL_TYPE_INSTANCED)) {
334 panel_iter = panel_iter->next;
335 BLI_assert(panel_iter != nullptr); /* There shouldn't be fewer panels than filters. */
336 }
337
338 PointerRNA *filter_ptr = MEM_new<PointerRNA>("panel customdata");
339 *filter_ptr = RNA_pointer_create_discrete(
340 &screen->id, RNA_SpreadsheetRowFilter, &row_filter);
341 ui::panel_custom_data_set(panel_iter, filter_ptr);
342
343 panel_iter = panel_iter->next;
344 }
345 }
346}
347
348static void filter_reorder(bContext *C, Panel *panel, int new_index)
349{
351 ListBaseT<SpreadsheetRowFilter> *row_filters = &sspreadsheet->row_filters;
352 PointerRNA *filter_ptr = ui::panel_custom_data_get(panel);
353 SpreadsheetRowFilter *filter = static_cast<SpreadsheetRowFilter *>(filter_ptr->data);
354
355 int current_index = BLI_findindex(row_filters, filter);
356 BLI_assert(current_index >= 0);
357 BLI_assert(new_index >= 0);
358
359 BLI_listbase_link_move(row_filters, filter, new_index - current_index);
360}
361
362static short get_filter_expand_flag(const bContext * /*C*/, Panel *panel)
363{
364 PointerRNA *filter_ptr = ui::panel_custom_data_get(panel);
365 SpreadsheetRowFilter *filter = static_cast<SpreadsheetRowFilter *>(filter_ptr->data);
366
367 return short(filter->flag) & SPREADSHEET_ROW_FILTER_UI_EXPAND;
368}
369
370static void set_filter_expand_flag(const bContext * /*C*/, Panel *panel, short expand_flag)
371{
372 PointerRNA *filter_ptr = ui::panel_custom_data_get(panel);
373 SpreadsheetRowFilter *filter = static_cast<SpreadsheetRowFilter *>(filter_ptr->data);
374
378}
379
381{
382 {
383 PanelType *panel_type = MEM_new_zeroed<PanelType>(__func__);
384 STRNCPY_UTF8(panel_type->idname, "SPREADSHEET_PT_row_filters");
385 STRNCPY_UTF8(panel_type->label, N_("Filters"));
386 STRNCPY_UTF8(panel_type->category, "Filters");
388 panel_type->flag = PANEL_TYPE_NO_HEADER;
390 BLI_addtail(&region_type.paneltypes, panel_type);
391 }
392
393 {
394 PanelType *panel_type = MEM_new_zeroed<PanelType>(__func__);
395 STRNCPY_UTF8(panel_type->idname, "SPREADSHEET_PT_filter");
396 STRNCPY_UTF8(panel_type->label, "");
397 STRNCPY_UTF8(panel_type->category, "Filters");
404 panel_type->reorder = filter_reorder;
405 BLI_addtail(&region_type.paneltypes, panel_type);
406 }
407}
408
409} // namespace blender::ed::spreadsheet
#define BKE_ST_MAXNAME
Definition BKE_screen.hh:91
#define STRNCPY_UTF8(dst, src)
#define IFACE_(msgid)
#define BLT_I18NCONTEXT_DEFAULT_BPYRNA
#define MAX_NAME
Definition DNA_defs.h:63
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define BLI_assert_unreachable()
#define SET_FLAG_FROM_TEST(value, test, flag)
#define ELEM(...)
constexpr bool is_empty() const
constexpr const char * data() const
static void spreadsheet_filter_panel_draw(const bContext *C, Panel *panel)
static std::string operation_string(const eSpreadsheetColumnValueType data_type, const eSpreadsheetFilterOperation operation)
static void set_filter_expand_flag(const bContext *, Panel *panel, short expand_flag)
static std::string value_string(const SpreadsheetRowFilter &row_filter, const eSpreadsheetColumnValueType data_type)
static void spreadsheet_row_filters_layout(const bContext *C, Panel *panel)
static void filter_panel_id_fn(void *, char *r_name)
static void filter_reorder(bContext *C, Panel *panel, int new_index)
static void spreadsheet_filter_panel_draw_header(const bContext *C, Panel *panel)
SpreadsheetTable * get_active_table(SpaceSpreadsheet &sspreadsheet)
static const SpreadsheetColumn * lookup_visible_column_for_filter(const SpaceSpreadsheet &sspreadsheet, const StringRef column_name)
static short get_filter_expand_flag(const bContext *, Panel *panel)
void register_row_filter_panels(ARegionType &region_type)
bool panel_list_matches_data(ARegion *region, ListBase *data, ListPanelIDFromDataFunc panel_idname_func)
void panels_free_instanced(const bContext *C, ARegion *region)
void panel_custom_data_set(Panel *panel, PointerRNA *custom_data)
Panel * panel_add_instanced(const bContext *C, ARegion *region, ListBaseT< Panel > *panels, const char *panel_idname, PointerRNA *custom_data)
PointerRNA * panel_custom_data_get(const Panel *panel)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
@ SPREADSHEET_FILTER_ENABLE
void RNA_int_set(PointerRNA *ptr, const char *name, int value)
char * BLI_strncpy_utf8(char *__restrict dst, const char *__restrict src, size_t dst_maxncpy) ATTR_NONNULL(1
@ SPREADSHEET_ROW_FILTER_BOOL_VALUE
@ SPREADSHEET_ROW_FILTER_UI_EXPAND
@ SPREADSHEET_ROW_FILTER_ENABLED
int BLI_findindex(const ListBase *listbase, const void *vlink) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:593
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
@ SPREADSHEET_ROW_FILTER_GREATER
@ SPREADSHEET_ROW_FILTER_EQUAL
@ SPREADSHEET_ROW_FILTER_LESS
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
@ PANEL_TYPE_HEADER_EXPAND
@ PANEL_TYPE_NO_HEADER
@ PANEL_TYPE_INSTANCED
bScreen * CTX_wm_screen(const bContext *C)
SpaceSpreadsheet * CTX_wm_space_spreadsheet(const bContext *C)
@ SPREADSHEET_VALUE_TYPE_INT32_3D
@ SPREADSHEET_VALUE_TYPE_QUATERNION
@ SPREADSHEET_VALUE_TYPE_STRING
@ SPREADSHEET_VALUE_TYPE_INSTANCES
@ SPREADSHEET_VALUE_TYPE_FLOAT
@ SPREADSHEET_VALUE_TYPE_FLOAT4X4
@ SPREADSHEET_VALUE_TYPE_FLOAT2
@ SPREADSHEET_VALUE_TYPE_INT32_2D
@ SPREADSHEET_VALUE_TYPE_FLOAT4
@ SPREADSHEET_VALUE_TYPE_BYTE_COLOR
@ SPREADSHEET_VALUE_TYPE_INT8
@ SPREADSHEET_VALUE_TYPE_UNKNOWN
@ SPREADSHEET_VALUE_TYPE_BOOL
@ SPREADSHEET_VALUE_TYPE_INT64
@ SPREADSHEET_VALUE_TYPE_INT32
@ SPREADSHEET_VALUE_TYPE_BUNDLE_ITEM
@ SPREADSHEET_VALUE_TYPE_FLOAT3
@ SPREADSHEET_VALUE_TYPE_COLOR
ARegion * CTX_wm_region(const bContext *C)
void void void bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step) ATTR_NONNULL()
Definition listbase.cc:443
ListBaseT< PanelType > paneltypes
ListBaseT< Panel > panels
void(*) reorder(bContext *C, Panel *pa, int new_index)
char translation_context[BKE_ST_MAXNAME]
short(*) get_list_data_expand_flag(const bContext *C, Panel *pa)
void(*) draw(const bContext *C, Panel *panel)
char category[BKE_ST_MAXNAME]
void(*) set_list_data_expand_flag(const bContext *C, Panel *pa, short expand_flag)
void(*) draw_header(const bContext *C, Panel *panel)
char idname[BKE_ST_MAXNAME]
char label[BKE_ST_MAXNAME]
struct PanelType * type
ui::Layout * layout
struct Panel * next
ListBaseT< struct SpreadsheetRowFilter > row_filters
SpreadsheetColumn ** columns
void use_property_decorate_set(bool is_decorate)
void use_property_split_set(bool is_sep)
void label(StringRef name, int icon)
PointerRNA op(wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
void active_set(bool active)
void separator(float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
Layout & row(bool align)
void emboss_set(EmbossType emboss)
#define N_(msgid)