ObjectsContainersList.h

#pragma once
#include <vector>
 
#include "Variable.h"
#include "GDCore/Project/ObjectsContainer.h"
 
namespace gd {
class String;
class Project;
class Layout;
class VariablesContainer;
class Object;
class ObjectConfiguration;
}  // namespace gd
 
namespace gd {
 
class GD_CORE_API ObjectsContainersList {
 public:
  virtual ~ObjectsContainersList(){};
 
  static ObjectsContainersList MakeNewEmptyObjectsContainersList();
 
  static ObjectsContainersList MakeNewObjectsContainersListForProjectAndLayout(
      const gd::Project& project, const gd::Layout& layout);
 
  static ObjectsContainersList MakeNewObjectsContainersListForProject(
      const gd::Project& project);
 
  static ObjectsContainersList MakeNewObjectsContainersListForContainers(
      const gd::ObjectsContainer& globalObjectsContainer,
      const gd::ObjectsContainer& objectsContainer);
 
  static ObjectsContainersList MakeNewObjectsContainersListForContainer(
      const gd::ObjectsContainer& objectsContainer);
 
  bool HasObjectOrGroupNamed(const gd::String& name) const;
 
  bool HasObjectNamed(const gd::String& name) const;
 
  enum VariableExistence {
    DoesNotExist,
    Exists,
    GroupIsEmpty,
    ExistsOnlyOnSomeObjectsOfTheGroup
  };
 
  VariableExistence HasObjectOrGroupWithVariableNamed(
      const gd::String& objectOrGroupName,
      const gd::String& variableName) const;
 
  bool HasObjectOrGroupVariablesContainer(
      const gd::String& objectOrGroupName,
      const gd::VariablesContainer& variablesContainer) const;
 
  const gd::VariablesContainer* GetObjectOrGroupVariablesContainer(
      const gd::String& objectOrGroupName) const;
 
  gd::Variable::Type GetTypeOfObjectOrGroupVariable(const gd::String& objectOrGroupName, const gd::String& variableName) const;
 
  gd::String GetTypeOfObject(const gd::String& objectName) const;
 
  bool HasBehaviorInObjectOrGroup(const gd::String& objectOrGroupName,
                                  const gd::String& behaviorName) const;
 
  gd::String GetTypeOfBehaviorInObjectOrGroup(
      const gd::String& objectOrGroupName,
      const gd::String& behaviorName,
      bool searchInGroups = true) const;
 
  gd::String GetTypeOfBehavior(const gd::String& behaviorName,
                               bool searchInGroups = true) const;
 
  std::vector<gd::String> GetBehaviorsOfObject(
      const gd::String& objectName, bool searchInGroups = true) const;
 
  std::vector<gd::String>
  GetBehaviorNamesInObjectOrGroup(const gd::String &objectOrGroupName,
                       const gd::String &behaviorType,
                       bool searchInGroups = true) const;
 
  bool IsDefaultBehavior(const gd::String &objectOrGroupName,
                                            const gd::String &behaviorType,
                                            bool searchInGroups = true) const;
 
  std::vector<gd::String>
  GetAnimationNamesOfObject(const gd::String &objectOrGroupName) const;
 
  std::vector<gd::String> ExpandObjectName(
      const gd::String& objectOrGroupName,
      const gd::String& onlyObjectToSelectIfPresent = "") const;
 
  void ForEachObject(std::function<void(const gd::Object& object)> fn) const;
 
  void ForEachNameMatchingSearch(
      const gd::String& search,
      std::function<void(const gd::String& name,
                         const gd::ObjectConfiguration* objectConfiguration)>
          fn) const;
 
  void ForEachObjectOrGroupVariableMatchingSearch(
      const gd::String& objectOrGroupName,
      const gd::String& search,
      std::function<void(const gd::String& variableName,
                         const gd::Variable& variable)> fn) const;
 
  const gd::ObjectsContainer::SourceType GetObjectsContainerSourceType(
      const gd::String& objectOrGroupName) const;
 
  const ObjectsContainer *
  GetObjectsContainerFromObjectName(const gd::String &objectOrGroupName) const;
 
  const gd::ObjectsContainer &GetObjectsContainer(std::size_t index) const;
 
  std::size_t GetObjectsContainersCount() const;
 
  ObjectsContainersList(){};
 
 private:
  const gd::Object* GetObject(const gd::String& name) const;
 
  bool HasObjectWithVariableNamed(const gd::String& objectName,
                                  const gd::String& variableName) const;
 
  bool HasObjectVariablesContainer(
      const gd::String& objectName,
      const gd::VariablesContainer& variablesContainer) const;
 
  const gd::VariablesContainer* GetObjectVariablesContainer(
      const gd::String& objectName) const;
 
  gd::Variable::Type GetTypeOfObjectVariable(const gd::String& objectName, const gd::String& variableName) const;
 
  void ForEachObjectVariableMatchingSearch(
      const gd::String& objectOrGroupName,
      const gd::String& search,
      std::function<void(const gd::String& variableName,
                         const gd::Variable& variable)> fn) const;
 
  void Add(const gd::ObjectsContainer& objectsContainer) {
    objectsContainers.push_back(&objectsContainer);
  };
 
  std::vector<const gd::ObjectsContainer*> objectsContainers;
};
 
}  // namespace gd