o3de/Code/Sandbox/Plugins/EditorCommon/QPropertyTree/PropertyOArchive.cpp

/**
 *  wWidgets - Lightweight UI Toolkit.
 *  Copyright (C) 2009-2011 Evgeny Andreeshchev <eugene.andreeshchev@gmail.com>
 *                          Alexander Kotliar <alexander.kotliar@gmail.com>
 * 
 *  This code is distributed under the MIT License:
 *                          http://www.opensource.org/licenses/MIT
 */

// Modifications copyright Amazon.com, Inc. or its affiliates.

#include "EditorCommon_precompiled.h"
#include <math.h>
#include <memory>

#include "PropertyTreeModel.h"
#include "QPropertyTree.h"

#include "PropertyRowContainer.h"
#include "PropertyRowBool.h"
#include "PropertyRowString.h"
#include "PropertyRowNumber.h"
#include "PropertyRowPointer.h"
#include "PropertyRowObject.h"
#include "ConstStringList.h"
#include "Unicode.h"

#include "Serialization.h"
#include "PropertyOArchive.h"
#include "Serialization/Callback.h"
using Serialization::TypeID;


PropertyOArchive::PropertyOArchive(PropertyTreeModel* model, PropertyRow* root, ValidatorBlock* validator)
: IArchive(OUTPUT | EDIT | VALIDATION | DOCUMENTATION)
, model_(model)
, currentNode_(root)
, lastNode_(0)
, updateMode_(false)
, defaultValueCreationMode_(false)
, rootNode_(root)
, outlineMode_(false)
, validator_(validator)
{
    stack_.push_back(Level());
    YASLI_ASSERT(model != 0);
    if(!rootNode_->empty()){
        updateMode_ = true;
        stack_.back().oldRows.swap(rootNode_->children_);
    }
}



PropertyOArchive::PropertyOArchive(PropertyTreeModel* model, bool forDefaultType)
: IArchive(OUTPUT | EDIT | VALIDATION | DOCUMENTATION)
, model_(model)
, currentNode_(0)
, lastNode_(0)
, updateMode_(false)
, defaultValueCreationMode_(forDefaultType)
, rootNode_(0)
, outlineMode_(false)
, validator_(0)
{
    rootNode_ = new PropertyRow();
    rootNode_->setName("root");
    currentNode_ = rootNode_.get();
    stack_.push_back(Level());
}

PropertyOArchive::~PropertyOArchive()
{
}

PropertyRow* PropertyOArchive::defaultValueRootNode()
{
    if (!rootNode_)
        return 0;
    return rootNode_->childByIndex(0);
}

void PropertyOArchive::enterNode(PropertyRow* row)
{
    currentNode_ = row;

    stack_.push_back(Level());
    Level& level = stack_.back();
    level.oldRows.swap(row->children_);
    row->children_.reserve(level.oldRows.size());
}

void PropertyOArchive::closeStruct([[maybe_unused]] const char* name)
{
    stack_.pop_back();

    if(currentNode_){
        lastNode_ = currentNode_;
        currentNode_ = currentNode_->parent();
    }
}

static PropertyRow* findRow(int* index, PropertyRows& rows, const char* name, const char* typeName, int startIndex)
{
    int count = int(rows.size());
    for(int i = startIndex; i < count; ++i){
        PropertyRow* row = rows[i];
        if (!row)
            continue;
        if(((row->name() == name) || strcmp(row->name(), name) == 0) &&
           (row->typeName() == typeName || strcmp(row->typeName(), typeName) == 0)) {
            *index = (int)i;
            return row;
        }
    }
    for(int i = 0; i < startIndex; ++i){
        PropertyRow* row = rows[i];
        if (!row)
            continue;
        if(((row->name() == name) || strcmp(row->name(), name) == 0) &&
           (row->typeName() == typeName || strcmp(row->typeName(), typeName) == 0)) {
            *index = (int)i;
            return row;
        }
    }
    return 0;
}

template<class RowType, class ValueType>
RowType* PropertyOArchive::updateRow(const char* name, const char* label, const char* typeName, const ValueType& value)
{
    SharedPtr<RowType> newRow;
    if(currentNode_ == 0){
        if (rootNode_)
            newRow = static_cast<RowType*>(rootNode_.get());
        else
            newRow.reset(new RowType());
        newRow->setNames(name, label, typeName);
        if(updateMode_){
            model_->setRoot(newRow);
            return newRow;
        }
        else{
            if(defaultValueCreationMode_)
                rootNode_ = newRow;
            else
                model_->setRoot(newRow);
            newRow->setValueAndContext(value, *this);
            return newRow;
        }
    }
    else{

        Level& level = stack_.back();
        int rowIndex;
        PropertyRow* oldRow = findRow(&rowIndex, level.oldRows, name, typeName, level.rowIndex);

        const char* oldLabel = 0;
        if(oldRow){
            oldRow->setMultiValue(false);
            newRow = static_cast<RowType*>(oldRow);
            level.oldRows[rowIndex] = 0;
            level.rowIndex = rowIndex + 1;
            oldLabel = oldRow->label();
            newRow->setNames(name, label, typeName);
        }
        else{
            PropertyRowFactory& factory = PropertyRowFactory::the();
            newRow = static_cast<RowType*>(factory.create(typeName));
            if(!newRow)
                newRow.reset(new RowType());
            newRow->setNames(name, label, typeName);
            if(model_->expandLevels() != 0 && (model_->expandLevels() == -1 || model_->expandLevels() >= currentNode_->level()))
                newRow->_setExpanded(true);
        }
        currentNode_->add(newRow);
        if (!oldRow || oldLabel != label) {
            // for new rows we should mark all parents with labelChanged_
            newRow->setLabelChanged();
            newRow->setLabelChangedToChildren();
        }
        newRow->setValueAndContext(value, *this);
        return newRow;
    }
}

