pool editors: add undo/redo

carrotIndustries · carrotIndustries · commit 74ba93db6b39 · 2022-11-29T23:32:26.000+01:00
changelog: New Features/Pool Manager: undo/redo for Unit, Entity and Part editors
diff --git a/Makefile b/Makefile
@@ -715,6 +715,7 @@ SRC_POOL_PRJ_MGR = \
 	src/pool-prj-mgr/pool-mgr/pool_notebook_frames.cpp\
 	src/pool-prj-mgr/pool-mgr/pool_notebook_decals.cpp\
 	src/pool-prj-mgr/pool-mgr/pool_notebook_parametric.cpp\
+	src/util/history_manager.cpp\
 	src/pool-prj-mgr/pool-mgr/editors/editor_base.cpp\
 	src/pool-prj-mgr/pool-mgr/editors/unit_editor.cpp\
 	src/pool-prj-mgr/pool-mgr/editors/part_editor.cpp\
diff --git a/src/pool-prj-mgr/pool-mgr/editors/editor_base.cpp b/src/pool-prj-mgr/pool-mgr/editors/editor_base.cpp
@@ -42,4 +42,36 @@ void PoolEditorBase::label_make_item_link(Gtk::Label &la, ObjectType type)
             false);
 }
 
+bool PoolEditorBase::can_redo() const
+{
+    return history_manager.can_redo();
+}
+
+bool PoolEditorBase::can_undo() const
+{
+    return history_manager.can_undo();
+}
+
+void PoolEditorBase::history_append(const std::string &comment)
+{
+    history_manager.push(make_history_item(comment));
+}
+
+void PoolEditorBase::undo()
+{
+    if (!history_manager.can_undo())
+        return;
+    history_load(history_manager.undo());
+    set_needs_save(true);
+}
+
+void PoolEditorBase::redo()
+{
+    if (!history_manager.can_redo())
+        return;
+    history_load(history_manager.redo());
+    set_needs_save(true);
+}
+
+
 } // namespace horizon
diff --git a/src/pool-prj-mgr/pool-mgr/editors/editor_base.hpp b/src/pool-prj-mgr/pool-mgr/editors/editor_base.hpp
@@ -2,6 +2,7 @@
 #include "util/pool_goto_provider.hpp"
 #include "util/item_set.hpp"
 #include "rules/rules.hpp"
