1/**************************************************************************/
2/* editor_command_palette.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef EDITOR_COMMAND_PALETTE_H
32#define EDITOR_COMMAND_PALETTE_H
33
34#include "core/input/shortcut.h"
35#include "core/os/thread_safe.h"
36#include "scene/gui/dialogs.h"
37#include "scene/gui/tree.h"
38
39class EditorCommandPalette : public ConfirmationDialog {
40 GDCLASS(EditorCommandPalette, ConfirmationDialog);
41
42 static EditorCommandPalette *singleton;
43 LineEdit *command_search_box = nullptr;
44 Tree *search_options = nullptr;
45
46 struct Command {
47 Callable callable;
48 String name;
49 String shortcut;
50 int last_used = 0; // Store time as int, because doubles have problems with text serialization.
51 };
52
53 struct CommandEntry {
54 String key_name;
55 String display_name;
56 String shortcut_text;
57 int last_used = 0;
58 float score = 0;
59 };
60
61 struct CommandEntryComparator {
62 _FORCE_INLINE_ bool operator()(const CommandEntry &A, const CommandEntry &B) const {
63 return A.score > B.score;
64 }
65 };
66
67 struct CommandHistoryComparator {
68 _FORCE_INLINE_ bool operator()(const CommandEntry &A, const CommandEntry &B) const {
69 if (A.last_used == B.last_used) {
70 return A.display_name < B.display_name;
71 } else {
72 return A.last_used > B.last_used;
73 }
74 }
75 };
76
77 HashMap<String, Command> commands;
78 HashMap<String, Pair<String, Ref<Shortcut>>> unregistered_shortcuts;
79
80 List<String> command_keys;
81
82 void _update_command_search(const String &search_text);
83 float _score_path(const String &p_search, const String &p_path);
84 void _sbox_input(const Ref<InputEvent> &p_ie);
85 void _confirmed();
86 void _update_command_keys();
87 void _add_command(String p_command_name, String p_key_name, Callable p_binded_action, String p_shortcut_text = "None");
88 void _theme_changed();
89 void _save_history() const;
90 EditorCommandPalette();
91
92protected:
93 static void _bind_methods();
94 void _notification(int p_what);
95
96public:
97 void open_popup();
98 void get_actions_list(List<String> *p_list) const;
99 void add_command(String p_command_name, String p_key_name, Callable p_action, Vector<Variant> arguments, String p_shortcut_text = "None");
100 void execute_command(String &p_command_name);
101 void register_shortcuts_as_command();
102 Ref<Shortcut> add_shortcut_command(const String &p_command, const String &p_key, Ref<Shortcut> p_shortcut);
103 void remove_command(String p_key_name);
104 static EditorCommandPalette *get_singleton();
105};
106
107Ref<Shortcut> ED_SHORTCUT_AND_COMMAND(const String &p_path, const String &p_name, Key p_keycode = Key::NONE, String p_command = "");
108
109#endif // EDITOR_COMMAND_PALETTE_H
110