Merge pull request #108169 from lawnjelly/editor_get_cached

[3.x] Add `EditorSettings` `EDITOR_GET_CACHED`

Author: lawnjelly

core/os/input.cpp

@@ -140,7 +140,7 @@ void Input::_bind_methods() {
 void Input::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
 #ifdef TOOLS_ENABLED
 
-	const String quote_style = EDITOR_GET("text_editor/completion/use_single_quotes") ? "'" : "\"";
+	const String quote_style = EditorSettingsQuick::get_text_editor_completion_use_single_quotes() ? "'" : "\"";
 
 	String pf = p_function;
 	if ((p_idx == 0 && (pf == "is_action_pressed" || pf == "action_press" || pf == "action_release" || pf == "is_action_just_pressed" || pf == "is_action_just_released" || pf == "get_action_strength" || pf == "get_action_raw_strength")) ||

editor/animation_track_editor.cpp

@@ -3458,14 +3458,14 @@ void AnimationTrackEditor::_query_insert(const InsertData &p_id) {
 			insert_confirm->popup_centered_minsize();
 			insert_query = true;
 		} else {
-			call_deferred("_insert_delay", reset_allowed && EDITOR_GET("editors/animation/default_create_reset_tracks"), all_bezier && EDITOR_GET("editors/animation/default_create_bezier_tracks"));
+			call_deferred("_insert_delay", reset_allowed && EDITOR_GET_CACHED(bool, "editors/animation/default_create_reset_tracks"), all_bezier && EDITOR_GET_CACHED(bool, "editors/animation/default_create_bezier_tracks"));
 			insert_queue = true;
 		}
 
 	} else {
 		if (!insert_query && !insert_queue) {
 			// Create Beziers wouldn't make sense in this case, where no tracks are being created
-			call_deferred("_insert_delay", reset_allowed && EDITOR_GET("editors/animation/default_create_reset_tracks"), false);
+			call_deferred("_insert_delay", reset_allowed && EDITOR_GET_CACHED(bool, "editors/animation/default_create_reset_tracks"), false);
 			insert_queue = true;
 		}
 	}

editor/code_editor.cpp

@@ -1507,17 +1507,17 @@ void CodeTextEditor::_on_settings_change() {
 
 	// Auto brace completion.
 	text_editor->set_auto_brace_completion(
-			EDITOR_GET("text_editor/completion/auto_brace_complete"));
+			EDITOR_GET_CACHED(bool, "text_editor/completion/auto_brace_complete"));
 
 	code_complete_timer->set_wait_time(
-			EDITOR_GET("text_editor/completion/code_complete_delay"));
+			EDITOR_GET_CACHED(float, "text_editor/completion/code_complete_delay"));
 
 	// Call hint settings.
 	text_editor->set_callhint_settings(
-			EDITOR_GET("text_editor/completion/put_callhint_tooltip_below_current_line"),
-			EDITOR_GET("text_editor/completion/callhint_tooltip_offset"));
+			EDITOR_GET_CACHED(bool, "text_editor/completion/put_callhint_tooltip_below_current_line"),
+			EDITOR_GET_CACHED(Vector2, "text_editor/completion/callhint_tooltip_offset"));
 
-	idle->set_wait_time(EDITOR_GET("text_editor/completion/idle_parse_delay"));
+	idle->set_wait_time(EDITOR_GET_CACHED(float, "text_editor/completion/idle_parse_delay"));
 }
 
 void CodeTextEditor::_text_changed_idle_timeout() {

editor/editor_node.cpp

@@ -464,7 +464,7 @@ void EditorNode::_notification(int p_what) {
 
 			editor_selection->update();
 
-			scene_root->set_size_override(true, Size2(ProjectSettings::get_singleton()->get("display/window/size/width"), ProjectSettings::get_singleton()->get("display/window/size/height")));
+			scene_root->set_size_override(true, Size2(GLOBAL_GET_CACHED(real_t, "display/window/size/width"), GLOBAL_GET_CACHED(real_t, "display/window/size/height")));
 
 			ResourceImporterTexture::get_singleton()->update_imports();
 		} break;
@@ -532,20 +532,20 @@ void EditorNode::_notification(int p_what) {
 
 		case MainLoop::NOTIFICATION_WM_FOCUS_IN: {
 			// Restore the original FPS cap after focusing back on the editor.
-			OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(int(EDITOR_GET("interface/editor/low_processor_mode_sleep_usec")));
+			OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(EDITOR_GET_CACHED(int, "interface/editor/low_processor_mode_sleep_usec"));
 
 			EditorFileSystem::get_singleton()->scan_changes();
 			_scan_external_changes();
 		} break;
 
 		case MainLoop::NOTIFICATION_WM_FOCUS_OUT: {
 			// Save on focus loss before applying the FPS limit to avoid slowing down the saving process.
-			if (EDITOR_GET("interface/editor/save_on_focus_loss")) {
+			if (EDITOR_GET_CACHED(bool, "interface/editor/save_on_focus_loss")) {
 				_menu_option_confirm(FILE_SAVE_SCENE, false);
 			}
 
 			// Set a low FPS cap to decrease CPU/GPU usage while the editor is unfocused.
-			OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(int(EDITOR_GET("interface/editor/unfocused_low_processor_mode_sleep_usec")));
+			OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(EDITOR_GET_CACHED(int, "interface/editor/unfocused_low_processor_mode_sleep_usec"));
 		} break;
 
 		case MainLoop::NOTIFICATION_WM_ABOUT: {
@@ -2671,7 +2671,7 @@ void EditorNode::_menu_option_confirm(int p_option, bool p_confirmed) {
 			play_custom_scene_button->set_icon(gui_base->get_icon("PlayCustom", "EditorIcons"));
 			stop_button->set_disabled(true);
 
-			if (bool(EDITOR_GET("run/output/always_close_output_on_stop"))) {
+			if (EDITOR_GET_CACHED(bool, "run/output/always_close_output_on_stop")) {
 				for (int i = 0; i < bottom_panel_items.size(); i++) {
 					if (bottom_panel_items[i].control == log) {
 						_bottom_panel_switch(false, i);
@@ -2695,7 +2695,7 @@ void EditorNode::_menu_option_confirm(int p_option, bool p_confirmed) {
 
 		} break;
 		case RUN_PLAY_NATIVE: {
-			bool autosave = EDITOR_GET("run/auto_save/save_before_running");
+			bool autosave = EDITOR_GET_CACHED(bool, "run/auto_save/save_before_running");
 			if (autosave) {
 				_menu_option_confirm(FILE_SAVE_ALL_SCENES, false);
 			}
@@ -5006,7 +5006,7 @@ void EditorNode::_scene_tab_closed(int p_tab, int option) {
 }
 
 void EditorNode::_scene_tab_hover(int p_tab) {
-	if (!bool(EDITOR_GET("interface/scene_tabs/show_thumbnail_on_hover"))) {
+	if (!EDITOR_GET_CACHED(bool, "interface/scene_tabs/show_thumbnail_on_hover")) {
 		return;
 	}
 	int current_tab = scene_tabs->get_current_tab();

editor/editor_properties.cpp

@@ -1599,7 +1599,7 @@ void EditorPropertyVector2::setup(double p_min, double p_max, double p_step, boo
 }
 
 EditorPropertyVector2::EditorPropertyVector2() {
-	bool horizontal = EDITOR_GET("interface/inspector/horizontal_vector2_editing");
+	bool horizontal = EDITOR_GET_CACHED(bool, "interface/inspector/horizontal_vector2_editing");
 
 	HBoxContainer *hb = memnew(HBoxContainer);
 	hb->set_h_size_flags(SIZE_EXPAND_FILL);
@@ -1693,7 +1693,7 @@ void EditorPropertyRect2::setup(double p_min, double p_max, double p_step, bool
 }
 
 EditorPropertyRect2::EditorPropertyRect2() {
-	bool horizontal = EDITOR_GET("interface/inspector/horizontal_vector_types_editing");
+	bool horizontal = EDITOR_GET_CACHED(bool, "interface/inspector/horizontal_vector_types_editing");
 
 	BoxContainer *bc;
 
@@ -1830,7 +1830,7 @@ void EditorPropertyVector3::setup(double p_min, double p_max, double p_step, boo
 }
 
 EditorPropertyVector3::EditorPropertyVector3() {
-	bool horizontal = EDITOR_GET("interface/inspector/horizontal_vector_types_editing");
+	bool horizontal = EDITOR_GET_CACHED(bool, "interface/inspector/horizontal_vector_types_editing");
 
 	HBoxContainer *hb = memnew(HBoxContainer);
 	hb->set_h_size_flags(SIZE_EXPAND_FILL);
@@ -1925,7 +1925,7 @@ void EditorPropertyPlane::setup(double p_min, double p_max, double p_step, bool
 }
 
 EditorPropertyPlane::EditorPropertyPlane() {
-	bool horizontal = EDITOR_GET("interface/inspector/horizontal_vector_types_editing");
+	bool horizontal = EDITOR_GET_CACHED(bool, "interface/inspector/horizontal_vector_types_editing");
 
 	BoxContainer *bc;
 
@@ -2007,7 +2007,7 @@ void EditorPropertyQuat::setup(double p_min, double p_max, double p_step, bool p
 }
 
 EditorPropertyQuat::EditorPropertyQuat() {
-	bool horizontal = EDITOR_GET("interface/inspector/horizontal_vector_types_editing");
+	bool horizontal = EDITOR_GET_CACHED(bool, "interface/inspector/horizontal_vector_types_editing");
 
 	BoxContainer *bc;
 
@@ -2373,7 +2373,7 @@ void EditorPropertyColor::_popup_closed() {
 
 void EditorPropertyColor::_picker_created() {
 	// get default color picker mode from editor settings
-	int default_color_mode = EDITOR_GET("interface/inspector/default_color_picker_mode");
+	int default_color_mode = EDITOR_GET_CACHED(int, "interface/inspector/default_color_picker_mode");
 	if (default_color_mode == 1) {
 		picker->get_picker()->set_hsv_mode(true);
 	} else if (default_color_mode == 2) {
@@ -2920,7 +2920,7 @@ void EditorPropertyResource::_bind_methods() {
 }
 
 EditorPropertyResource::EditorPropertyResource() {
-	use_sub_inspector = bool(EDITOR_GET("interface/inspector/open_resources_in_current_inspector"));
+	use_sub_inspector = EDITOR_GET_CACHED(bool, "interface/inspector/open_resources_in_current_inspector");
 
 	add_to_group("_editor_resource_properties");
 }
@@ -2936,7 +2936,7 @@ void EditorInspectorDefaultPlugin::parse_begin(Object *p_object) {
 }
 
 bool EditorInspectorDefaultPlugin::parse_property(Object *p_object, Variant::Type p_type, const String &p_path, PropertyHint p_hint, const String &p_hint_text, int p_usage) {
-	double default_float_step = EDITOR_GET("interface/inspector/default_float_step");
+	double default_float_step = EDITOR_GET_CACHED(double, "interface/inspector/default_float_step");
 
 	switch (p_type) {
 		// atomic types

editor/editor_properties_array_dict.cpp

@@ -702,7 +702,7 @@ void EditorPropertyArray::_bind_methods() {
 
 EditorPropertyArray::EditorPropertyArray() {
 	object.instance();
-	page_length = int(EDITOR_GET("interface/inspector/max_array_dictionary_items_per_page"));
+	page_length = EDITOR_GET_CACHED(int, "interface/inspector/max_array_dictionary_items_per_page");
 	edit = memnew(Button);
 	edit->set_flat(true);
 	edit->set_h_size_flags(SIZE_EXPAND_FILL);
@@ -1190,7 +1190,7 @@ void EditorPropertyDictionary::_bind_methods() {
 
 EditorPropertyDictionary::EditorPropertyDictionary() {
 	object.instance();
-	page_length = int(EDITOR_GET("interface/inspector/max_array_dictionary_items_per_page"));
+	page_length = EDITOR_GET_CACHED(int, "interface/inspector/max_array_dictionary_items_per_page");
 	edit = memnew(Button);
 	edit->set_flat(true);
 	edit->set_h_size_flags(SIZE_EXPAND_FILL);

editor/editor_property_name_processor.cpp

@@ -35,15 +35,15 @@
 EditorPropertyNameProcessor *EditorPropertyNameProcessor::singleton = nullptr;
 
 EditorPropertyNameProcessor::Style EditorPropertyNameProcessor::get_default_inspector_style() {
-	const Style style = (Style)EDITOR_GET("interface/inspector/default_property_name_style").operator int();
+	const Style style = (Style)EDITOR_GET_CACHED(int, "interface/inspector/default_property_name_style");
 	if (style == STYLE_LOCALIZED && !is_localization_available()) {
 		return STYLE_CAPITALIZED;
 	}
 	return style;
 }
 
 EditorPropertyNameProcessor::Style EditorPropertyNameProcessor::get_settings_style() {
-	const bool translate = EDITOR_GET("interface/editor/localize_settings");
+	const bool translate = EDITOR_GET_CACHED(bool, "interface/editor/localize_settings");
 	return translate ? STYLE_LOCALIZED : STYLE_CAPITALIZED;
 }
 

editor/editor_settings.cpp

@@ -47,6 +47,12 @@
 #include "scene/main/scene_tree.h"
 #include "scene/main/viewport.h"
 
+EditorSettingsQuick::Data EditorSettingsQuick::data = EditorSettingsQuick::Data();
+
+void EditorSettingsQuick::refresh() {
+	data.text_editor_completion_use_single_quotes = EDITOR_GET_CACHED(bool, "text_editor/completion/use_single_quotes");
+}
+
 // PRIVATE METHODS
 
 Ref<EditorSettings> EditorSettings::singleton = nullptr;
@@ -108,6 +114,10 @@ bool EditorSettings::_set_only(const StringName &p_name, const Variant &p_value)
 		}
 	}
 
+	if (changed) {
+		_version++;
+	}
+
 	return changed;
 }
 
@@ -1155,6 +1165,7 @@ void EditorSettings::set_initial_value(const StringName &p_setting, const Varian
 	}
 	props[p_setting].initial = p_value;
 	props[p_setting].has_default_value = true;
+
 	if (p_update_current) {
 		set(p_setting, p_value);
 	}
@@ -1605,6 +1616,8 @@ Ref<ShortCut> ED_SHORTCUT(const String &p_path, const String &p_name, uint32_t p
 void EditorSettings::notify_changes() {
 	_THREAD_SAFE_METHOD_
 
+	EditorSettingsQuick::refresh();
+
 	SceneTree *sml = Object::cast_to<SceneTree>(OS::get_singleton()->get_main_loop());
 
 	if (!sml) {

editor/editor_settings.h

@@ -34,19 +34,37 @@
 #include "core/object.h"
 
 #include "core/io/config_file.h"
+#include "core/os/spin_lock.h"
 #include "core/os/thread_safe.h"
 #include "core/resource.h"
 #include "core/translation.h"
 #include "scene/gui/shortcut.h"
 
 class EditorPlugin;
 
+// Fast access to frequently used settings.
+class EditorSettingsQuick {
+	struct Data {
+		bool text_editor_completion_use_single_quotes = false;
+	};
+	static Data data;
+
+public:
+	static bool get_text_editor_completion_use_single_quotes() { return data.text_editor_completion_use_single_quotes; }
+
+	static void refresh();
+};
+
 class EditorSettings : public Resource {
 	GDCLASS(EditorSettings, Resource);
 
 private:
 	_THREAD_SAFE_CLASS_
 
+	// Starting version from 1 ensures that all callers can reset their tested version to 0,
+	// and will always detect the initial editor settings as a "change".
+	uint32_t _version = 1;
+
 public:
 	struct Plugin {
 		EditorPlugin *instance;
@@ -199,6 +217,9 @@ class EditorSettings : public Resource {
 
 	void notify_changes();
 
+	// Testing a version allows fast cached EDITOR_GET macros.
+	uint32_t get_version() const { return _version; }
+
 	EditorSettings();
 	~EditorSettings();
 };
@@ -216,4 +237,27 @@ Variant _EDITOR_GET(const String &p_setting);
 Ref<ShortCut> ED_SHORTCUT(const String &p_path, const String &p_name, uint32_t p_keycode = 0);
 Ref<ShortCut> ED_GET_SHORTCUT(const String &p_path);
 
+/////////////////////////////////////////////////////////////////////////////////////////
+// Cached versions of EDITOR_GET.
+// Cached but uses a typed variable for storage, this can be more efficient.
+// Variables prefixed with _egc_ to avoid shadowing warnings.
+#define EDITOR_GET_CACHED(m_type, m_setting_name) ([](const char *p_egc_name) -> m_type {\
+static_assert(std::is_trivially_destructible<m_type>::value, "EDITOR_GET_CACHED must use a trivial type that allows static lifetime.");\
+static m_type _egc_local_var;\
+static uint32_t _egc_local_version = 0;\
+static SpinLock _egc_spin;\
+uint32_t _egc_new_version = EditorSettings::get_singleton()->get_version();\
+if (_egc_local_version != _egc_new_version) {\
+	_egc_spin.lock();\
+	_egc_local_version = _egc_new_version;\
+	_egc_local_var = _EDITOR_GET(p_egc_name);\
+	m_type _egc_temp = _egc_local_var;\
+	_egc_spin.unlock();\
+	return _egc_temp;\
+}\
+_egc_spin.lock();\
+m_type _egc_temp2 = _egc_local_var;\
+_egc_spin.unlock();\
+return _egc_temp2; })(m_setting_name)
+
 #endif // EDITOR_SETTINGS_H

editor/editor_themes.cpp

@@ -135,7 +135,7 @@ static Ref<ImageTexture> editor_generate_icon(int p_index, bool p_convert_color,
 #endif
 
 float get_gizmo_handle_scale(const String &gizmo_handle_name = "") {
-	const float scale_gizmo_handles_for_touch = EDITOR_GET("interface/touchscreen/scale_gizmo_handles");
+	const float scale_gizmo_handles_for_touch = EDITOR_GET_CACHED(float, "interface/touchscreen/scale_gizmo_handles");
 	if (scale_gizmo_handles_for_touch > 1.0f) {
 		// The names of the icons that require custom scaling.
 		static Set<StringName> gizmo_to_scale;
@@ -772,12 +772,14 @@ Ref<Theme> create_editor_theme(const Ref<Theme> p_theme) {
 	theme->set_icon("visibility_xray", "PopupMenu", theme->get_icon("GuiVisibilityXray", "EditorIcons"));
 	theme->set_constant("vseparation", "PopupMenu", (extra_spacing + default_margin_size + 1) * EDSCALE);
 
+	float subresource_hue_tint = EDITOR_GET("docks/property_editor/subresource_hue_tint");
+
 	for (int i = 0; i < 16; i++) {
 		Color si_base_color = accent_color;
 
 		float hue_rotate = (i * 2 % 16) / 16.0;
 		si_base_color.set_hsv(Math::fmod(float(si_base_color.get_h() + hue_rotate), float(1.0)), si_base_color.get_s(), si_base_color.get_v());
-		si_base_color = accent_color.linear_interpolate(si_base_color, float(EDITOR_GET("docks/property_editor/subresource_hue_tint")));
+		si_base_color = accent_color.linear_interpolate(si_base_color, subresource_hue_tint);
 
 		Ref<StyleBoxFlat> sub_inspector_bg;