EventsFunctionsContainer.h

/*
 * GDevelop Core
 * Copyright 2008-present Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
#pragma once
 
#include <vector>
#include "GDCore/Project/EventsFunction.h"
#include "GDCore/Project/FunctionFolderOrFunction.h"
#include "GDCore/String.h"
#include "GDCore/Tools/SerializableWithNameList.h"
namespace gd {
class SerializerElement;
}
 
namespace gd {
 
class GD_CORE_API EventsFunctionsContainer
    : private SerializableWithNameList<gd::EventsFunction> {
public:
  enum FunctionOwner {
      Extension,
      Object,
      Behavior};
 
  EventsFunctionsContainer(FunctionOwner source_) : owner(source_) {
    // The properties folders are not copied.
    // It's not an issue because the UI uses the serialization for duplication.
    rootFolder = gd::make_unique<gd::FunctionFolderOrFunction>("__ROOT");
  }
 
  EventsFunctionsContainer(const EventsFunctionsContainer &other)
      : owner(other.owner) {
    Init(other);
  }
 
  EventsFunctionsContainer &operator=(const EventsFunctionsContainer &other) {
    if (this != &other) {
      owner = other.owner;
      Init(other);
    }
 
    return *this;
  }
 
  FunctionOwner GetOwner() const {
    return owner;
  }
 
 
  bool HasEventsFunctionNamed(const gd::String& name) const {
    return Has(name);
  }
 
  gd::EventsFunction& GetEventsFunction(const gd::String& name) {
    return Get(name);
  }
 
  const gd::EventsFunction& GetEventsFunction(const gd::String& name) const {
    return Get(name);
  }
 
  gd::EventsFunction& GetEventsFunction(std::size_t index) {
    return Get(index);
  }
 
  const gd::EventsFunction& GetEventsFunction(std::size_t index) const {
    return Get(index);
  }
 
  std::size_t GetEventsFunctionsCount() const { return GetCount(); }
 
  gd::EventsFunction &InsertNewEventsFunction(const gd::String &name,
                                              std::size_t position) {
    auto &newlyCreatedFunction = InsertNew(name, position);
    rootFolder->InsertFunction(&newlyCreatedFunction);
    return newlyCreatedFunction;
  }
 
  gd::EventsFunction &
  InsertEventsFunction(const gd::EventsFunction &eventFunction,
                       std::size_t position) {
    auto &newlyCreatedFunction = Insert(eventFunction, position);
    rootFolder->InsertFunction(&newlyCreatedFunction);
    return newlyCreatedFunction;
  }
 
  void RemoveEventsFunction(const gd::String& name) {
    rootFolder->RemoveRecursivelyFunctionNamed(name);
    return Remove(name);
  }
  void ClearEventsFunctions() { return Clear(); }
  void MoveEventsFunction(std::size_t oldIndex, std::size_t newIndex) {
    return Move(oldIndex, newIndex);
  };
  std::size_t GetEventsFunctionPosition(const gd::EventsFunction& eventsFunction) {
    return GetPosition(eventsFunction);
  };
 
  const std::vector<std::unique_ptr<gd::EventsFunction>>& GetInternalVector()
      const {
    return elements;
  };
 
  std::vector<std::unique_ptr<gd::EventsFunction>>& GetInternalVector() {
    return elements;
  };
 
 
  gd::EventsFunction &InsertNewEventsFunctionInFolder(
      const gd::String &name,
      gd::FunctionFolderOrFunction &functionFolderOrFunction,
      std::size_t position);
 
  std::vector<const FunctionFolderOrFunction *>
  GetAllFunctionFolderOrFunction() const;
 
  gd::FunctionFolderOrFunction &GetRootFolder() { return *rootFolder; }
 
  void AddMissingFunctionsInRootFolder();
 
  void SerializeFoldersTo(SerializerElement &element) const;
 
  void UnserializeFoldersFrom(const SerializerElement &element);
 
 
  void SerializeEventsFunctionsTo(SerializerElement& element) const {
    return SerializeElementsTo("eventsFunction", element);
  };
 
  void UnserializeEventsFunctionsFrom(gd::Project& project,
                                      const SerializerElement& element) {
    return UnserializeElementsFrom("eventsFunction", project, element);
  };
 protected:
  void Init(const gd::EventsFunctionsContainer& other) {
    // The properties folders are not copied.
    // It's not an issue because the UI uses the serialization for duplication.
    rootFolder = gd::make_unique<gd::FunctionFolderOrFunction>("__ROOT");
    SerializableWithNameList<gd::EventsFunction>::Init(other);
  };
 
private:
  FunctionOwner owner;
  std::unique_ptr<gd::FunctionFolderOrFunction> rootFolder;
};
 
}  // namespace gd