wm_menu_type.cc

Go to the documentation of this file.

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

 
#include <cstdio>
 
#include "DNA_windowmanager_types.h"
 
#include "MEM_guardedalloc.h"
 
#include "BLI_utildefines.h"
#include "BLI_vector_set.hh"
 
#include "BKE_context.hh"
#include "BKE_screen.hh"
#include "BKE_workspace.hh"
 
#include "WM_api.hh"
#include "WM_types.hh"
 
using blender::StringRef;
 
static auto &get_menu_type_map()
{
  struct IDNameGetter {
    StringRef operator()(const MenuType *value) const
    {
      return StringRef(value->idname);
    }
  };
  static blender::CustomIDVectorSet<MenuType *, IDNameGetter> map;
  return map;
}
 
MenuType *WM_menutype_find(const StringRef idname, bool quiet)
{
  if (!idname.is_empty()) {
    if (MenuType *const *mt = get_menu_type_map().lookup_key_ptr_as(idname)) {
      return *mt;
    }
  }
 
  if (!quiet) {
    printf("search for unknown menutype %s\n", std::string(idname).c_str());
  }
 
  return nullptr;
}
 
blender::Span<MenuType *> WM_menutypes_registered_get()
{
  return get_menu_type_map();
}
 
bool WM_menutype_add(MenuType *mt)
{
  BLI_assert((mt->description == nullptr) || (mt->description[0]));
  get_menu_type_map().add(mt);
  return true;
}
 
void WM_menutype_freelink(MenuType *mt)
{
  bool ok = get_menu_type_map().remove(mt);
  MEM_freeN(mt);
 
  BLI_assert(ok);
  UNUSED_VARS_NDEBUG(ok);
}
 
void WM_menutype_init()
{
  /* Reserve size is set based on blender default setup. */
  get_menu_type_map().reserve(512);
}
 
void WM_menutype_free()
{
  for (MenuType *mt : get_menu_type_map()) {
    if (mt->rna_ext.free) {
      mt->rna_ext.free(mt->rna_ext.data);
    }
    MEM_freeN(mt);
  }
  get_menu_type_map().clear();
}
 
bool WM_menutype_poll(bContext *C, MenuType *mt)
{
  /* If we're tagged, only use compatible. */
  if (mt->owner_id[0] != '\0') {
    const WorkSpace *workspace = CTX_wm_workspace(C);
    if (BKE_workspace_owner_id_check(workspace, mt->owner_id) == false) {
      return false;
    }
  }
 
  if (mt->poll != nullptr) {
    return mt->poll(C, mt);
  }
  return true;
}
 
void WM_menutype_idname_visit_for_search(
    const bContext * /*C*/,
    PointerRNA * /*ptr*/,
    PropertyRNA * /*prop*/,
    const char * /*edit_text*/,
    blender::FunctionRef<void(StringPropertySearchVisitParams)> visit_fn)
{
  for (MenuType *mt : get_menu_type_map()) {
    StringPropertySearchVisitParams visit_params{};
    visit_params.text = mt->idname;
    visit_params.info = mt->label;
    visit_fn(visit_params);
  }
}