Menu.cpp 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Debug.h>
  7. #include <AK/HashMap.h>
  8. #include <AK/IDAllocator.h>
  9. #include <LibGUI/Action.h>
  10. #include <LibGUI/ActionGroup.h>
  11. #include <LibGUI/Application.h>
  12. #include <LibGUI/ConnectionToWindowServer.h>
  13. #include <LibGUI/Menu.h>
  14. #include <LibGUI/MenuItem.h>
  15. #include <LibGfx/Bitmap.h>
  16. namespace GUI {
  17. static IDAllocator s_menu_id_allocator;
  18. static HashMap<int, Menu*>& all_menus()
  19. {
  20. static HashMap<int, Menu*> s_map;
  21. return s_map;
  22. }
  23. Menu* Menu::from_menu_id(int menu_id)
  24. {
  25. auto it = all_menus().find(menu_id);
  26. if (it == all_menus().end())
  27. return nullptr;
  28. return (*it).value;
  29. }
  30. Menu::Menu(String name)
  31. : m_name(move(name))
  32. {
  33. }
  34. Menu::~Menu()
  35. {
  36. unrealize_menu();
  37. }
  38. void Menu::set_icon(Gfx::Bitmap const* icon)
  39. {
  40. m_icon = icon;
  41. }
  42. void Menu::add_action(NonnullRefPtr<Action> action)
  43. {
  44. auto item = make<MenuItem>(m_menu_id, move(action));
  45. if (m_menu_id != -1)
  46. realize_menu_item(*item, m_items.size());
  47. m_items.append(move(item));
  48. }
  49. void Menu::remove_all_actions()
  50. {
  51. for (auto& item : m_items) {
  52. ConnectionToWindowServer::the().async_remove_menu_item(m_menu_id, item->identifier());
  53. }
  54. m_items.clear();
  55. }
  56. void Menu::update_parent_menu_item()
  57. {
  58. if (auto parent = m_parent_menu.strong_ref()) {
  59. auto const& parent_items = parent->items();
  60. if (m_index_in_parent_menu >= 0 && static_cast<unsigned>(m_index_in_parent_menu) < parent_items.size()) {
  61. auto& item = *parent_items[m_index_in_parent_menu];
  62. if (item.submenu() == this)
  63. item.update_from_menu(Badge<Menu> {});
  64. return;
  65. }
  66. // Parent has since been cleared/repopulated:
  67. parent = nullptr;
  68. m_index_in_parent_menu = -1;
  69. }
  70. }
  71. void Menu::set_name(String name)
  72. {
  73. m_name = move(name);
  74. if (m_menu_id != -1) {
  75. ConnectionToWindowServer::the().async_set_menu_name(m_menu_id, m_name);
  76. update_parent_menu_item();
  77. }
  78. }
  79. void Menu::set_parent(Menu& menu, int submenu_index)
  80. {
  81. m_parent_menu = menu;
  82. m_index_in_parent_menu = submenu_index;
  83. }
  84. NonnullRefPtr<Menu> Menu::add_submenu(String name)
  85. {
  86. auto submenu = Menu::construct(move(name));
  87. auto item = make<MenuItem>(m_menu_id, submenu);
  88. submenu->set_parent(*this, m_items.size());
  89. if (m_menu_id != -1)
  90. realize_menu_item(*item, m_items.size());
  91. m_items.append(move(item));
  92. return submenu;
  93. }
  94. void Menu::add_separator()
  95. {
  96. auto item = make<MenuItem>(m_menu_id, MenuItem::Type::Separator);
  97. if (m_menu_id != -1)
  98. realize_menu_item(*item, m_items.size());
  99. m_items.append(move(item));
  100. }
  101. void Menu::realize_if_needed(RefPtr<Action> const& default_action)
  102. {
  103. if (m_menu_id == -1 || m_current_default_action.ptr() != default_action)
  104. realize_menu(default_action);
  105. }
  106. void Menu::popup(Gfx::IntPoint screen_position, RefPtr<Action> const& default_action, Gfx::IntRect const& button_rect)
  107. {
  108. realize_if_needed(default_action);
  109. ConnectionToWindowServer::the().async_popup_menu(m_menu_id, screen_position, button_rect);
  110. }
  111. void Menu::dismiss()
  112. {
  113. if (m_menu_id == -1)
  114. return;
  115. ConnectionToWindowServer::the().async_dismiss_menu(m_menu_id);
  116. }
  117. int Menu::realize_menu(RefPtr<Action> default_action)
  118. {
  119. unrealize_menu();
  120. m_menu_id = s_menu_id_allocator.allocate();
  121. ConnectionToWindowServer::the().async_create_menu(m_menu_id, m_name);
  122. dbgln_if(MENU_DEBUG, "GUI::Menu::realize_menu(): New menu ID: {}", m_menu_id);
  123. VERIFY(m_menu_id > 0);
  124. m_current_default_action = default_action;
  125. for (size_t i = 0; i < m_items.size(); ++i) {
  126. realize_menu_item(*m_items[i], i);
  127. }
  128. all_menus().set(m_menu_id, this);
  129. return m_menu_id;
  130. }
  131. void Menu::unrealize_menu()
  132. {
  133. if (m_menu_id == -1)
  134. return;
  135. all_menus().remove(m_menu_id);
  136. ConnectionToWindowServer::the().async_destroy_menu(m_menu_id);
  137. m_menu_id = -1;
  138. }
  139. void Menu::realize_menu_if_needed()
  140. {
  141. if (menu_id() == -1)
  142. realize_menu();
  143. }
  144. Action* Menu::action_at(size_t index)
  145. {
  146. if (index >= m_items.size())
  147. return nullptr;
  148. return m_items[index]->action();
  149. }
  150. void Menu::set_children_actions_enabled(bool enabled)
  151. {
  152. for (auto& item : m_items) {
  153. if (item->action())
  154. item->action()->set_enabled(enabled);
  155. }
  156. }
  157. void Menu::visibility_did_change(Badge<ConnectionToWindowServer>, bool visible)
  158. {
  159. if (m_visible == visible)
  160. return;
  161. m_visible = visible;
  162. if (on_visibility_change)
  163. on_visibility_change(visible);
  164. }
  165. void Menu::realize_menu_item(MenuItem& item, int item_id)
  166. {
  167. item.set_menu_id({}, m_menu_id);
  168. item.set_identifier({}, item_id);
  169. switch (item.type()) {
  170. case MenuItem::Type::Separator:
  171. ConnectionToWindowServer::the().async_add_menu_separator(m_menu_id);
  172. break;
  173. case MenuItem::Type::Action: {
  174. auto& action = *item.action();
  175. auto shortcut_text = action.shortcut().is_valid() ? action.shortcut().to_byte_string() : ByteString();
  176. bool exclusive = action.group() && action.group()->is_exclusive() && action.is_checkable();
  177. bool is_default = (m_current_default_action.ptr() == &action);
  178. auto icon = action.icon() ? action.icon()->to_shareable_bitmap() : Gfx::ShareableBitmap();
  179. ConnectionToWindowServer::the().async_add_menu_item(m_menu_id, item_id, -1, action.text(), action.is_enabled(), action.is_visible(), action.is_checkable(), action.is_checkable() ? action.is_checked() : false, is_default, shortcut_text, icon, exclusive);
  180. break;
  181. }
  182. case MenuItem::Type::Submenu: {
  183. auto& submenu = *item.submenu();
  184. submenu.realize_if_needed(m_current_default_action.strong_ref());
  185. auto icon = submenu.icon() ? submenu.icon()->to_shareable_bitmap() : Gfx::ShareableBitmap();
  186. ConnectionToWindowServer::the().async_add_menu_item(m_menu_id, item_id, submenu.menu_id(), submenu.name().to_byte_string(), true, true, false, false, false, "", icon, false);
  187. break;
  188. }
  189. case MenuItem::Type::Invalid:
  190. default:
  191. VERIFY_NOT_REACHED();
  192. }
  193. }
  194. void Menu::add_recent_files_list(Function<void(Action&)> callback, AddTrailingSeparator add_trailing_separator)
  195. {
  196. m_recent_files_callback = move(callback);
  197. Vector<NonnullRefPtr<GUI::Action>> recent_file_actions;
  198. for (size_t i = 0; i < GUI::Application::max_recently_open_files(); ++i) {
  199. recent_file_actions.append(GUI::Action::create("", [&](auto& action) { m_recent_files_callback(action); }));
  200. }
  201. recent_file_actions.append(GUI::Action::create("(No recently open files)", nullptr));
  202. recent_file_actions.last()->set_enabled(false);
  203. auto* app = GUI::Application::the();
  204. app->register_recent_file_actions({}, recent_file_actions);
  205. for (auto& action : recent_file_actions) {
  206. add_action(action);
  207. }
  208. if (add_trailing_separator == AddTrailingSeparator::Yes)
  209. add_separator();
  210. }
  211. }