VariablesContainersList.h

#pragma once
#include <functional>
#include <vector>
 
namespace gd {
class String;
class Project;
class Layout;
class VariablesContainer;
class Variable;
class EventsFunctionsExtension;
class EventsBasedBehavior;
class EventsBasedObject;
class EventsFunction;
} // namespace gd
 
namespace gd {
 
class GD_CORE_API VariablesContainersList {
public:
  virtual ~VariablesContainersList(){};
 
  static VariablesContainersList
  MakeNewVariablesContainersListForProjectAndLayout(const gd::Project &project,
                                                    const gd::Layout &layout);
 
  static VariablesContainersList
  MakeNewVariablesContainersListForProject(const gd::Project &project);
 
  static VariablesContainersList
  MakeNewVariablesContainersListForEventsFunctionsExtension(
      const gd::EventsFunctionsExtension &extension);
 
  static VariablesContainersList
  MakeNewVariablesContainersListForFreeEventsFunction(
      const gd::EventsFunctionsExtension &extension,
      const gd::EventsFunction &eventsFunction,
      gd::VariablesContainer &parameterVariablesContainer);
 
  static VariablesContainersList
  MakeNewVariablesContainersListForBehaviorEventsFunction(
      const gd::EventsFunctionsExtension &extension,
      const gd::EventsBasedBehavior &eventsBasedBehavior,
      const gd::EventsFunction &eventsFunction,
      gd::VariablesContainer &parameterVariablesContainer,
      gd::VariablesContainer &propertyVariablesContainer);
 
  static VariablesContainersList
  MakeNewVariablesContainersListForObjectEventsFunction(
      const gd::EventsFunctionsExtension &extension,
      const gd::EventsBasedObject &eventsBasedObject,
      const gd::EventsFunction &eventsFunction,
      gd::VariablesContainer &parameterVariablesContainer,
      gd::VariablesContainer &propertyVariablesContainer);
 
  static VariablesContainersList MakeNewVariablesContainersListPushing(
      const VariablesContainersList &variablesContainersList,
      const gd::VariablesContainer &variablesContainer);
 
  static VariablesContainersList MakeNewEmptyVariablesContainersList();
 
  bool Has(const gd::String &name) const;
 
  const Variable &Get(const gd::String &name) const;
 
  bool
  HasVariablesContainer(const gd::VariablesContainer &variablesContainer) const;
 
  // TODO: Rename GetTopMostVariablesContainer and
  // GetBottomMostVariablesContainer to give a clearer access to segments of the
  // container list. For instance, a project tree segment and an event tree
  // segment.
 
  const VariablesContainer *GetTopMostVariablesContainer() const {
    if (variablesContainers.empty())
      return nullptr;
    return variablesContainers.front();
  };
 
  const VariablesContainer *GetBottomMostVariablesContainer() const {
    if (variablesContainers.empty())
      return nullptr;
    return variablesContainers.at(firstLocalVariableContainerIndex - 1);
  }
 
  const VariablesContainer &
  GetVariablesContainerFromVariableOrPropertyOrParameterName(const gd::String &variableName) const;
 
  const VariablesContainer &
  GetVariablesContainerFromVariableOrPropertyName(const gd::String &variableName) const;
 
  const VariablesContainer &
  GetVariablesContainerFromVariableNameOnly(const gd::String &variableName) const;
 
  std::size_t GetVariablesContainerPositionFromVariableName(
      const gd::String &variableName) const;
 
  std::size_t GetLocalVariablesContainerPosition(
      const gd::VariablesContainer &localVariableContainer) const;
 
  const gd::VariablesContainer &GetVariablesContainer(std::size_t index) const {
    return *variablesContainers.at(index);
  }
 
  std::size_t GetVariablesContainersCount() const {
    return variablesContainers.size();
  }
 
  void ForEachVariableMatchingSearch(
      const gd::String &search,
      std::function<void(const gd::String &name, const gd::Variable &variable)>
          fn) const;
 
  void Push(const gd::VariablesContainer &variablesContainer) {
    variablesContainers.push_back(&variablesContainer);
  };
 
  void Pop() { variablesContainers.pop_back(); };
 
  VariablesContainersList() : firstLocalVariableContainerIndex(0){};
 
private:
  std::vector<const gd::VariablesContainer *> variablesContainers;
  std::size_t firstLocalVariableContainerIndex;
  static Variable badVariable;
  static VariablesContainer badVariablesContainer;
};
 
} // namespace gd