BehaviorMetadata.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 <map>
 
#include "GDCore/Extensions/Metadata/ExpressionMetadata.h"
#include "GDCore/Extensions/Metadata/InstructionMetadata.h"
#include "GDCore/String.h"
#include "GDCore/Project/QuickCustomization.h"
namespace gd {
class Behavior;
class BehaviorsSharedData;
class MultipleInstructionMetadata;
class InstructionMetadata;
class ExpressionMetadata;
class PropertyDescriptor;
}  // namespace gd
 
namespace gd {
 
class GD_CORE_API BehaviorMetadata : public InstructionOrExpressionContainerMetadata {
 public:
  BehaviorMetadata(
      const gd::String& extensionNamespace,
      const gd::String& nameWithNamespace,
      const gd::String& fullname_,
      const gd::String& defaultName_,
      const gd::String& description_,
      const gd::String& group_,
      const gd::String& icon24x24_,
      const gd::String& className_,
      std::shared_ptr<gd::Behavior> instance,
      std::shared_ptr<gd::BehaviorsSharedData> sharedDatasInstance);
 
  BehaviorMetadata(
      const gd::String& extensionNamespace,
      const gd::String& nameWithNamespace,
      const gd::String& fullname_,
      const gd::String& defaultName_,
      const gd::String& description_,
      const gd::String& group_,
      const gd::String& icon24x24_);
 
  BehaviorMetadata(){};
  virtual ~BehaviorMetadata(){};
 
  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;
 
  gd::ExpressionMetadata& AddDuplicatedExpression(
      const gd::String& newExpressionName,
      const gd::String& copiedExpressionName);
 
  gd::ExpressionMetadata& AddDuplicatedStrExpression(
      const gd::String& newExpressionName,
      const gd::String& copiedExpressionName);
 
  BehaviorMetadata& SetFullName(const gd::String& fullname_) override;
  BehaviorMetadata& SetDefaultName(const gd::String& defaultName_);
  BehaviorMetadata& SetDescription(const gd::String& description_) override;
  BehaviorMetadata& SetGroup(const gd::String& group_);
 
  BehaviorMetadata& SetIncludeFile(const gd::String& includeFile) override;
 
  BehaviorMetadata& AddIncludeFile(const gd::String& includeFile) override;
 
  BehaviorMetadata& AddRequiredFile(const gd::String& requiredFile);
 
  const gd::String& GetHelpPath() const override { return helpPath; }
 
  BehaviorMetadata& SetHelpPath(const gd::String& path) override {
    helpPath = path;
    return *this;
  }
 
  const gd::String& GetName() const override;
  const gd::String& GetFullName() const override { return fullname; }
  const gd::String& GetDefaultName() const { return defaultName; }
  const gd::String& GetDescription() const override { return description; }
  const gd::String& GetGroup() const { return group; }
  const gd::String& GetIconFilename() const override { return iconFilename; }
 
  BehaviorMetadata& SetObjectType(const gd::String& objectType_) {
    objectType = objectType_;
    return *this;
  }
 
  const gd::String& GetObjectType() const { return objectType; }
 
  const std::vector<gd::String>& GetRequiredBehaviorTypes() const;
 
  bool IsPrivate() const override { return isPrivate; }
 
  BehaviorMetadata &SetPrivate() {
    isPrivate = true;
    return *this;
  }
 
  bool IsHidden() const { return isHidden; }
 
  BehaviorMetadata &SetHidden() {
    isHidden = true;
    return *this;
  }
 
  bool IsRelevantForChildObjects() const { return isRelevantForChildObjects; }
 
  BehaviorMetadata &MarkAsIrrelevantForChildObjects() {
    isRelevantForChildObjects = false;
    return *this;
  }
 
  QuickCustomization::Visibility GetQuickCustomizationVisibility() const {
    return quickCustomizationVisibility;
  }
 
  BehaviorMetadata &SetQuickCustomizationVisibility(QuickCustomization::Visibility visibility) {
    quickCustomizationVisibility = visibility;
    return *this;
  }
 
  BehaviorMetadata &SetOpenFullEditorLabel(const gd::String& label) {
    openFullEditorLabel = label;
    return *this;
  }
 
  const gd::String& GetOpenFullEditorLabel() const {
    return openFullEditorLabel;
  }
 
  gd::Behavior& Get() const;
 
  std::map<gd::String, gd::PropertyDescriptor> GetProperties() const;
 
  gd::BehaviorsSharedData* GetSharedDataInstance() const;
 
  std::map<gd::String, gd::PropertyDescriptor> GetSharedProperties() const;
 
  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; };
 
  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;
  std::vector<gd::String> requiredFiles;
  gd::String className;
 
 private:
  gd::String extensionNamespace;
  gd::String helpPath;
  gd::String fullname;
  gd::String defaultName;
  gd::String description;
  gd::String group;
  gd::String iconFilename;
  gd::String objectType;
  mutable std::vector<gd::String> requiredBehaviors;
  bool isPrivate = false;
  bool isHidden = false;
  bool isRelevantForChildObjects = true;
  gd::String openFullEditorLabel;
  QuickCustomization::Visibility quickCustomizationVisibility = QuickCustomization::Visibility::Default;
 
  // TODO: Nitpicking: convert these to std::unique_ptr to clarify ownership.
  std::shared_ptr<gd::Behavior> instance;
  std::shared_ptr<gd::BehaviorsSharedData> sharedDatasInstance;
 
  static const std::map<gd::String, gd::PropertyDescriptor> badProperties;
};
 
}  // namespace gd