ParameterMetadata.h

/*
 * GDevelop Core
 * Copyright 2008-2016 Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
 
#ifndef PARAMETER_METADATA_H
#define PARAMETER_METADATA_H
#include <map>
#include <memory>
 
#include "GDCore/String.h"
#include "GDCore/Extensions/Metadata/ValueTypeMetadata.h"
 
namespace gd {
class SerializerElement;
}  // namespace gd
 
namespace gd {
 
class GD_CORE_API ParameterMetadata {
 public:
  ParameterMetadata();
  virtual ~ParameterMetadata(){};
 
  gd::ValueTypeMetadata &GetValueTypeMetadata() { return valueTypeMetadata; }
 
  const gd::ValueTypeMetadata &GetValueTypeMetadata() const { return valueTypeMetadata; }
 
  ParameterMetadata &SetValueTypeMetadata(const gd::ValueTypeMetadata &valueTypeMetadata_) {
    valueTypeMetadata = valueTypeMetadata_;
    return *this;
  }
 
  const gd::String &GetType() const { return valueTypeMetadata.GetName(); }
 
  ParameterMetadata &SetType(const gd::String &type_) {
    valueTypeMetadata.SetName(type_);
    return *this;
  }
 
  const gd::String &GetName() const { return name; }
 
  ParameterMetadata &SetName(const gd::String &name_) {
    name = name_;
    return *this;
  }
 
  const gd::String &GetExtraInfo() const { return valueTypeMetadata.GetExtraInfo(); }
 
  ParameterMetadata &SetExtraInfo(const gd::String &supplementaryInformation_) {
    valueTypeMetadata.SetExtraInfo(supplementaryInformation_);
    return *this;
  }
 
  bool IsOptional() const { return valueTypeMetadata.IsOptional(); }
 
  ParameterMetadata &SetOptional(bool optional_ = true) {
    valueTypeMetadata.SetOptional(optional_);
    return *this;
  }
 
  const gd::String &GetDescription() const { return description; }
 
  ParameterMetadata &SetDescription(const gd::String &description_) {
    description = description_;
    return *this;
  }
 
  bool IsCodeOnly() const { return codeOnly; }
 
  ParameterMetadata &SetCodeOnly(bool codeOnly_ = true) {
    codeOnly = codeOnly_;
    return *this;
  }
 
  const gd::String &GetDefaultValue() const {
    return valueTypeMetadata.GetDefaultValue();
  }
 
  ParameterMetadata &SetDefaultValue(const gd::String &defaultValue_) {
    valueTypeMetadata.SetDefaultValue(defaultValue_);
    return *this;
  }
 
  const gd::String &GetLongDescription() const { return longDescription; }
 
  ParameterMetadata &SetLongDescription(const gd::String &longDescription_) {
    longDescription = longDescription_;
    return *this;
  }
 
  // TODO Remove these deprecated functions.
 
  static bool IsObject(const gd::String &parameterType) {
    return gd::ValueTypeMetadata::IsTypeObject(parameterType);
  }
 
  static bool IsBehavior(const gd::String &parameterType) {
    return gd::ValueTypeMetadata::IsTypeBehavior(parameterType);
  }
 
  static bool IsExpression(const gd::String &type,
                           const gd::String &parameterType) {
    return gd::ValueTypeMetadata::IsTypeExpression(type, parameterType);
  }
 
  static const gd::String &GetExpressionValueType(const gd::String &parameterType) {
    return gd::ValueTypeMetadata::GetExpressionPrimitiveValueType(parameterType);
  }
 
 
  void SerializeTo(gd::SerializerElement &element) const;
 
  void UnserializeFrom(const gd::SerializerElement &element);
 
  // TODO: Deprecated public fields. Any direct usage should be moved to
  // getter/setter.
 
  gd::String description;  
  bool codeOnly;  
 private:
  gd::ValueTypeMetadata valueTypeMetadata; 
  gd::String longDescription;  
  gd::String name;             
};
 
}  // namespace gd
 
#endif  // PARAMETER_METADATA_H