+#include "util/history_manager.hpp"
 #include <gtkmm.h>
 
 namespace horizon {
@@ -32,6 +33,13 @@ class PoolEditorBase : public PoolGotoProvider {
 
     std::string filename;
 
+    void undo();
+    void redo();
+
+    bool can_undo() const;
+    bool can_redo() const;
+
+    void history_append(const std::string &comment);
     typedef sigc::signal<void> type_signal_needs_save;
     type_signal_needs_save signal_needs_save()
     {
@@ -52,17 +60,19 @@ class PoolEditorBase : public PoolGotoProvider {
 protected:
     IPool &pool;
 
-    void unset_needs_save()
+    HistoryManager history_manager;
+
+    virtual std::unique_ptr<HistoryManager::HistoryItem> make_history_item(const std::string &comment) = 0;
+    virtual void history_load(const HistoryManager::HistoryItem &it) = 0;
+
+    void set_needs_save()
     {
-        needs_save = false;
-        s_signal_needs_save.emit();
+        set_needs_save(false);
     }
 
-    void set_needs_save()
+    void unset_needs_save()
     {
-        if (loading)
-            throw std::runtime_error("set_needs_save called while loading");
-        needs_save = true;
+        needs_save = false;
         s_signal_needs_save.emit();
     }
 
@@ -102,5 +112,15 @@ class PoolEditorBase : public PoolGotoProvider {
     bool loading = false;
     bool needs_save = false;
     type_signal_needs_save s_signal_needs_save;
+
+    void set_needs_save(bool from_undo)
+    {
+        if (loading)
+            throw std::runtime_error("set_needs_save called while loading");
+        needs_save = true;
+        if (!from_undo)
+            history_append("edit");
+        s_signal_needs_save.emit();
+    }
 };
 } // namespace horizon
diff --git a/src/pool-prj-mgr/pool-mgr/editors/editor_window.cpp b/src/pool-prj-mgr/pool-mgr/editors/editor_window.cpp
@@ -30,6 +30,24 @@ EditorWindow::EditorWindow(ObjectType ty, const std::string &filename, IPool *p,
     save_button = Gtk::manage(new Gtk::Button());
     hb->pack_start(*save_button);
 
+    {
+        auto box = Gtk::manage(new Gtk::Box(Gtk::ORIENTATION_HORIZONTAL));
+        box->get_style_context()->add_class("linked");
+
+        undo_button = Gtk::manage(new Gtk::Button);
+        undo_button->set_tooltip_text("Undo");
+        undo_button->set_image_from_icon_name("edit-undo-symbolic", Gtk::ICON_SIZE_BUTTON);
+        box->pack_start(*undo_button, false, false, 0);
+
+        redo_button = Gtk::manage(new Gtk::Button);
+        redo_button->set_tooltip_text("Redo");
+        redo_button->set_image_from_icon_name("edit-redo-symbolic", Gtk::ICON_SIZE_BUTTON);
+        box->pack_start(*redo_button, false, false, 0);
+
+        hb->pack_start(*box);
+        box->show_all();
+    }
+
     check_button = Gtk::manage(new Gtk::MenuButton());
     {
         auto box = Gtk::manage(new Gtk::Box(Gtk::ORIENTATION_HORIZONTAL, 5));
@@ -91,6 +109,17 @@ EditorWindow::EditorWindow(ObjectType ty, const std::string &filename, IPool *p,
     default:;
     }
 
+    update_undo_redo();
+    undo_button->signal_clicked().connect([this] {
+        iface->undo();
+        update_undo_redo();
+    });
+    redo_button->signal_clicked().connect([this] {
+        iface->redo();
+        update_undo_redo();
+    });
+
+
     auto box = Gtk::manage(new Gtk::Box(Gtk::Orientation::ORIENTATION_VERTICAL, 0));
     add(*box);
     box->show();
@@ -140,7 +169,10 @@ EditorWindow::EditorWindow(ObjectType ty, const std::string &filename, IPool *p,
     iface->signal_open_item().connect([this](ObjectType t, UUID uu) { s_signal_open_item.emit(t, uu); });
     if (!read_only) {
         save_button->set_sensitive(iface->get_needs_save());
-        iface->signal_needs_save().connect([this] { save_button->set_sensitive(iface->get_needs_save()); });
+        iface->signal_needs_save().connect([this] {
+            save_button->set_sensitive(iface->get_needs_save());
+            update_undo_redo();
+        });
     }
     iface->signal_needs_save().connect([this] {
         if (iface->get_needs_save()) {
@@ -332,4 +364,10 @@ void EditorWindow::run_checks()
     check_label->set_text(s);
 }
 
+void EditorWindow::update_undo_redo()
+{
+    undo_button->set_sensitive(iface->can_undo());
+    redo_button->set_sensitive(iface->can_redo());
+}
+
 } // namespace horizon
diff --git a/src/pool-prj-mgr/pool-mgr/editors/editor_window.hpp b/src/pool-prj-mgr/pool-mgr/editors/editor_window.hpp
@@ -52,6 +52,9 @@ class EditorWindow : public Gtk::Window, public PoolGotoProvider {
     Gtk::Label *check_label = nullptr;
     Gtk::InfoBar *info_bar = nullptr;
     Gtk::Label *info_bar_label = nullptr;
+    Gtk::Button *undo_button = nullptr;
+    Gtk::Button *redo_button = nullptr;
+    void update_undo_redo();
     class IPool &pool;
     class PoolParametric *pool_parametric;
     bool need_update = false;
diff --git a/src/pool-prj-mgr/pool-mgr/editors/entity_editor.cpp b/src/pool-prj-mgr/pool-mgr/editors/entity_editor.cpp
@@ -102,6 +102,8 @@ EntityEditor::EntityEditor(BaseObjectType *cobject, const Glib::RefPtr<Gtk::Buil
     : Gtk::Box(cobject), PoolEditorBase(fn, p),
       entity(filename.size() ? Entity::new_from_file(filename, pool) : Entity(UUID::random()))
 {
+    history_append("init");
+
     x->get_widget("entity_name", name_entry);
     x->get_widget("entity_manufacturer", manufacturer_entry);
     {
@@ -292,6 +294,26 @@ ObjectType EntityEditor::get_type() const
     return ObjectType::ENTITY;
 }
 
+class HistoryItemEntity : public HistoryManager::HistoryItem {
+public:
+    HistoryItemEntity(const Entity &e, const std::string &cm) : HistoryManager::HistoryItem(cm), entity(e)
+    {
+    }
+    Entity entity;
+};
+
+std::unique_ptr<HistoryManager::HistoryItem> EntityEditor::make_history_item(const std::string &comment)
+{
+    return std::make_unique<HistoryItemEntity>(entity, comment);
+}
+
+void EntityEditor::history_load(const HistoryManager::HistoryItem &it)
+{
+    const auto &x = dynamic_cast<const HistoryItemEntity &>(it);
+    entity = x.entity;
+    load();
+}
+
 EntityEditor *EntityEditor::create(const std::string &fn, class IPool &p)
 {
     EntityEditor *w;
diff --git a/src/pool-prj-mgr/pool-mgr/editors/entity_editor.hpp b/src/pool-prj-mgr/pool-mgr/editors/entity_editor.hpp
@@ -51,5 +51,8 @@ class EntityEditor : public Gtk::Box, public PoolEditorBase {
     SortHelper sort_helper;
 
     void bind_entry(Gtk::Entry *e, std::string &s);
+
+    std::unique_ptr<HistoryManager::HistoryItem> make_history_item(const std::string &comment) override;
+    void history_load(const HistoryManager::HistoryItem &it) override;
 };
 } // namespace horizon
diff --git a/src/pool-prj-mgr/pool-mgr/editors/part_editor.cpp b/src/pool-prj-mgr/pool-mgr/editors/part_editor.cpp
@@ -200,7 +200,7 @@ PartEditor::PartEditor(BaseObjectType *cobject, const Glib::RefPtr<Gtk::Builder>
     : Gtk::Box(cobject), PoolEditorBase(fn, po),
       part(filename.size() ? Part::new_from_file(filename, pool) : Part(UUID::random())), pool_parametric(pp)
 {
-
+    history_append("init");
     auto add_entry = [x](const char *name) {
         Gtk::Box *t;
         x->get_widget(name, t);
@@ -1172,6 +1172,28 @@ ObjectType PartEditor::get_type() const
     return ObjectType::PART;
 }
 
+class HistoryItemPart : public HistoryManager::HistoryItem {
+public:
+    HistoryItemPart(const Part &p, const std::string &cm) : HistoryManager::HistoryItem(cm), part(p)
+    {
+    }
+    Part part;
+};
+
+std::unique_ptr<HistoryManager::HistoryItem> PartEditor::make_history_item(const std::string &comment)
+{
+    return std::make_unique<HistoryItemPart>(part, comment);
+}
+
+void PartEditor::history_load(const HistoryManager::HistoryItem &it)
+{
+    const auto &x = dynamic_cast<const HistoryItemPart &>(it);
+    part = x.part;
+    part.update_refs(pool);
+    load();
+}
+
+
 PartEditor *PartEditor::create(const std::string &fn, IPool &po, PoolParametric &pp)
 {
     PartEditor *w;
diff --git a/src/pool-prj-mgr/pool-mgr/editors/part_editor.hpp b/src/pool-prj-mgr/pool-mgr/editors/part_editor.hpp
@@ -151,5 +151,8 @@ class PartEditor : public Gtk::Box, public PoolEditorBase {
     class OrderableMPNEditor *create_orderable_MPN_editor(const UUID &uu);
 
     UUID pending_base_part;
+
+    std::unique_ptr<HistoryManager::HistoryItem> make_history_item(const std::string &comment) override;
+    void history_load(const HistoryManager::HistoryItem &it) override;
 };
 } // namespace horizon
diff --git a/src/pool-prj-mgr/pool-mgr/editors/unit_editor.cpp b/src/pool-prj-mgr/pool-mgr/editors/unit_editor.cpp
@@ -136,6 +136,7 @@ UnitEditor::UnitEditor(BaseObjectType *cobject, const Glib::RefPtr<Gtk::Builder>
     : Gtk::Box(cobject), PoolEditorBase(fn, p),
       unit(filename.size() ? Unit::new_from_file(filename) : Unit(UUID::random()))
 {
+    history_append("init");
     x->get_widget("unit_name", name_entry);
     x->get_widget("unit_manufacturer", manufacturer_entry);
     x->get_widget("unit_pins", pins_listbox);
@@ -383,6 +384,26 @@ ObjectType UnitEditor::get_type() const
     return ObjectType::UNIT;
 }
 
+class HistoryItemUnit : public HistoryManager::HistoryItem {
+public:
+    HistoryItemUnit(const Unit &u, const std::string &cm) : HistoryManager::HistoryItem(cm), unit(u)
+    {
+    }
+    Unit unit;
+};
+
+std::unique_ptr<HistoryManager::HistoryItem> UnitEditor::make_history_item(const std::string &comment)
+{
+    return std::make_unique<HistoryItemUnit>(unit, comment);
+}
+
+void UnitEditor::history_load(const HistoryManager::HistoryItem &it)
+{
+    const auto &x = dynamic_cast<const HistoryItemUnit &>(it);
+    unit = x.unit;
+    load();
+}
+
 UnitEditor *UnitEditor::create(const std::string &fn, class IPool &p)
 {
     UnitEditor *w;
diff --git a/src/pool-prj-mgr/pool-mgr/editors/unit_editor.hpp b/src/pool-prj-mgr/pool-mgr/editors/unit_editor.hpp
@@ -48,5 +48,8 @@ class UnitEditor : public Gtk::Box, public PoolEditorBase {
     SortHelper sort_helper;
     void load();
     bool propagating = false;
+
+    std::unique_ptr<HistoryManager::HistoryItem> make_history_item(const std::string &comment) override;
+    void history_load(const HistoryManager::HistoryItem &it) override;
 };
 } // namespace horizon
