ResInsight/Fwk/AppFwk/cafCommand/cafCmdFieldChangeExec.cpp

//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2013 Ceetron AS
//
//   This library may be used under the terms of either the GNU General Public License or
//   the GNU Lesser General Public License as follows:
//
//   GNU General Public License Usage
//   This library is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
//   This library is distributed in the hope that it will be useful, but WITHOUT ANY
//   WARRANTY; without even the implied warranty of MERCHANTABILITY or
//   FITNESS FOR A PARTICULAR PURPOSE.
//
//   See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
//   for more details.
//
//   GNU Lesser General Public License Usage
//   This library is free software; you can redistribute it and/or modify
//   it under the terms of the GNU Lesser General Public License as published by
//   the Free Software Foundation; either version 2.1 of the License, or
//   (at your option) any later version.
//
//   This library is distributed in the hope that it will be useful, but WITHOUT ANY
//   WARRANTY; without even the implied warranty of MERCHANTABILITY or
//   FITNESS FOR A PARTICULAR PURPOSE.
//
//   See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//   for more details.
//
//##################################################################################################


#include "cafCmdFieldChangeExec.h"

#include "cafPdmReferenceHelper.h"
#include "cafNotificationCenter.h"


namespace caf
{

CAF_PDM_SOURCE_INIT(CmdFieldChangeExecData, "CmdFieldChangeExecData");


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
QString CmdFieldChangeExec::name()
{
    PdmFieldHandle* field = PdmReferenceHelper::fieldFromReference(m_commandData->m_rootObject, m_commandData->m_pathToField);
    if (field)
    {
        QString fieldText;

        PdmUiFieldHandle* uiFieldHandle = field->uiCapability();
        if (uiFieldHandle)
        {
            fieldText = QString("Change field '%1'").arg(uiFieldHandle->uiName());
        }

        if (field->ownerObject())
        {
            PdmUiObjectHandle* uiObjHandle = uiObj(field->ownerObject());
            if (uiObjHandle)
            {
                fieldText += QString(" in '%1'").arg(uiObjHandle->uiName());
            }
        }
        return fieldText;
    }
    else
    {
        return m_commandData->classKeyword();
    }
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void CmdFieldChangeExec::redo()
{
    PdmFieldHandle* field = PdmReferenceHelper::fieldFromReference(m_commandData->m_rootObject, m_commandData->m_pathToField);
    if (!field)
    {
        CAF_ASSERT(false);
        return;
    }

    PdmUiFieldHandle* uiFieldHandle = field->uiCapability();
    PdmXmlFieldHandle* xmlFieldHandle = field->xmlCapability();
    if (uiFieldHandle && xmlFieldHandle)
    {
        if (m_commandData->m_redoFieldValueSerialized.isEmpty())
        {
            // We end up here only when the user actually has done something in the actual living Gui editor.
            {
                QXmlStreamWriter xmlStream(&m_commandData->m_undoFieldValueSerialized);
                writeFieldDataToValidXmlDocument(xmlStream, xmlFieldHandle);
            }

            // This function will notify field change, no need to explicitly call notification
            // The ui value might be an index into the option entry cache, so we need to set the value 
            // and be aware of the option entries, and then serialize the actual field value we ended up with.

            uiFieldHandle->setValueFromUiEditor(m_commandData->m_newUiValue);

            {
                QXmlStreamWriter xmlStream(&m_commandData->m_redoFieldValueSerialized);
                writeFieldDataToValidXmlDocument(xmlStream, xmlFieldHandle);
            }
        }
        else
        {
            QVariant oldFieldData = uiFieldHandle->toUiBasedQVariant();

            QXmlStreamReader xmlStream(m_commandData->m_redoFieldValueSerialized);

            readFieldValueFromValidXmlDocument(xmlStream, xmlFieldHandle);

            QVariant newFieldData = uiFieldHandle->toUiBasedQVariant();

            // New data is present in field, notify data changed
            uiFieldHandle->notifyFieldChanged(oldFieldData, newFieldData);
        }
    }

    if (m_notificationCenter) m_notificationCenter->notifyObserversOfDataChange(field->ownerObject());
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void CmdFieldChangeExec::undo()
{
    PdmFieldHandle* field = PdmReferenceHelper::fieldFromReference(m_commandData->m_rootObject, m_commandData->m_pathToField);
    if (!field)
    {
        CAF_ASSERT(false);
        return;
    }

    PdmUiFieldHandle* uiFieldHandle = field->uiCapability();
    PdmXmlFieldHandle* xmlFieldHandle = field->xmlCapability();
    if (uiFieldHandle && xmlFieldHandle)
    {
        QXmlStreamReader xmlStream(m_commandData->m_undoFieldValueSerialized);
        QVariant oldFieldData = uiFieldHandle->toUiBasedQVariant();

        readFieldValueFromValidXmlDocument(xmlStream, xmlFieldHandle);

        QVariant newFieldData = uiFieldHandle->toUiBasedQVariant();

        // New data is present in field, notify data changed
        uiFieldHandle->notifyFieldChanged(oldFieldData, newFieldData);
    }

    if (m_notificationCenter) m_notificationCenter->notifyObserversOfDataChange(field->ownerObject());
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
CmdFieldChangeExec::CmdFieldChangeExec(NotificationCenter* notificationCenter)
    : CmdExecuteCommand(notificationCenter)
{
    m_commandData = new CmdFieldChangeExecData;
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
CmdFieldChangeExec::~CmdFieldChangeExec()
{

}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
CmdFieldChangeExecData* CmdFieldChangeExec::commandData()
{
    return m_commandData;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void CmdFieldChangeExec::writeFieldDataToValidXmlDocument(QXmlStreamWriter &xmlStream, PdmXmlFieldHandle* xmlFieldHandle)
{
    xmlStream.setAutoFormatting(true);
    xmlStream.writeStartDocument();
    xmlStream.writeStartElement("", "d");
    xmlFieldHandle->writeFieldData(xmlStream);
    xmlStream.writeEndElement();
    xmlStream.writeEndDocument();
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void CmdFieldChangeExec::readFieldValueFromValidXmlDocument(QXmlStreamReader &xmlStream, PdmXmlFieldHandle* xmlFieldHandle)
{
    // See PdmObject::readFields and friends to match token count for reading field values
    // The stream is supposed to be pointing at the first token of field content when calling readFieldData()
    QXmlStreamReader::TokenType tt;
    int tokenCount = 3;
    for (int i = 0; i < tokenCount; i++)
    {
        tt = xmlStream.readNext();
    }
    xmlFieldHandle->readFieldData(xmlStream, PdmDefaultObjectFactory::instance());
}

} // end namespace caf