ObjectMetadata.h

/*
 * GDevelop Core
 * Copyright 2008-2016 Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
#pragma once
 
#include "InstructionOrExpressionContainerMetadata.h"
 
#include <functional>
#include <map>
#include <set>
#include <memory>
 
#include "GDCore/Extensions/Metadata/ExpressionMetadata.h"
#include "GDCore/Extensions/Metadata/InstructionMetadata.h"
#include "GDCore/Extensions/Metadata/InGameEditorResourceMetadata.h"
#include "GDCore/Project/Object.h"
#include "GDCore/Project/ObjectConfiguration.h"
#include "GDCore/String.h"
namespace gd {
class InstructionMetadata;
class MultipleInstructionMetadata;
class ExpressionMetadata;
}  // namespace gd
 
typedef std::function<std::unique_ptr<gd::ObjectConfiguration>()>
    CreateFunPtr;
 
namespace gd {
 
class GD_CORE_API ObjectMetadata : public InstructionOrExpressionContainerMetadata {
 public:
  ObjectMetadata(const gd::String& extensionNamespace_,
                 const gd::String& name_,
                 const gd::String& fullname_,
                 const gd::String& description_,
                 const gd::String& icon24x24_,
                 std::shared_ptr<gd::ObjectConfiguration> blueprintObject_);
  ObjectMetadata(const gd::String& extensionNamespace_,
                 const gd::String& name_,
                 const gd::String& fullname_,
                 const gd::String& description_,
                 const gd::String& icon24x24_);
 
  ObjectMetadata(const gd::String& extensionNamespace_,
                 const gd::String& name_,
                 const gd::String& fullname_,
                 const gd::String& description_,
                 const gd::String& icon24x24_,
                 CreateFunPtr createFunPtr_);
 
  ObjectMetadata() {}
  virtual ~ObjectMetadata(){};
 
  gd::InstructionMetadata& AddCondition(const gd::String& name_,
                                        const gd::String& fullname_,
                                        const gd::String& description_,
                                        const gd::String& sentence_,
                                        const gd::String& group_,
                                        const gd::String& icon_,
                                        const gd::String& smallicon_) override;
 
  gd::InstructionMetadata& AddAction(const gd::String& name_,
                                     const gd::String& fullname_,
                                     const gd::String& description_,
                                     const gd::String& sentence_,
                                     const gd::String& group_,
                                     const gd::String& icon_,
                                     const gd::String& smallicon_) override;
 
  gd::InstructionMetadata& AddScopedCondition(const gd::String& name_,
                                              const gd::String& fullname_,
                                              const gd::String& description_,
                                              const gd::String& sentence_,
                                              const gd::String& group_,
                                              const gd::String& icon_,
                                              const gd::String& smallicon_) override;
 
  gd::InstructionMetadata& AddScopedAction(const gd::String& name_,
                                           const gd::String& fullname_,
                                           const gd::String& description_,
                                           const gd::String& sentence_,
                                           const gd::String& group_,
                                           const gd::String& icon_,
                                           const gd::String& smallicon_) override;
 
  gd::ExpressionMetadata& AddExpression(const gd::String& name_,
                                        const gd::String& fullname_,
                                        const gd::String& description_,
                                        const gd::String& group_,
                                        const gd::String& smallicon_) override;
  gd::ExpressionMetadata& AddStrExpression(const gd::String& name_,
                                           const gd::String& fullname_,
                                           const gd::String& description_,
                                           const gd::String& group_,
                                           const gd::String& smallicon_) override;
 
  gd::MultipleInstructionMetadata AddExpressionAndCondition(
      const gd::String& type,
      const gd::String& name,
      const gd::String& fullname,
      const gd::String& description,
      const gd::String& sentenceName,
      const gd::String& group,
      const gd::String& icon) override;
 
  gd::MultipleInstructionMetadata AddExpressionAndConditionAndAction(
      const gd::String& type,
      const gd::String& name,
      const gd::String& fullname,
      const gd::String& description,
      const gd::String& sentenceName,
      const gd::String& group,
      const gd::String& icon) override;
 
  gd::InstructionMetadata& AddDuplicatedAction(
      const gd::String& newActionName, const gd::String& copiedActionName) override;
 
  gd::InstructionMetadata& AddDuplicatedCondition(
      const gd::String& newConditionName,
      const gd::String& copiedConditionName) override;
 
  ObjectMetadata& SetFullName(const gd::String& fullname_) override;
 
  ObjectMetadata& SetDescription(const gd::String& description_) override;
 
  const gd::String& GetHelpPath() const override { return helpPath; }
 
  ObjectMetadata& SetHelpPath(const gd::String& path) override {
    helpPath = path;
    return *this;
  }
 
  ObjectMetadata& SetCategoryFullName(const gd::String& categoryFullName_) {
    categoryFullName = categoryFullName_;
    return *this;
  }
 
  const std::set<gd::String>& GetDefaultBehaviors() const {
    return defaultBehaviorTypes;
  }
 
  bool HasDefaultBehavior(const gd::String& behaviorType) const {
    return defaultBehaviorTypes.find(behaviorType) != defaultBehaviorTypes.end();
  }
 
  ObjectMetadata& AddDefaultBehavior(
      const gd::String& behaviorType) {
    defaultBehaviorTypes.insert(behaviorType);
    return *this;
  }
 
  ObjectMetadata& ResetDefaultBehaviorsJustForTesting() {
    defaultBehaviorTypes.clear();
    return *this;
  }
 
  const gd::String& GetName() const override { return name; }
  const gd::String& GetFullName() const override { return fullname; }
  const gd::String& GetCategoryFullName() const { return categoryFullName; }
  const gd::String& GetHelpUrl() const { return helpUrl; }
  const gd::String& GetDescription() const override { return description; }
  const gd::String& GetIconFilename() const override { return iconFilename; }
 
  ObjectMetadata& SetHelpUrl(const gd::String& url);
 
  ObjectMetadata& SetIncludeFile(const gd::String& includeFile) override;
 
  ObjectMetadata& AddIncludeFile(const gd::String& includeFile) override;
 
  std::map<gd::String, gd::InstructionMetadata>& GetAllActions() override { return actionsInfos; };
 
  std::map<gd::String, gd::InstructionMetadata>& GetAllConditions() override { return conditionsInfos; };
 
  std::map<gd::String, gd::ExpressionMetadata>& GetAllExpressions() override { return expressionsInfos; };
 
  std::map<gd::String, gd::ExpressionMetadata>& GetAllStrExpressions() override { return strExpressionsInfos; };
 
  bool IsPrivate() const override { return isPrivate; }
 
  ObjectMetadata &SetPrivate() {
    isPrivate = true;
    return *this;
  }
 
  ObjectMetadata &SetHidden() {
    hidden = true;
    return *this;
  }
 
  bool IsHidden() const { return hidden; }
 
  ObjectMetadata &MarkAsRenderedIn3D() {
    isRenderedIn3D = true;
    return *this;
  }
 
  bool IsRenderedIn3D() const { return isRenderedIn3D; }
 
  ObjectMetadata &SetOpenFullEditorLabel(const gd::String& label) {
    openFullEditorLabel = label;
    return *this;
  }
 
  const gd::String& GetOpenFullEditorLabel() const {
    return openFullEditorLabel;
  }
 
  InGameEditorResourceMetadata& AddInGameEditorResource() {
    InGameEditorResourceMetadata newInGameEditorResource;
    inGameEditorResources.push_back(newInGameEditorResource);
    return inGameEditorResources.back();
  }
 
  const std::vector<gd::InGameEditorResourceMetadata>& GetInGameEditorResources() const {
    return inGameEditorResources;
  }
 
  std::map<gd::String, gd::InstructionMetadata> conditionsInfos;
  std::map<gd::String, gd::InstructionMetadata> actionsInfos;
  std::map<gd::String, gd::ExpressionMetadata> expressionsInfos;
  std::map<gd::String, gd::ExpressionMetadata> strExpressionsInfos;
 
  std::vector<gd::String> includeFiles;
  gd::String className;
  CreateFunPtr createFunPtr = nullptr;
 
 private:
  gd::String extensionNamespace;
  gd::String name;
  gd::String helpPath;
  gd::String helpUrl;  
  gd::String fullname;
  gd::String description;
  gd::String iconFilename;
  gd::String categoryFullName;
  std::set<gd::String> defaultBehaviorTypes;
  bool isPrivate = false;
  bool hidden = false;
  bool isRenderedIn3D = false;
  gd::String openFullEditorLabel;
  std::vector<gd::InGameEditorResourceMetadata> inGameEditorResources;
 
  std::shared_ptr<gd::ObjectConfiguration>
      blueprintObject;  
};
 
}  // namespace gd