40#include "RNA_prototypes.hh"
52#include <fmt/format.h>
100 if (this->opptr !=
nullptr) {
102 MEM_delete(this->opptr);
104 MEM_delete(this->context);
114 std::variant<OperatorData, PropertyData>
data;
150 std::string drawstr_override;
153 const bool drawstr_is_empty = sep_index == 0 || but->
drawstr.empty();
155 if (but->
optype !=
nullptr) {
159 if (drawstr_is_empty) {
165 auto &op_data = std::get<MenuSearch_Item::OperatorData>(item->
data);
166 op_data.type = but->
optype;
168 op_data.context = but->
context ? MEM_new<bContextStore>(__func__, *but->
context) :
nullptr;
169 op_data.opptr = but->
opptr;
173 but->
opptr =
nullptr;
175 else if (but->
rnaprop !=
nullptr) {
178 if (drawstr_is_empty) {
180 const int value_enum = int(but->
hardmax);
189 drawstr_override = enum_item.
name;
193 drawstr_override =
"Unknown";
204 printf(
"Button '%s' in menu '%s' is a menu item with unsupported RNA type %d\n",
214 auto &rna_data = std::get<MenuSearch_Item::PropertyData>(item->
data);
219 rna_data.enum_value = int(but->
hardmax);
224 if (item !=
nullptr) {
226 if (!drawstr_override.empty()) {
227 const StringRef drawstr_suffix = sep_index == std::string::npos ?
230 std::string drawstr = std::string(
"(") + drawstr_override +
")" + drawstr_suffix;
244 data->items.append(*item);
256 bool changed =
false;
257 if (
auto *op_data = std::get_if<MenuSearch_Item::OperatorData>(&item->
data)) {
258 but->
optype = op_data->type;
260 but->
context = op_data->context;
261 but->
opptr = op_data->opptr;
264 else if (
auto *rna_data = std::get_if<MenuSearch_Item::PropertyData>(&item->
data)) {
272 but->
hardmax = rna_data->enum_value;
281 if (sep_index != std::string::npos) {
282 but->
drawstr.resize(sep_index);
311 ListBaseT<wmEventHandler> *handlers[] = {
317 for (
int handler_index = 0; handler_index <
ARRAY_SIZE(handlers); handler_index++) {
318 if (handlers[handler_index] ==
nullptr) {
330 if (handler_base.poll ==
nullptr ||
336 for (
int km_index = 0; km_index < km_result.
keymaps_len; km_index++) {
343 if (
STR_ELEM(kmi.
idname,
"WM_OT_call_menu",
"WM_OT_call_menu_pie")) {
348 if (mt && menu_tagged.
add(mt)) {
350 menu_stack.
push({mt});
351 menu_to_kmi.
add(mt, &kmi);
377 const char *ot_ui_name =
CTX_IFACE_(ot->translation_context, ot->name);
381 auto &op_data = std::get<MenuSearch_Item::OperatorData>(item.
data);
384 op_data.context =
nullptr;
398 operator_items.
append(item);
404 data->items.extend(operator_items);
417 bool include_all_areas,
418 const char *single_menu_idname)
426 if (old_context_store) {
427 context_store = *old_context_store;
429 context_store.
entries.append({
"is_menu_search",
true});
436 fmt::memory_buffer str_buf;
448 "WM_OT_search_single_menu",
453 const char *idname_array[] = {
455 (single_menu_idname &&
STREQ(single_menu_idname,
"TOPBAR_MT_file_open_recent")) ?
457 "TOPBAR_MT_file_open_recent",
460 "TOPBAR_MT_undo_history",
462 for (
int i = 0; i <
ARRAY_SIZE(idname_array); i++) {
463 if (!idname_array[i]) {
473 if (!single_menu_idname) {
485 const char *idname_array[] = {
487 "OUTLINER_MT_context_menu",
489 for (
int i = 0; i <
ARRAY_SIZE(idname_array); i++) {
501 int space_type_ui_items_len = 0;
502 bool space_type_ui_items_free =
false;
505 const char *global_menu_prefix =
nullptr;
507 if (include_all_areas) {
523 &space_type_ui_items,
524 &space_type_ui_items_len,
525 &space_type_ui_items_free);
528 for (
int i = 0; i < space_type_ui_items_len; i++) {
535 if (region !=
nullptr) {
540 if (space_type_ui_index == -1) {
544 if (wm_contexts[space_type_ui_index].space_type_ui_index != -1) {
545 ScrArea *area_best = wm_contexts[space_type_ui_index].
area;
548 if (value_best > value_test) {
554 wm_contexts[space_type_ui_index].
area = &area;
555 wm_contexts[space_type_ui_index].
region = region;
562 for (
int space_type_ui_index = -1; space_type_ui_index < space_type_ui_items_len;
563 space_type_ui_index += 1)
570 if (include_all_areas) {
571 if (space_type_ui_index == -1) {
573 wm_context =
nullptr;
578 wm_context = &wm_contexts[space_type_ui_index];
583 area = wm_context->
area;
584 region = wm_context->
region;
592 region = region_init;
595 if (single_menu_idname) {
597 if (menu_tagged.
add(mt)) {
598 menu_stack.
push({mt});
607 const char *idname_array[2] = {
nullptr};
608 int idname_array_len = 0;
611 if (space_type_ui_index == -1) {
612 idname_array[idname_array_len++] =
"TOPBAR_MT_editor_menus";
615#define SPACE_MENU_MAP(space_type, menu_id) \
617 idname_array[idname_array_len++] = menu_id; \
619#define SPACE_MENU_NOP(space_type) \
623 if (area !=
nullptr) {
642 "CLIP_MT_tracking_editor_menus" :
643 "CLIP_MT_masking_editor_menus");
652 for (
int i = 0; i < idname_array_len; i++) {
656 if (menu_tagged.
add(mt)) {
657 menu_stack.
push({mt});
665 bool has_keymap_menu_items =
false;
687 if (current_menu.
context.has_value()) {
696 const std::unique_ptr<Button> &but = block->
buttons_ptrs[i];
703 const std::unique_ptr<Button> *but_test = block->
buttons_ptrs.begin() + i - 1;
709 if (but_test < block->buttons_ptrs.begin()) {
719 ignored_operator_idnames))
724 const bool uses_context = but->context &&
726 const bool tagged_first_time = menu_tagged.
add(mt_from_but);
727 const bool scan_submenu = tagged_first_time || uses_context;
739 bool drawstr_is_empty =
false;
740 if (drawstr_sep !=
nullptr) {
743 const char *drawstr = but->drawstr.c_str();
744 int drawstr_len = drawstr_sep - but->drawstr.c_str();
745 if (drawstr_len == 0) [[unlikely]] {
747 drawstr_len = strlen(drawstr);
748 if (drawstr[0] ==
'\0') {
749 drawstr_is_empty =
true;
752 str_buf.append(
StringRef(drawstr, drawstr_len));
753 fmt::format_to(fmt::appender(str_buf),
" ({})", drawstr_sep + 1);
755 StringRef(str_buf.data(), str_buf.size()));
759 const char *drawstr = but->drawstr.c_str();
760 if (drawstr[0] ==
'\0') [[unlikely]] {
762 if (drawstr[0] ==
'\0') {
763 drawstr_is_empty =
true;
770 if (drawstr_is_empty) {
771 printf(
"Warning: '%s' menu has empty 'bl_label'.\n", mt_from_but->
idname);
775 menu_stack.
push({mt_from_but, menu_parent, *but->context});
778 menu_stack.
push({mt_from_but, menu_parent});
782 else if (but->menu_create_func !=
nullptr) {
807 bool poll_success =
true;
809 if (pt->poll && (pt->poll(
C, pt) ==
false)) {
810 poll_success =
false;
815 but->menu_create_func(
C, &sub_layout, but->poin);
827 data, scope, mt, &sub_but, wm_context, menu_parent, ignored_operator_idnames);
844 if (single_menu_idname ==
nullptr) {
847 if (menu_stack.
is_empty() && (has_keymap_menu_items ==
false)) {
848 has_keymap_menu_items =
true;
850 C, win, area, region, menu_stack, menu_to_kmi, menu_tagged);
863 if (include_all_areas) {
864 fmt::format_to(fmt::appender(str_buf),
874 while (menu_parent && menu_parent->
parent) {
876 menu_parent = menu_parent->
parent;
878 while (menu_parent) {
879 str_buf.append(menu_parent->
drawstr);
885 const char *drawstr = menu_display_name_map.
lookup_default(item.
mt,
nullptr);
886 if (drawstr ==
nullptr) {
892 if (kmi !=
nullptr) {
894 fmt::format_to(fmt::appender(str_buf),
" ({})", kmi_str);
911 if (include_all_areas) {
915 if (space_type_ui_items_free) {
916 MEM_delete(space_type_ui_items);
946 if (item ==
nullptr) {
961 if (
auto *op_data = std::get_if<MenuSearch_Item::OperatorData>(&item->
data)) {
964 C, op_data->type, op_data->opcontext, op_data->opptr,
nullptr, item->
drawstr);
967 else if (
auto *rna_data = std::get_if<MenuSearch_Item::PropertyData>(&item->
data)) {
970 const int index = rna_data->index;
972 bool changed =
false;
1042 bool has_menu =
false;
1045 new (&
data->context_menu_data.block)
Block();
1047 Block *block = &
data->context_menu_data.block;
1086 new (&
data->context_menu_data.block)
Block();
1088 Block *block = &
data->context_menu_data.block;
1097 tip_init[0] =
event->
xy[0];
1098 tip_init[1] =
event->xy[1] - (
UI_UNIT_Y / 2);
1141 !single_menu_idname;
1143 C, win, area, region, include_all_areas, single_menu_idname);
1163 static char search[256] =
"";
1165 block = layout->
block();
#define BLI_SCOPED_DEFER(function_to_defer)
#define SNPRINTF_UTF8(dst, format,...)
#define CTX_IFACE_(context, msgid)
Read Blender memory allocation and freeing.
StringRefNull copy_string(StringRef str)
bool add(const Key &key, const Value &value)
Value lookup_default(const Key &key, const Value &default_value) const
T & construct(Args &&...args)
LinearAllocator & allocator()
bool contains_as(const ForwardKey &key) const
bool remove(const Key &key)
void push(const T &value)
constexpr const char * c_str() const
constexpr StringRef drop_prefix(int64_t n) const
void append(const T &value)
void add(const StringRef str, T *user_data, const int weight=0)
Vector< T * > query(const StringRef query) const
int button_icon(const Button *but)
ARegion * searchbox_create_menu(bContext *C, ARegion *butregion, ButtonSearch *search_but)
static bool menu_item_sort_by_drawstr_full(const MenuSearch_Item &menu_item_a, const MenuSearch_Item &menu_item_b)
void button_func_search_set_sep_string(Button *but, const char *search_sep_string)
static bool menu_items_to_ui_button(MenuSearch_Item *item, Button *but)
void block_free(const bContext *C, Block *block)
void button_func_menu_search(Button *but, const char *single_menu_idname=nullptr)
void block_flag_enable(Block *block, int flag)
const uiStyle * style_get_dpi()
PanelType * button_paneltype_get(const Button *but)
@ BLOCK_SHOW_SHORTCUT_ALWAYS
static void menu_search_exec_fn(bContext *C, void *, void *arg2)
static MenuSearch_Data * menu_items_from_ui_create(bContext *C, wmWindow *win, ScrArea *area_init, ARegion *region_init, bool include_all_areas, const char *single_menu_idname)
Block * block_begin(const bContext *C, ARegion *region, std::string name, EmbossType emboss)
static void menu_items_from_all_operators(bContext *C, MenuSearch_Data *data)
Button * uiDefSearchBut(Block *block, void *arg, int icon, int maxncpy, int x, int y, short width, short height, std::optional< StringRef > tip)
static bool search_menu_create_context_menu(bContext *C, void *arg, void *active, const wmEvent *event)
bool search_item_add(SearchItems *items, StringRef name, void *poin, int iconid, int64_t but_flag, uint8_t name_prefix_offset)
void block_end(const bContext *C, Block *block, bool postpone_callbacks=false)
static ARegion * search_menu_create_tooltip(bContext *C, ARegion *region, const rcti *, void *arg, void *active)
void menutype_draw(bContext *C, MenuType *mt, Layout *layout)
static void menu_search_arg_free_fn(void *data_v)
void uiTemplateMenuSearch(Layout *layout)
bool popup_context_menu_for_button(bContext *C, Button *but, const wmEvent *event)
static void menu_search_update_fn(const bContext *, void *arg, const char *str, SearchItems *items, const bool)
MenuType * button_menutype_get(const Button *but)
void window_to_block_fl(const ARegion *region, const Block *block, float *x, float *y)
Layout & block_layout(Block *block, LayoutDirection direction, LayoutType type, int x, int y, int size, int em, int padding, const uiStyle *style)
void block_layout_set_current(Block *block, Layout *layout)
ARegion * tooltip_create_from_button(bContext *C, ARegion *butregion, Button *but, bool is_quick_tip)
static bool menu_items_from_ui_create_item_from_button(MenuSearch_Data *data, ResourceScope &scope, MenuType *mt, Button *but, MenuSearch_Context *wm_context, MenuSearch_Parent *menu_parent, const Set< std::string > &ignored_idnames)
static void menu_types_add_from_keymap_items(bContext *C, wmWindow *win, ScrArea *area, ARegion *region, Stack< MenuStackEntry > &menu_stack, Map< MenuType *, wmKeyMapItem * > &menu_to_kmi, Set< MenuType * > &menu_tagged)
void button_func_search_set_context_menu(Button *but, ButtonSearchContextMenuFn context_menu_fn)
void button_func_search_set(Button *but, ButtonSearchCreateFn search_create_fn, ButtonSearchUpdateFn search_update_fn, void *arg, bool free_arg, FreeArgFunc search_arg_free_fn, ButtonHandleFunc search_exec_fn, void *active)
void button_func_search_set_tooltip(Button *but, ButtonSearchTooltipFn tooltip_fn)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
ScrArea * CTX_wm_area(const bContext *C)
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
void RNA_property_update(bContext *C, PointerRNA *ptr, PropertyRNA *prop)
bool WM_keymap_poll(bContext *C, wmKeyMap *keymap)
std::string WM_operatortype_name(wmOperatorType *ot, PointerRNA *properties)
Span< MenuType * > WM_menutypes_registered_get()
int bool bool BLI_str_endswith(const char *__restrict str, const char *__restrict end) ATTR_NONNULL(1
void WM_operator_properties_free(PointerRNA *ptr)
int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop)
void RNA_property_enum_items(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const EnumPropertyItem **r_item, int *r_totitem, bool *r_free)
MenuType * WM_menutype_find(const StringRef idname, bool quiet)
PointerRNA WM_operator_properties_create_ptr(wmOperatorType *ot)
wmWindow * CTX_wm_window(const bContext *C)
const char * RNA_property_translation_context(const PropertyRNA *prop)
int RNA_enum_from_value(const EnumPropertyItem *item, const int value)
Span< wmOperatorType * > WM_operatortypes_registered_get()
bool RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop)
bool RNA_property_array_check(PropertyRNA *prop)
const bContextStore * CTX_store_get(const bContext *C)
PropertyType RNA_property_type(PropertyRNA *prop)
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
BMesh const char void * data
wmWindowManager * CTX_wm_manager(const bContext *C)
bool RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index)
constexpr size_t ARRAY_SIZE(const T(&arg)[N]) noexcept
bool RNA_property_enum_item_from_value_gettexted(bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, EnumPropertyItem *r_item)
void unit_m4(float m[4][4])
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
bool WM_menutype_poll(bContext *C, MenuType *mt)
std::optional< std::string > WM_keymap_item_to_string(const wmKeyMapItem *kmi, const bool compact)
ARegion * BKE_area_find_region_type(const ScrArea *area, int region_type)
void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value)
void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, bool value)
void CTX_wm_region_set(bContext *C, ARegion *region)
void WM_event_get_keymaps_from_handler(wmWindowManager *wm, wmWindow *win, wmEventHandler_Keymap *handler, wmEventHandler_KeymapResult *km_result)
std::string RNA_string_get(PointerRNA *ptr, const char *name)
void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, bool value)
void CTX_store_set(bContext *C, const bContextStore *store)
bool WM_operator_poll(bContext *C, wmOperatorType *ot)
bScreen * WM_window_get_active_screen(const wmWindow *win)
size_t WM_operator_py_idname(char *dst, const char *src)
ARegion * CTX_wm_region(const bContext *C)
const char * RNA_property_ui_name(const PropertyRNA *prop, const PointerRNA *ptr)
void CTX_wm_area_set(bContext *C, ScrArea *area)
void WM_operator_name_call_ptr_with_depends_on_cursor(bContext *C, wmOperatorType *ot, wm::OpCallContext opcontext, PointerRNA *properties, const wmEvent *event, const StringRef drawstr)
#define UI_MENU_ARROW_SEP
bke::ARegionRuntime * runtime
ListBaseT< struct wmEventHandler > handlers
ListBaseT< SpaceLink > spacedata
Vector< bContextStoreEntry > entries
ListBaseT< struct ScrArea > areabase
ListBaseT< wmEventHandler > handlers
ListBaseT< ui::Block > uiblocks
Map< std::string, ui::Block * > block_name_map
ListBaseT< wmEventHandler > handlers
Vector< std::unique_ptr< Button > > buttons_ptrs
std::ranges::transform_view< std::ranges::ref_view< const Vector< std::unique_ptr< Button > > >, Button &(*)(const std::unique_ptr< Button > &)> buttons() const
void operator_context_set(wm::OpCallContext opcontext)
void context_copy(const bContextStore *context)
ListBaseT< wmKeyMapItem > items
bke::WindowRuntime * runtime