Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hedzr/undo-cxx
a c++17 undo/redo subsystem (linear or restricted non-linear)
https://github.com/hedzr/undo-cxx
cmake cpp cpp17 cxx17 cxx17-library history-management memento-pattern non-linear state-machine undo undo-framework undo-library undo-redo undoable undomanager
Last synced: 6 days ago
JSON representation
a c++17 undo/redo subsystem (linear or restricted non-linear)
- Host: GitHub
- URL: https://github.com/hedzr/undo-cxx
- Owner: hedzr
- License: apache-2.0
- Created: 2021-10-17T02:26:59.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T10:42:29.000Z (2 months ago)
- Last Synced: 2024-09-08T10:23:17.271Z (2 months ago)
- Topics: cmake, cpp, cpp17, cxx17, cxx17-library, history-management, memento-pattern, non-linear, state-machine, undo, undo-framework, undo-library, undo-redo, undoable, undomanager
- Language: CMake
- Homepage: https://hedzr.com/c++/algorithm/cxx17-memento-pattern/
- Size: 301 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# undo-cxx
 [](https://github.com/hedzr/undo-cxx/releases)
`undo-cxx` C++17/20 library provides a undo/redo subsystem (linear or restricted non-linear).
## Newest
- v0.3.2, security patch for github workflow; fix arch detections in dummy project - affect generating undo-cxx_config.hh
- v0.3.1, added `newest_item()` for #1
- v0.3.0, build passed for c++20
- v0.2.5, upgrade undo-log.hh, undo-util.hh, undo-zcore.hh, and cxx-macros.cmake
- v0.2.3, upgrade cmake scripts
- _v0.2.2_, fixes around the project files
- v0.2.1, first implementation of Undoable/Redoable
## Features
- Highly configurable/customizable
- Undo/Redo subsystem
- restricted non-linear undo (batch undo+erase+redo)
- todo: full-functional non-linear
- limitless undo/redo levels, or limited with `max_size(n)`
- Bundled with Command subsystem
- undoable/redoable
- Composite command (`undo_cxx::composite_cmd_t<>`): composite multi-commands as one (groupable)
- Composite memento (`undo_cxx::state_t<>`) for composite-command
## Examples
The following code is a part of a word-processor:
```cpp
#include
namespace dp { namespace undo { namespace test {
template
class FontStyleCmd : public undo_cxx::cmd_t {
public:
~FontStyleCmd() {}
FontStyleCmd() {}
FontStyleCmd(std::string const &default_state_info)
: _info(default_state_info) {}
UNDO_CXX_DEFINE_DEFAULT_CMD_TYPES(FontStyleCmd, undo_cxx::cmd_t);
protected:
void do_execute(CmdSP &sender, ContextT &) override {
UNUSED(sender);
// ... do sth to add/remove font style to/from
// current selection in current editor ...
std::cout << "<<" << _info << ">>" << '\n';
}
MementoPtr save_state_impl(CmdSP &sender, ContextT &) override {
return std::make_unique(sender, _info);
}
void undo_impl(CmdSP &sender, ContextT &, Memento &memento) override {
memento = _info;
memento.command(sender);
}
void redo_impl(CmdSP &sender, ContextT &, Memento &memento) override {
memento = _info;
memento.command(sender);
}
private:
std::string _info{"make italic"};
};
template
class UndoCmd : public undo_cxx::base_undo_cmd_t {
public:
~UndoCmd() {}
using undo_cxx::base_undo_cmd_t::base_undo_cmd_t;
UndoCmd(std::string const &default_state_info)
: _info(default_state_info) {}
UNDO_CXX_DEFINE_DEFAULT_CMD_TYPES(UndoCmd, undo_cxx::base_undo_cmd_t);
protected:
void do_execute(CmdSP &sender, ContextT &ctx) override {
std::cout << "<<" << _info << ">>" << '\n';
Base::do_execute(sender, ctx);
}
MementoPtr save_state_impl(CmdSP &sender, ContextT &) override {
return std::make_unique(sender, _info);
}
void undo_impl(CmdSP &sender, ContextT &, Memento &memento) override {
memento = "do 'undo'";
// auto sp = typename Memento::CmdSP(this);
memento.command(sender);
}
void redo_impl(CmdSP &sender, ContextT &, Memento &memento) override {
memento = "do 'un-undo' again";
memento.command(sender);
}
private:
std::string _info{"do 'undo'"};
};
template
class RedoCmd : public undo_cxx::base_redo_cmd_t {
public:
~RedoCmd() {}
using undo_cxx::base_redo_cmd_t::base_redo_cmd_t;
RedoCmd(std::string const &default_state_info)
: _info(default_state_info) {}
UNDO_CXX_DEFINE_DEFAULT_CMD_TYPES(RedoCmd, undo_cxx::base_redo_cmd_t);
protected:
void do_execute(CmdSP &sender, ContextT &ctx) override {
std::cout << "<<" << _info << ">>" << '\n';
Base::do_execute(sender, ctx);
}
MementoPtr save_state_impl(CmdSP &sender, ContextT &) override {
return std::make_unique(sender, _info);
}
void undo_impl(CmdSP &sender, ContextT &, Memento &memento) override {
memento = "do 'redo'";
memento.command(sender);
}
void redo_impl(CmdSP &sender, ContextT &, Memento &memento) override {
memento = "do 'un-redo' again";
memento.command(sender);
}
private:
std::string _info{"do 'redo'"};
};
}}} // namespace dp::undo::test
void test_undo_sys() {
using namespace dp::undo::test;
using namespace dp::undo::bugs;
using State = std::string;
using M = undo_cxx::undoable_cmd_system_t;
using UndoCmdT = UndoCmd;
using RedoCmdT = RedoCmd;
using FontStyleCmdT = FontStyleCmd;
M undoable_cmd_system;
// do some stuffs
undoable_cmd_system.invoke("italic state1");
undoable_cmd_system.invoke("italic-bold state2");
undoable_cmd_system.invoke("underline state3");
undoable_cmd_system.invoke("italic state4");
// and try to undo or redo
undoable_cmd_system.invoke("undo 1");
undoable_cmd_system.invoke("undo 2");
undoable_cmd_system.invoke("redo 1");
undoable_cmd_system.invoke("undo 3");
undoable_cmd_system.invoke("undo 4");
}
int main() {
test_undo_sys();
return 0;
}
```
## Build Options
### Build with CMake
> 1. gcc 10+: passed
> 2. clang 12+: passed
> 3. msvc build tool 16.7.2, 16.8.5 (VS2019 or Build Tool) passed
ninja is optional for faster building.
```bash
# configure
cmake -S . -B build/ -G Ninja
# build
cmake --build build/
# install
cmake --install build/
# Or:cmake --build build/ --target install
#
# Sometimes sudo it:
# sudo cmake --build build/ --target install
# Or manually:
# cmake --install build/ --prefix ./install --strip
# sudo cp -R ./install/include/* /usr/local/include/
# sudo cp -R ./install/lib/cmake/undo_cxx /usr/local/lib/cmake/
```
### Other CMake Options
1. `UNDO_CXX_BUILD_TESTS_EXAMPLES`=OFF
2. `UNDO_CXX_BUILD_DOCS`=OFF
3. ...
## Thanks to JODL
Thanks to [JetBrains](https://www.jetbrains.com/?from=undo-cxx) for donating product licenses to help develop **undo-cxx** [](https://www.jetbrains.com/?from=hedzr/undo-cxx)
## LICENSE
Apache 2.0