template<class RowType, class ValueType>
PropertyRow* PropertyOArchive::updateRowPrimitive(const char* name, const char* label, const char* typeName, const ValueType& value, const void* handle, const Serialization::TypeID& typeId)
{
    SharedPtr<RowType> newRow;

    if(currentNode_ == 0)
        return 0;

    int rowIndex;
    Level& level = stack_.back();
    PropertyRow* oldRow = findRow(&rowIndex, level.oldRows, name, typeName, level.rowIndex);

    const char* oldLabel = 0;
    if(oldRow){
        oldRow->setMultiValue(false);
        newRow.reset(static_cast<RowType*>(oldRow));
        level.oldRows[rowIndex] = 0;
        level.rowIndex = rowIndex + 1;
        oldLabel = oldRow->label();
        oldRow->setNames(name, label, typeName);
    }
    else{
        newRow = new RowType();
        newRow->setNames(name, label, typeName);
        if(model_->expandLevels() != 0){
            if(model_->expandLevels() == -1 || model_->expandLevels() >= currentNode_->level())
                newRow->_setExpanded(true);
        }
    }
    currentNode_->add(newRow);
    if (!oldRow || oldLabel != label)
    {
        // for new rows we should mark all parents with labelChanged_
        newRow->setLabelChanged();
    }

    newRow->setValue(value, handle, typeId);
    return newRow;
}

bool PropertyOArchive::operator()(const Serialization::SStruct& ser, const char* name, const char* label)
{
    const char* typeName = ser.type().name();

    lastNode_ = currentNode_;
    bool hideChildren = outlineMode_ && currentNode_ && currentNode_->isContainer();
    PropertyRow* row = updateRow<PropertyRow>(name, label, typeName, ser);
    row->setHideChildren(hideChildren);

    PropertyRow* nonLeaf = 0;
    if(!row->isLeaf() || currentNode_ == 0){
        enterNode(row);

        if(currentNode_->isLeaf())
            return false;
        else
            nonLeaf = currentNode_;
    }
    else{
        lastNode_ = row;
        return true;
    }

    if (ser)
        ser(*this);

    if (nonLeaf)
        nonLeaf->closeNonLeaf(ser, *this);

    closeStruct(name);
    return true;
}

bool PropertyOArchive::operator()(Serialization::IString& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowString>(name, label, "string", value.get(), value.handle(), value.type());
    return true;
}

bool PropertyOArchive::operator()(Serialization::IWString& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowString>(name, label, "string", value.get(), value.handle(), value.type());
    return true;
}

bool PropertyOArchive::operator()(bool& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowBool>(name, label, "bool", value, &value, Serialization::TypeID::get<bool>());
    return true;
}

bool PropertyOArchive::operator()(char& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<char> >(name, label, "char", value, &value, Serialization::TypeID::get<char>());
    return true;
}

// ---

bool PropertyOArchive::operator()(int8& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<int8> >(name, label, "int8", value, &value, Serialization::TypeID::get<int8>());
    return true;
}

bool PropertyOArchive::operator()(int16& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<int16> >(name, label, "int16", value, &value, Serialization::TypeID::get<int16>());
    return true;
}

bool PropertyOArchive::operator()(int32& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<int32> >(name, label, "int32", value, &value, Serialization::TypeID::get<int32>());
    return true;
}

bool PropertyOArchive::operator()(int64& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<int64> >(name, label, "int64", value, &value, Serialization::TypeID::get<int64>());
    return true;
}

// ---

bool PropertyOArchive::operator()(uint8& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<uint8> >(name, label, "uint8", value, &value, Serialization::TypeID::get<uint8>());
    return true;
}

bool PropertyOArchive::operator()(uint16& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<uint16> >(name, label, "uint16", value, &value, Serialization::TypeID::get<uint16>());
    return true;
}

bool PropertyOArchive::operator()(uint32& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<uint32> >(name, label, "uint32", value, &value, Serialization::TypeID::get<uint32>());
    return true;
}

bool PropertyOArchive::operator()(uint64& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<uint64> >(name, label, "uint64", value, &value, Serialization::TypeID::get<uint64>());
    return true;
}

// ---

bool PropertyOArchive::operator()(float& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<float> >(name, label, "float", value, &value, Serialization::TypeID::get<float>());
    return true;
}

