VariablesContainer.h

/*
 * GDevelop Core
 * Copyright 2008-2016 Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
 
#pragma once
#include <memory>
#include <vector>
#include "GDCore/Project/MemoryTrackedRegistry.h"
#include "GDCore/Project/Variable.h"
#include "GDCore/String.h"
namespace gd {
class SerializerElement;
}
 
namespace gd {
 
class GD_CORE_API VariablesContainer {
 public:
  enum SourceType {
      Unknown,
      Global,
      Scene,
      Object,
      Local,
      ExtensionGlobal,
      ExtensionScene,
      Parameters,
      Properties,
  };
 
  VariablesContainer();
  VariablesContainer(const SourceType sourceType);
  VariablesContainer(const VariablesContainer&);
  virtual ~VariablesContainer(){};
 
  VariablesContainer& operator=(const VariablesContainer& rhs);
 
  SourceType GetSourceType() const { return sourceType; }
 
 
  bool Has(const gd::String& name) const;
 
  Variable& Get(const gd::String& name);
 
  const Variable& Get(const gd::String& name) const;
 
  Variable& Get(std::size_t index);
 
  const Variable& Get(std::size_t index) const;
 
  Variable& Insert(const gd::String& name,
                   const Variable& variable,
                   std::size_t position);
 
  std::size_t Count() const { return variables.size(); };
 
  const gd::String& GetNameAt(std::size_t index) const;
 
  std::size_t GetPosition(const gd::String& name) const;
 
  Variable& InsertNew(const gd::String& name, std::size_t position = -1);
 
  void Remove(const gd::String& name);
 
  void RemoveRecursively(const gd::Variable& variable);
 
  bool Rename(const gd::String& oldName, const gd::String& newName);
 
  void Swap(std::size_t firstVariableIndex, std::size_t secondVariableIndex);
 
  void Move(std::size_t oldIndex, std::size_t newIndex);
 
  inline void Clear() { variables.clear(); }
 
  void ForEachVariableMatchingSearch(const gd::String& search, std::function<void(const gd::String& name, const gd::Variable& variable)> fn) const;
 
 
  void SerializeTo(SerializerElement& element) const;
 
  void UnserializeFrom(const SerializerElement& element);
 
  VariablesContainer& ResetPersistentUuid();
 
  VariablesContainer& ClearPersistentUuid();
 
  const gd::String& GetPersistentUuid() const { return persistentUuid; };
 
 private:
  SourceType sourceType = Unknown;
  std::vector<std::pair<gd::String, std::shared_ptr<gd::Variable>>> variables;
  mutable gd::String persistentUuid;  
  static gd::Variable badVariable;
  static gd::String badName;
  gd::MemoryTracked _memoryTracked{this, "VariablesContainer"};
 
  void Init(const VariablesContainer& other);
};
 
}  // namespace gd