ImHex/lib/libimhex/source/providers/undo/stack.cpp

#include <hex/providers/undo_redo/stack.hpp>
#include <hex/providers/undo_redo/operations/operation_group.hpp>

#include <hex/providers/provider.hpp>

#include <wolv/utils/guards.hpp>


namespace hex::prv::undo {

    namespace {

        std::atomic_bool s_locked;
        std::mutex s_mutex;

    }

    Stack::Stack(Provider *provider) : m_provider(provider) {

    }


    void Stack::undo(u32 count) {
        std::scoped_lock lock(s_mutex);

        s_locked = true;
        ON_SCOPE_EXIT { s_locked = false; };

        // If there are no operations, we can't undo anything.
        if (this->m_undoStack.empty())
            return;

        for (u32 i = 0; i < count; i += 1) {
            // If we reached the start of the list, we can't undo anymore.
            if (!this->canUndo()) {
                return;
            }

            // Move last element from the undo stack to the redo stack
            this->m_redoStack.emplace_back(std::move(this->m_undoStack.back()));
            this->m_redoStack.back()->undo(this->m_provider);
            this->m_undoStack.pop_back();
        }
    }

    void Stack::redo(u32 count) {
        std::scoped_lock lock(s_mutex);

        s_locked = true;
        ON_SCOPE_EXIT { s_locked = false; };

        // If there are no operations, we can't redo anything.
        if (this->m_redoStack.empty())
            return;

        for (u32 i = 0; i < count; i += 1) {
            // If we reached the end of the list, we can't redo anymore.
            if (!this->canRedo()) {
                return;
            }

            // Move last element from the undo stack to the redo stack
            this->m_undoStack.emplace_back(std::move(this->m_redoStack.back()));
            this->m_undoStack.back()->redo(this->m_provider);
            this->m_redoStack.pop_back();
        }
    }

    void Stack::groupOperations(u32 count, const std::string &unlocalizedName) {
        if (count <= 1)
            return;

        auto operation = std::make_unique<OperationGroup>(unlocalizedName);

        i64 startIndex = std::max<i64>(0, this->m_undoStack.size() - count);

        // Move operations from our stack to the group in the same order they were added
        for (u32 i = 0; i < count; i += 1) {
            i64 index = startIndex + i;

            operation->addOperation(std::move(this->m_undoStack[index]));
        }

        // Remove the empty operations from the stack
        this->m_undoStack.resize(startIndex);
        this->add(std::move(operation));
    }

    void Stack::apply(const Stack &otherStack) {
        for (const auto &operation : otherStack.m_undoStack) {
            this->add(operation->clone());
        }
    }



    bool Stack::add(std::unique_ptr<Operation> &&operation) {
        // If we're already inside of an undo/redo operation, ignore new operations being added
        if (s_locked)
            return false;

        s_locked = true;
        ON_SCOPE_EXIT { s_locked = false; };

        std::scoped_lock lock(s_mutex);

        // Clear the redo stack
        this->m_redoStack.clear();

        // Insert the new operation at the end of the list
        this->m_undoStack.emplace_back(std::move(operation));

        // Do the operation
        this->getLastOperation()->redo(this->m_provider);

        return true;
    }

    bool Stack::canUndo() const {
        return !this->m_undoStack.empty();
    }

    bool Stack::canRedo() const {
        return !this->m_redoStack.empty();
    }





}