Source/WebCore/editing/UndoManager.cpp

/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"

#if ENABLE(UNDO_MANAGER)

#include "UndoManager.h"

#include "ExceptionCode.h"

namespace WebCore {

DOMTransaction* UndoManager::s_recordingDOMTransaction = 0;

PassRefPtr<UndoManager> UndoManager::create(Document* document)
{
    RefPtr<UndoManager> undoManager = adoptRef(new UndoManager(document));
    undoManager->suspendIfNeeded();
    return undoManager.release();
}

UndoManager::UndoManager(Document* document)
    : ActiveDOMObject(document, this)
    , m_document(document)
    , m_isInProgress(false)
{
}

static void clearStack(UndoManagerStack& stack)
{
    for (size_t i = 0; i < stack.size(); ++i) {
        const UndoManagerEntry& entry = *stack[i];
        for (size_t j = 0; j < entry.size(); ++j) {
            UndoStep* step = entry[j].get();
            if (step->isDOMTransaction())
                static_cast<DOMTransaction*>(step)->setUndoManager(0);
        }
    }
    stack.clear();
}

void UndoManager::disconnect()
{
    m_document = 0;
    clearStack(m_undoStack);
    clearStack(m_redoStack);
}

void UndoManager::stop()
{
    disconnect();
}

UndoManager::~UndoManager()
{
    disconnect();
}

static inline PassOwnPtr<UndoManagerEntry> createUndoManagerEntry()
{
    return adoptPtr(new UndoManagerEntry);
}

void UndoManager::transact(PassRefPtr<DOMTransaction> transaction, bool merge, ExceptionCode& ec)
{
    if (m_isInProgress || !m_document) {
        ec = INVALID_ACCESS_ERR;
        return;
    }
    clearRedo(ASSERT_NO_EXCEPTION);
    transaction->setUndoManager(this);

    m_isInProgress = true;
    RefPtr<UndoManager> protect(this);
    transaction->apply();
    m_isInProgress = false;

    if (!m_document)
        return;
    if (!merge || m_undoStack.isEmpty())
        m_undoStack.append(createUndoManagerEntry());
    m_undoStack.last()->append(transaction);
}

void UndoManager::undo(ExceptionCode& ec)
{
    if (m_isInProgress || !m_document) {
        ec = INVALID_ACCESS_ERR;
        return;
    }
    if (m_undoStack.isEmpty())
        return;
    m_inProgressEntry = createUndoManagerEntry();

    m_isInProgress = true;
    RefPtr<UndoManager> protect(this);
    UndoManagerEntry entry = *m_undoStack.last();
    for (size_t i = entry.size(); i > 0; --i)
        entry[i - 1]->unapply();
    m_isInProgress = false;

    if (!m_document) {
        m_inProgressEntry.clear();
        return;
    }
    m_redoStack.append(m_inProgressEntry.release());
    m_undoStack.removeLast();
}

void UndoManager::redo(ExceptionCode& ec)
{
    if (m_isInProgress || !m_document) {
        ec = INVALID_ACCESS_ERR;
        return;
    }
    if (m_redoStack.isEmpty())
        return;
    m_inProgressEntry = createUndoManagerEntry();

    m_isInProgress = true;
    RefPtr<UndoManager> protect(this);
    UndoManagerEntry entry = *m_redoStack.last();
    for (size_t i = entry.size(); i > 0; --i)
        entry[i - 1]->reapply();
    m_isInProgress = false;

    if (!m_document) {
        m_inProgressEntry.clear();
        return;
    }
    m_undoStack.append(m_inProgressEntry.release());
    m_redoStack.removeLast();
}

UndoManagerEntry UndoManager::item(unsigned index) const
{
    ASSERT(index < length());
    if (index < m_redoStack.size()) {
        UndoManagerEntry entry = *m_redoStack[index];
        entry.reverse();
        return entry;
    }
    return *m_undoStack[length() - index - 1];
}

void UndoManager::registerUndoStep(PassRefPtr<UndoStep> step)
{
    if (!m_isInProgress) {
        OwnPtr<UndoManagerEntry> entry = createUndoManagerEntry();
        entry->append(step);
        m_undoStack.append(entry.release());

        clearRedo(ASSERT_NO_EXCEPTION);
    } else
        m_inProgressEntry->append(step);
}

void UndoManager::registerRedoStep(PassRefPtr<UndoStep> step)
{
    if (!m_isInProgress) {
        OwnPtr<UndoManagerEntry> entry = createUndoManagerEntry();
        entry->append(step);
        m_redoStack.append(entry.release());
    } else
        m_inProgressEntry->append(step);
}

void UndoManager::clearUndo(ExceptionCode& ec)
{
    if (m_isInProgress || !m_document) {
        ec = INVALID_ACCESS_ERR;
        return;
    }
    clearStack(m_undoStack);
}

void UndoManager::clearRedo(ExceptionCode& ec)
{
    if (m_isInProgress || !m_document) {
        ec = INVALID_ACCESS_ERR;
        return;
    }
    clearStack(m_redoStack);
}

bool UndoManager::isRecordingAutomaticTransaction(Node* node)
{
    // We need to check that transaction still has its undomanager because
    // transaction can disconnect its undomanager, which will clear the undo/redo stacks.
    if (!s_recordingDOMTransaction || !s_recordingDOMTransaction->undoManager())
        return false;
    Document* document = s_recordingDOMTransaction->undoManager()->document();
    return document && node->document() == document;
}

void UndoManager::addTransactionStep(PassRefPtr<DOMTransactionStep> step)
{
    ASSERT(s_recordingDOMTransaction);
    s_recordingDOMTransaction->addTransactionStep(step);
}

}

#endif