GDevelop/Core/GDCore/Project/PropertyDescriptor.cpp

/*
 * GDevelop Core
 * Copyright 2008-present Florian Rival (Florian.Rival@gmail.com). All rights
 * reserved. This project is released under the MIT License.
 */
#include "PropertyDescriptor.h"

#include <vector>

#include "GDCore/Serialization/SerializerElement.h"
#include "GDCore/String.h"

namespace gd {

PropertyDescriptor::~PropertyDescriptor() {}

void PropertyDescriptor::SerializeTo(SerializerElement& element) const {
  element.AddChild("value").SetStringValue(currentValue);
  element.AddChild("type").SetStringValue(type);
  if (type == "Number" && !measurementUnit.IsUndefined()) {
    element.AddChild("unit").SetStringValue(measurementUnit.GetName());
  }
  element.AddChild("label").SetStringValue(label);
  if (!description.empty())
    element.AddChild("description").SetStringValue(description);
  if (!group.empty()) element.AddChild("group").SetStringValue(group);

  if (!extraInformation.empty()) {
    SerializerElement& extraInformationElement =
        element.AddChild("extraInformation");
    extraInformationElement.ConsiderAsArray();
    for (const gd::String& information : extraInformation) {
      extraInformationElement.AddChild("").SetStringValue(information);
    }
  }

  if (!choices.empty()
      // Compatibility with GD <= 5.5.239
      || !extraInformation.empty()
      // end of compatibility code
  ) {
    SerializerElement &choicesElement = element.AddChild("choices");
    choicesElement.ConsiderAsArrayOf("choice");
    for (const auto &choice : choices) {
      auto &choiceElement = choicesElement.AddChild("Choice");
      choiceElement.SetStringAttribute("value", choice.GetValue());
      choiceElement.SetStringAttribute("label", choice.GetLabel());
    }
  }

  if (hidden) {
    element.AddChild("hidden").SetBoolValue(hidden);
  }
  if (deprecated) {
    element.AddChild("deprecated").SetBoolValue(deprecated);
  }
  if (advanced) {
    element.AddChild("advanced").SetBoolValue(advanced);
  }
  if (quickCustomizationVisibility != QuickCustomization::Visibility::Default) {
    element.AddChild("quickCustomizationVisibility")
        .SetStringValue(quickCustomizationVisibility ==
                                QuickCustomization::Visibility::Visible
                            ? "visible"
                            : "hidden");
  }
}

void PropertyDescriptor::UnserializeFrom(const SerializerElement& element) {
  currentValue = element.GetChild("value").GetStringValue();
  type = element.GetChild("type").GetStringValue();
  if (type == "Number") {
    gd::String unitName = element.GetChild("unit").GetStringValue();
    measurementUnit =
        gd::MeasurementUnit::HasDefaultMeasurementUnitNamed(unitName)
            ? measurementUnit =
                  gd::MeasurementUnit::GetDefaultMeasurementUnitByName(unitName)
            : gd::MeasurementUnit::GetUndefined();
  }
  label = element.GetChild("label").GetStringValue();
  description = element.HasChild("description")
                    ? element.GetChild("description").GetStringValue()
                    : "";
  group = element.HasChild("group") ? element.GetChild("group").GetStringValue()
                                    : "";

  extraInformation.clear();
  if (element.HasChild("extraInformation")) {
    const SerializerElement& extraInformationElement =
        element.GetChild("extraInformation");
    extraInformationElement.ConsiderAsArray();
    for (std::size_t i = 0; i < extraInformationElement.GetChildrenCount(); ++i)
      extraInformation.push_back(
          extraInformationElement.GetChild(i).GetStringValue());
  }

  if (element.HasChild("choices")) {
    choices.clear();
    const SerializerElement &choicesElement = element.GetChild("choices");
    choicesElement.ConsiderAsArrayOf("choice");
    for (std::size_t i = 0; i < choicesElement.GetChildrenCount(); ++i) {
      auto &choiceElement = choicesElement.GetChild(i);
      AddChoice(choiceElement.GetStringAttribute("value"),
                choiceElement.GetStringAttribute("label"));
    }
  }
  // Compatibility with GD <= 5.5.239
  else if (type == "Choice") {
    choices.clear();
    for (auto &choiceValue : extraInformation) {
      AddChoice(choiceValue, choiceValue);
    }
    extraInformation.clear();
  }
  // end of compatibility code

  hidden = element.HasChild("hidden")
               ? element.GetChild("hidden").GetBoolValue()
               : false;
  deprecated = element.HasChild("deprecated")
                   ? element.GetChild("deprecated").GetBoolValue()
                   : false;
  advanced = element.HasChild("advanced")
                 ? element.GetChild("advanced").GetBoolValue()
                 : false;

  if (element.HasChild("quickCustomizationVisibility")) {
    quickCustomizationVisibility =
        element.GetChild("quickCustomizationVisibility").GetStringValue() ==
                "visible"
            ? QuickCustomization::Visibility::Visible
            : QuickCustomization::Visibility::Hidden;
  } else {
    quickCustomizationVisibility = QuickCustomization::Visibility::Default;
  }
}

void PropertyDescriptor::SerializeValuesTo(SerializerElement& element) const {
  element.AddChild("value").SetStringValue(currentValue);
  SerializerElement& extraInformationElement =
      element.AddChild("extraInformation");
  extraInformationElement.ConsiderAsArray();
  for (const gd::String& information : extraInformation) {
    extraInformationElement.AddChild("").SetStringValue(information);
  }
}

void PropertyDescriptor::UnserializeValuesFrom(
    const SerializerElement& element) {
  currentValue = element.GetChild("value").GetStringValue();

  extraInformation.clear();
  const SerializerElement& extraInformationElement =
      element.GetChild("extraInformation");
  extraInformationElement.ConsiderAsArray();
  for (std::size_t i = 0; i < extraInformationElement.GetChildrenCount(); ++i)
    extraInformation.push_back(
        extraInformationElement.GetChild(i).GetStringValue());
}

}  // namespace gd