initial commit, 4.5 stable

editor/editor_undo_redo_manager.h

@@ -0,0 +1,151 @@
+/**************************************************************************/
+/*  editor_undo_redo_manager.h                                            */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "core/object/object.h"
+#include "core/object/undo_redo.h"
+
+class EditorUndoRedoManager : public Object {
+	GDCLASS(EditorUndoRedoManager, Object);
+
+	static EditorUndoRedoManager *singleton;
+
+public:
+	enum SpecialHistory {
+		GLOBAL_HISTORY = 0,
+		REMOTE_HISTORY = -9,
+		INVALID_HISTORY = -99,
+	};
+
+	struct Action {
+		int history_id = INVALID_HISTORY;
+		double timestamp = 0;
+		String action_name;
+		UndoRedo::MergeMode merge_mode = UndoRedo::MERGE_DISABLE;
+		bool backward_undo_ops = false;
+		bool mark_unsaved = true;
+	};
+
+	struct History {
+		int id = INVALID_HISTORY;
+		UndoRedo *undo_redo = nullptr;
+		uint64_t saved_version = 1;
+		List<Action> undo_stack;
+		List<Action> redo_stack;
+	};
+
+private:
+	HashMap<int, History> history_map;
+	Action pending_action;
+
+	bool forced_history = false;
+	bool is_committing = false;
+
+	History *_get_newest_undo();
+
+protected:
+	static void _bind_methods();
+
+#ifndef DISABLE_DEPRECATED
+	void _create_action_bind_compat_106121(const String &p_name = "", UndoRedo::MergeMode p_mode = UndoRedo::MERGE_DISABLE, Object *p_custom_context = nullptr, bool p_backward_undo_ops = false);
+	static void _bind_compatibility_methods();
+#endif
+
+public:
+	History &get_or_create_history(int p_idx);
+	UndoRedo *get_history_undo_redo(int p_idx) const;
+	int get_history_id_for_object(Object *p_object) const;
+	History &get_history_for_object(Object *p_object);
+	void force_fixed_history();
+
+	void create_action_for_history(const String &p_name, int p_history_id, UndoRedo::MergeMode p_mode = UndoRedo::MERGE_DISABLE, bool p_backward_undo_ops = false, bool p_mark_unsaved = true);
+	void create_action(const String &p_name = "", UndoRedo::MergeMode p_mode = UndoRedo::MERGE_DISABLE, Object *p_custom_context = nullptr, bool p_backward_undo_ops = false, bool p_mark_unsaved = true);
+
+	void add_do_methodp(Object *p_object, const StringName &p_method, const Variant **p_args, int p_argcount);
+	void add_undo_methodp(Object *p_object, const StringName &p_method, const Variant **p_args, int p_argcount);
+
+	template <typename... VarArgs>
+	void add_do_method(Object *p_object, const StringName &p_method, VarArgs... p_args) {
+		Variant args[sizeof...(p_args) + 1] = { p_args..., Variant() }; // +1 makes sure zero sized arrays are also supported.
+		const Variant *argptrs[sizeof...(p_args) + 1];
+		for (uint32_t i = 0; i < sizeof...(p_args); i++) {
+			argptrs[i] = &args[i];
+		}
+
+		add_do_methodp(p_object, p_method, sizeof...(p_args) == 0 ? nullptr : (const Variant **)argptrs, sizeof...(p_args));
+	}
+
+	template <typename... VarArgs>
+	void add_undo_method(Object *p_object, const StringName &p_method, VarArgs... p_args) {
+		Variant args[sizeof...(p_args) + 1] = { p_args..., Variant() }; // +1 makes sure zero sized arrays are also supported.
+		const Variant *argptrs[sizeof...(p_args) + 1];
+		for (uint32_t i = 0; i < sizeof...(p_args); i++) {
+			argptrs[i] = &args[i];
+		}
+
+		add_undo_methodp(p_object, p_method, sizeof...(p_args) == 0 ? nullptr : (const Variant **)argptrs, sizeof...(p_args));
+	}
+
+	void _add_do_method(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
+	void _add_undo_method(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
+
+	void add_do_property(Object *p_object, const StringName &p_property, const Variant &p_value);
+	void add_undo_property(Object *p_object, const StringName &p_property, const Variant &p_value);
+	void add_do_reference(Object *p_object);
+	void add_undo_reference(Object *p_object);
+
+	void commit_action(bool p_execute = true);
+	bool is_committing_action() const;
+
+	bool undo();
+	bool undo_history(int p_id);
+	bool redo();
+	bool redo_history(int p_id);
+	void clear_history(int p_idx = INVALID_HISTORY, bool p_increase_version = true);
+
+	void set_history_as_saved(int p_idx);
+	void set_history_as_unsaved(int p_idx);
+	bool is_history_unsaved(int p_idx);
+	bool has_undo();
+	bool has_redo();
+	bool has_history(int p_idx) const;
+
+	String get_current_action_name();
+	int get_current_action_history_id();
+
+	void discard_history(int p_idx, bool p_erase_from_map = true);
+
+	static EditorUndoRedoManager *get_singleton();
+	EditorUndoRedoManager();
+	~EditorUndoRedoManager();
+};
+
+VARIANT_ENUM_CAST(EditorUndoRedoManager::SpecialHistory);