Core: store what has been done in history

Author: carrotIndustries

src/core/core.cpp

@@ -63,6 +63,7 @@ ToolResponse Core::tool_begin(ToolID tool_id, const ToolArgs &args, class ImpInt
                                  Logger::Domain::CORE, e.what());
             return ToolResponse::end();
         }
+        tool_id_current = tool_id;
         maybe_end_tool(r);
 
         return r;
@@ -82,15 +83,17 @@ void Core::maybe_end_tool(const ToolResponse &r)
         s_signal_tool_changed.emit(ToolID::NONE);
         if (r.result == ToolResponse::Result::COMMIT) {
             set_needs_save(true);
-            rebuild_internal(false);
+            const auto comment = action_catalog.at(tool_id_current).name;
+            rebuild_internal(false, comment);
         }
         else if (r.result == ToolResponse::Result::REVERT) {
             history_load(history_current);
-            rebuild_internal(true);
+            rebuild_internal(true, "undo");
         }
         else if (r.result == ToolResponse::Result::END) { // did nothing
             // do nothing
         }
+        tool_id_current = ToolID::NONE;
     }
 }
 
@@ -138,19 +141,19 @@ ToolResponse Core::tool_update(const ToolArgs &args)
     return ToolResponse();
 }
 
-void Core::rebuild()
+void Core::rebuild(const std::string &comment)
 {
-    rebuild_internal(false);
+    rebuild_internal(false, comment);
 }
 
-void Core::rebuild_finish(bool from_undo)
+void Core::rebuild_finish(bool from_undo, const std::string &comment)
 {
     if (!from_undo) {
         while (history_current + 1 != (int)history.size()) {
             history.pop_back();
         }
         assert(history_current + 1 == (int)history.size());
-        history_push();
+        history_push(comment);
         history_current++;
         history_trim();
     }
@@ -181,6 +184,28 @@ void Core::redo()
     set_needs_save();
 }
 
+static const std::string empty_string;
+
+const std::string &Core::get_undo_comment() const
+{
+    if (can_undo()) {
+        return history.at(history_current)->comment;
+    }
+    else {
+        return empty_string;
+    }
+}
+
+const std::string &Core::get_redo_comment() const
+{
+    if (can_redo()) {
+        return history.at(history_current + 1)->comment;
+    }
+    else {
+        return empty_string;
+    }
+}
+
 void Core::history_clear()
 {
     history.clear();
@@ -218,7 +243,7 @@ void Core::set_property_commit()
 {
     if (!property_transaction)
         throw std::runtime_error("no transaction in progress");
-    rebuild();
+    rebuild("edit property");
     set_needs_save(true);
     property_transaction = false;
 }
@@ -278,7 +303,8 @@ void Core::autosave()
     save(autosave_suffix);
 }
 
-Core::Core(IPool &pool, IPool *pool_caching) : m_pool(pool), m_pool_caching(pool_caching ? *pool_caching : pool)
+Core::Core(IPool &pool, IPool *pool_caching)
+    : m_pool(pool), m_pool_caching(pool_caching ? *pool_caching : pool), tool_id_current(ToolID::NONE)
 {
 }
 

src/core/core.hpp