bool PropertyOArchive::operator()(double& value, const char* name, const char* label)
{
    lastNode_ = updateRowPrimitive<PropertyRowNumber<double> >(name, label, "double", value, &value, Serialization::TypeID::get<double>());
    return true;
}


bool PropertyOArchive::operator()(Serialization::IContainer& ser, const char *name, const char *label)
{
    const char* elementTypeName = ser.elementType().name();
    enterNode(updateRow<PropertyRowContainer>(name, label, ser.containerType().name(), ser));

    if (!model_->defaultTypeRegistered(elementTypeName)) {
        PropertyOArchive ar(model_, true);
        ar.SetOutlineMode(outlineMode_);
        ar.SetFilter(GetFilter());
        ar.SetInnerContext(GetInnerContext());
        model_->addDefaultType(0, elementTypeName); // add empty default to prevent recursion
        ser.serializeNewElement(ar, "", (label&&*label=='!')?"!<":"<");
        if (ar.defaultValueRootNode() != 0)
            model_->addDefaultType(ar.defaultValueRootNode(), elementTypeName);
    }
    if ( ser.size() > 0 )
        while( true ) {
            ser(*this, "", (label&&*label=='!')?"!<":"<");
            if ( !ser.next() )
                break;
        }
    currentNode_->labelChanged();
    closeStruct(name);
    return true;
}

bool PropertyOArchive::operator()(Serialization::IPointer& ptr, const char *name, const char *label)
{
    lastNode_ = currentNode_;

    bool hideChildren = outlineMode_ && currentNode_ && currentNode_->isContainer();
    PropertyRow* row = updateRow<PropertyRowPointer>(name, label, ptr.baseType().name(), ptr);
    row->setHideChildren(hideChildren);
    enterNode(row);
    {
        TypeID baseType = ptr.baseType();
        Serialization::IClassFactory* factory = ptr.factory();
        size_t count = factory->size();

        const char* nullLabel = factory->nullLabel();
        if (!(nullLabel && nullLabel[0] == '\0'))
        {
            PropertyDefaultDerivedTypeValue nullValue;
            nullValue.factory = factory;
            nullValue.factoryIndex = -1;
            nullValue.label = nullLabel ? nullLabel : "[ null ]";
            model_->addDefaultType(baseType, nullValue);
        }

        for(size_t i = 0; i < count; ++i) {
            const Serialization::TypeDescription *desc = factory->descriptionByIndex((int)i);
            if (!model_->defaultTypeRegistered(baseType, desc->name())){
                PropertyOArchive ar(model_, true);
                ar.SetOutlineMode(outlineMode_);
                ar.SetInnerContext(GetInnerContext());
                ar.SetFilter(GetFilter());

                PropertyDefaultDerivedTypeValue defaultValue;
                defaultValue.registeredName = desc->name();
                defaultValue.factory = factory;
                defaultValue.factoryIndex = int(i);
                defaultValue.label = desc->label();

                model_->addDefaultType(baseType, defaultValue);
                factory->serializeNewByIndex(ar, (int)i, "name", "label");
                if (ar.defaultValueRootNode() != 0) {
                    ar.defaultValueRootNode()->setTypeName(desc->name());
                    defaultValue.root = ar.defaultValueRootNode();
                    model_->addDefaultType(baseType, defaultValue);
                }
            }
        }
    }

    if(Serialization::SStruct ser = ptr.serializer())
        ser(*this);
    closeStruct(name);
    return true;
}

bool PropertyOArchive::operator()(Serialization::ICallback& callback, const char* name, const char* label)
{
    if (!callback.SerializeValue(*this, name, label))
        return false;

    lastNode_->setCallback(callback.Clone());
    return true;
}

bool PropertyOArchive::operator()(Serialization::Object& obj, const char *name, const char *label)
{
    PropertyRowObject* row = 0;
    row = updateRow<PropertyRowObject>(name, label, obj.type().name(), obj);

    lastNode_ = row;
    return true;
}

bool PropertyOArchive::OpenBlock(const char* name, const char* label)
{
    PropertyRow* row = updateRow<PropertyRow>(name, label, "block", Serialization::SStruct());
    lastNode_ = currentNode_;
    enterNode(row);
    return true;
}

void PropertyOArchive::ValidatorMessage(bool error, const void* handle, const Serialization::TypeID& type, const char* message)
{
    if (validator_)
    {
        ValidatorEntry entry(error ? VALIDATOR_ENTRY_ERROR : VALIDATOR_ENTRY_WARNING,
                             handle,
                             type,
                             message);
        validator_->AddEntry(entry);
    }
}

void PropertyOArchive::DocumentLastField(const char* message)
{
    if (lastNode_ && (!currentNode_ || lastNode_->parent() == currentNode_))
        lastNode_->setTooltip(message ? message : "");
    else if (currentNode_)
        currentNode_->setTooltip(message ? message : "");
}

void PropertyOArchive::CloseBlock()
{
    closeStruct("block");
}

void PropertyOArchive::SetOutlineMode(bool outlineMode)
{
    outlineMode_ = outlineMode;
}

// vim:ts=4 sw=4: