AbstractFunctionMetadata.h

/*
 * GDevelop Core
 * Copyright 2008-2016 Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
 
#pragma once
 
#include <algorithm>
#include <functional>
#include <map>
#include <memory>
 
#include "GDCore/Events/Instruction.h"
#include "GDCore/String.h"
#include "ParameterMetadata.h"
#include "ParameterOptions.h"
 
namespace gd {
class Project;
class Layout;
class EventsCodeGenerator;
class EventsCodeGenerationContext;
class SerializerElement;
} // namespace gd
 
namespace gd {
 
class GD_CORE_API AbstractFunctionMetadata {
public:
  AbstractFunctionMetadata(){};
  virtual ~AbstractFunctionMetadata(){};
 
  virtual AbstractFunctionMetadata &
  AddParameter(const gd::String &type, const gd::String &label,
               const gd::String &supplementaryInformation = "",
               bool parameterIsOptional = false) = 0;
 
  virtual AbstractFunctionMetadata &
  AddCodeOnlyParameter(const gd::String &type,
                       const gd::String &supplementaryInformation) = 0;
 
  virtual AbstractFunctionMetadata &
  SetDefaultValue(const gd::String &defaultValue) = 0;
 
  virtual AbstractFunctionMetadata &
  SetParameterExtraInfo(const gd::String &defaultValue) = 0;
 
  virtual AbstractFunctionMetadata &
  SetParameterLongDescription(const gd::String &longDescription) = 0;
 
  virtual AbstractFunctionMetadata &
  SetParameterHint(const gd::String &hint) = 0;
 
  virtual AbstractFunctionMetadata &SetHidden() = 0;
 
  virtual AbstractFunctionMetadata &
  SetDeprecationMessage(const gd::String &message) = 0;
 
  virtual AbstractFunctionMetadata &SetPrivate() = 0;
 
  virtual AbstractFunctionMetadata &SetRelevantForLayoutEventsOnly() = 0;
 
  virtual AbstractFunctionMetadata &SetRelevantForFunctionEventsOnly() = 0;
 
  virtual AbstractFunctionMetadata &
  SetRelevantForAsynchronousFunctionEventsOnly() = 0;
 
  virtual AbstractFunctionMetadata &SetRelevantForCustomObjectEventsOnly() = 0;
 
  virtual AbstractFunctionMetadata &
  SetFunctionName(const gd::String &functionName) = 0;
 
  virtual AbstractFunctionMetadata &
  SetIncludeFile(const gd::String &includeFile) = 0;
 
  virtual AbstractFunctionMetadata &
  AddIncludeFile(const gd::String &includeFile) = 0;
 
  virtual const std::vector<gd::String> &GetIncludeFiles() const = 0;
 
private:
};
 
} // namespace gd