@@ -70,7 +70,7 @@ class Core : public virtual Document {
      * Expands the non-working document.
      * And copies the non-working document to the working document.
      */
-    void rebuild();
+    void rebuild(const std::string &comment);
     ToolResponse tool_begin(ToolID tool_id, const ToolArgs &args, class ImpInterface *imp, bool transient = false);
     ToolResponse tool_update(const ToolArgs &args);
     std::pair<bool, bool> tool_can_begin(ToolID tool_id, const std::set<SelectableRef> &selection);
@@ -84,6 +84,9 @@ class Core : public virtual Document {
     bool can_undo() const;
     bool can_redo() const;
 
+    const std::string &get_undo_comment() const;
+    const std::string &get_redo_comment() const;
+
     inline bool tool_is_active()
     {
         return tool != nullptr;
@@ -179,6 +182,7 @@ class Core : public virtual Document {
     class IPool &m_pool;
     class IPool &m_pool_caching;
 
+    ToolID tool_id_current;
     std::unique_ptr<ToolBase> tool = nullptr;
     type_signal_tool_changed s_signal_tool_changed;
     type_signal_rebuilt s_signal_rebuilt;
@@ -191,20 +195,21 @@ class Core : public virtual Document {
     bool needs_save = false;
     void set_needs_save(bool v);
 
-    void rebuild_finish(bool from_undo);
+    void rebuild_finish(bool from_undo, const std::string &comment);
 
     class HistoryItem {
     public:
-        // Symbol sym;
-        // HistoryItem(const Symbol &s): sym(s) {}
-        std::string comment;
+        HistoryItem(const std::string &c) : comment(c)
+        {
+        }
+        const std::string comment;
         virtual ~HistoryItem()
         {
         }
     };
     std::deque<std::unique_ptr<HistoryItem>> history;
     int history_current = -1;
-    virtual void history_push() = 0;
+    virtual void history_push(const std::string &comment) = 0;
     virtual void history_load(unsigned int i) = 0;
     void history_clear();
     void history_trim();
@@ -223,6 +228,6 @@ class Core : public virtual Document {
     std::unique_ptr<ToolBase> create_tool(ToolID tool_id);
     std::set<SelectableRef> tool_selection;
     void maybe_end_tool(const ToolResponse &r);
-    virtual void rebuild_internal(bool from_undo) = 0;
+    virtual void rebuild_internal(bool from_undo, const std::string &comment) = 0;
 };
 } // namespace horizon

src/core/core_board.cpp

@@ -53,7 +53,7 @@ CoreBoard::CoreBoard(const std::string &board_filename, const std::string &block
       m_blocks_filename(blocks_filename), m_pictures_dir(pictures_dir)
 {
     brd->load_pictures(pictures_dir);
-    rebuild();
+    rebuild("init");
 }
 
 void CoreBoard::reload_netlist()
@@ -98,7 +98,7 @@ void CoreBoard::reload_netlist()
     brd->update_refs();
     rules.cleanup(&*block);
     brd->expand_flags = Board::EXPAND_PROPAGATE_NETS | Board::EXPAND_ALL_AIRWIRES | Board::EXPAND_PACKAGES;
-    rebuild();
+    rebuild("reload netlist");
 }
 
 bool CoreBoard::get_property(ObjectType type, const UUID &uu, ObjectProperty::ID property, PropertyValue &value)
@@ -552,7 +552,7 @@ bool CoreBoard::set_property(ObjectType type, const UUID &uu, ObjectProperty::ID
         return false;
     }
     if (!property_transaction) {
-        rebuild_internal(false);
+        rebuild_internal(false, "edit properties");
         set_needs_save(true);
     }
     return true;
@@ -621,11 +621,11 @@ bool CoreBoard::get_property_meta(ObjectType type, const UUID &uu, ObjectPropert
     }
 }
 
-void CoreBoard::rebuild_internal(bool from_undo)
+void CoreBoard::rebuild_internal(bool from_undo, const std::string &comment)
 {
     clock_t begin = clock();
     brd->expand_some();
-    rebuild_finish(from_undo);
+    rebuild_finish(from_undo, comment);
     clock_t end = clock();
     double elapsed_secs = double(end - begin) / CLOCKS_PER_SEC;
     std::cout << "rebuild took " << elapsed_secs << std::endl;
@@ -666,13 +666,14 @@ void CoreBoard::update_rules()
     brd->rules = rules;
 }
 
-CoreBoard::HistoryItem::HistoryItem(const Block &b, const Board &r) : block(b), brd(shallow_copy, r)
+CoreBoard::HistoryItem::HistoryItem(const Block &b, const Board &r, const std::string &cm)
+    : Core::HistoryItem(cm), block(b), brd(shallow_copy, r)
 {
 }
 
-void CoreBoard::history_push()
+void CoreBoard::history_push(const std::string &comment)
 {
-    history.push_back(std::make_unique<CoreBoard::HistoryItem>(*block, *brd));
+    history.push_back(std::make_unique<CoreBoard::HistoryItem>(*block, *brd, comment));
 }
 
 void CoreBoard::history_load(unsigned int i)
@@ -698,7 +699,7 @@ void CoreBoard::reload_pool()
     brd.emplace(brd->uuid, brd_j, *block, m_pool_caching);
     keeper.restore(brd->pictures);
     history_clear();
-    rebuild();
+    rebuild("reload pool");
 }
 
 json CoreBoard::get_meta()

src/core/core_board.hpp

@@ -93,12 +93,12 @@ class CoreBoard : public Core, public DocumentBoard {
 
     class HistoryItem : public Core::HistoryItem {
     public:
-        HistoryItem(const Block &b, const Board &r);
+        HistoryItem(const Block &b, const Board &r, const std::string &comment);
         Block block;
         Board brd;
     };
-    void rebuild_internal(bool from_undo) override;
-    void history_push() override;
+    void rebuild_internal(bool from_undo, const std::string &comment) override;
+    void history_push(const std::string &comment) override;
     void history_load(unsigned int i) override;
     void save(const std::string &suffix) override;
     void delete_autosave() override;

src/core/core_decal.cpp

@@ -8,7 +8,7 @@ namespace horizon {
 CoreDecal::CoreDecal(const std::string &decal_filename, IPool &pool)
     : Core(pool, nullptr), decal(Decal::new_from_file(decal_filename)), m_decal_filename(decal_filename)
 {
-    rebuild();
+    rebuild("init");
 }
 
 
@@ -52,9 +52,9 @@ std::map<UUID, Arc> *CoreDecal::get_arc_map()
     return &decal.arcs;
 }
 
-void CoreDecal::rebuild_internal(bool from_undo)
+void CoreDecal::rebuild_internal(bool from_undo, const std::string &comment)
 {
-    rebuild_finish(from_undo);
+    rebuild_finish(from_undo, comment);
 }
 
 LayerProvider &CoreDecal::get_layer_provider()
@@ -72,13 +72,13 @@ Decal &CoreDecal::get_decal()
     return decal;
 }
 
-CoreDecal::HistoryItem::HistoryItem(const Decal &dec) : decal(dec)
+CoreDecal::HistoryItem::HistoryItem(const Decal &dec, const std::string &cm) : Core::HistoryItem(cm), decal(dec)
 {
 }
 
-void CoreDecal::history_push()
+void CoreDecal::history_push(const std::string &comment)
 {
-    history.push_back(std::make_unique<CoreDecal::HistoryItem>(decal));
+    history.push_back(std::make_unique<CoreDecal::HistoryItem>(decal, comment));
 }
 
 void CoreDecal::history_load(unsigned int i)

src/core/core_decal.hpp

@@ -41,11 +41,11 @@ class CoreDecal : public Core, public IDocumentDecal {
 
     class HistoryItem : public Core::HistoryItem {
     public:
-        HistoryItem(const Decal &r);
+        HistoryItem(const Decal &r, const std::string &cm);
         Decal decal;
     };
-    void rebuild_internal(bool from_undo) override;
-    void history_push() override;
+    void rebuild_internal(bool from_undo, const std::string &comment) override;
+    void history_push(const std::string &comment) override;
     void history_load(unsigned int i) override;
     void save(const std::string &suffix) override;
     void delete_autosave() override;

src/core/core_frame.cpp

@@ -9,7 +9,7 @@ namespace horizon {
 CoreFrame::CoreFrame(const std::string &frame_filename, IPool &pool)
     : Core(pool, nullptr), frame(Frame::new_from_file(frame_filename)), m_frame_filename(frame_filename)
 {
-    rebuild();
+    rebuild("init");
 }
 
 
@@ -73,10 +73,10 @@ bool CoreFrame::get_property_meta(ObjectType type, const UUID &uu, ObjectPropert
     return false;
 }
 
-void CoreFrame::rebuild_internal(bool from_undo)
+void CoreFrame::rebuild_internal(bool from_undo, const std::string &comment)
 {
     frame.expand();
-    rebuild_finish(from_undo);
+    rebuild_finish(from_undo, comment);
 }
 
 LayerProvider &CoreFrame::get_layer_provider()
@@ -94,13 +94,13 @@ Frame &CoreFrame::get_frame()
     return frame;
 }
 
-CoreFrame::HistoryItem::HistoryItem(const Frame &fr) : frame(fr)
+CoreFrame::HistoryItem::HistoryItem(const Frame &fr, const std::string &cm) : Core::HistoryItem(cm), frame(fr)
 {
 }
 
-void CoreFrame::history_push()
+void CoreFrame::history_push(const std::string &comment)
 {
-    history.push_back(std::make_unique<CoreFrame::HistoryItem>(frame));
+    history.push_back(std::make_unique<CoreFrame::HistoryItem>(frame, comment));
 }
 
 void CoreFrame::history_load(unsigned int i)

src/core/core_frame.hpp

@@ -44,11 +44,11 @@ class CoreFrame : public Core, public IDocumentFrame {
 
     class HistoryItem : public Core::HistoryItem {
     public:
-        HistoryItem(const Frame &r);
+        HistoryItem(const Frame &r, const std::string &comment);
         Frame frame;
     };
-    void rebuild_internal(bool from_undo) override;
-    void history_push() override;
+    void rebuild_internal(bool from_undo, const std::string &comment) override;
+    void history_push(const std::string &comment) override;
     void history_load(unsigned int i) override;
     void save(const std::string &suffix) override;
     void delete_autosave() override;