FunctionFolderOrFunction.h

/*
 * GDevelop Core
 * Copyright 2008-2023 Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
#pragma once
 
#include <memory>
#include <vector>
 
#include "GDCore/Serialization/SerializerElement.h"
#include "GDCore/String.h"
#include "GDCore/Project/QuickCustomization.h"
 
namespace gd {
class Project;
class EventsFunction;
class SerializerElement;
class EventsFunctionsContainer;
}  // namespace gd
 
namespace gd {
 
class GD_CORE_API FunctionFolderOrFunction {
 public:
  FunctionFolderOrFunction();
 
  virtual ~FunctionFolderOrFunction();
 
  FunctionFolderOrFunction(gd::String folderName_,
                       FunctionFolderOrFunction* parent_ = nullptr);
 
  FunctionFolderOrFunction(gd::EventsFunction* function_,
                       FunctionFolderOrFunction* parent_ = nullptr);
 
  gd::EventsFunction& GetFunction() const { return *function; }
 
  bool IsFolder() const { return !folderName.empty(); }
 
  const gd::String& GetFolderName() const { return folderName; }
 
  void SetFolderName(const gd::String& name);
 
  bool HasFunctionNamed(const gd::String& name);
 
  FunctionFolderOrFunction& GetFunctionNamed(const gd::String& name);
 
  std::size_t GetChildrenCount() const {
    if (IsFolder()) return children.size();
    return 0;
  }
 
  FunctionFolderOrFunction& GetChildAt(std::size_t index);
 
  const FunctionFolderOrFunction& GetChildAt(std::size_t index) const;
 
  FunctionFolderOrFunction& GetFunctionChild(const gd::String& name);
 
  FunctionFolderOrFunction& GetOrCreateChildFolder(const gd::String& name);
 
  FunctionFolderOrFunction& GetParent() {
    if (parent == nullptr) {
      return badFunctionFolderOrFunction;
    }
    return *parent;
  };
 
  bool IsRootFolder() { return !function && !parent; }
 
  void MoveChild(std::size_t oldIndex, std::size_t newIndex);
 
  void RemoveFolderChild(const FunctionFolderOrFunction& childToRemove);
 
  void RemoveRecursivelyFunctionNamed(const gd::String& name);
 
  void Clear();
 
  void InsertFunction(gd::EventsFunction* insertedFunction,
                    std::size_t position = (size_t)-1);
 
  FunctionFolderOrFunction& InsertNewFolder(const gd::String& newFolderName,
                                        std::size_t position);
 
  bool IsADescendantOf(const FunctionFolderOrFunction& otherFunctionFolderOrFunction);
 
  std::size_t GetChildPosition(const FunctionFolderOrFunction& child) const;
 
  void MoveFunctionFolderOrFunctionToAnotherFolder(
      gd::FunctionFolderOrFunction& functionFolderOrFunction,
      gd::FunctionFolderOrFunction& newParentFolder,
      std::size_t newPosition);
 
 
  void SerializeTo(SerializerElement& element) const;
 
  void UnserializeFrom(const SerializerElement& element,
                       EventsFunctionsContainer& functionsContainer);
 
  void UpdateGroupNameOfAllFunctions();
 
 private:
  void DoUpdateGroupNameOfAllFunctions(const gd::String& groupPath);
  const gd::String GetGroupPath();
 
  static gd::FunctionFolderOrFunction badFunctionFolderOrFunction;
  static gd::String emptyGroupName;
 
  gd::FunctionFolderOrFunction*
      parent = nullptr;  // nullptr if root folder, points to the parent folder otherwise.
 
  // Representing a function:
  gd::EventsFunction* function;  // nullptr if folderName is set.
 
  // or representing a folder:
  gd::String folderName;  // Empty if function is set.
 
  std::vector<std::unique_ptr<FunctionFolderOrFunction>>
      children;  // Folder children.
};
 
}  // namespace gd