EventsCodeGenerator.h

/*
 * GDevelop JS Platform
 * Copyright 2008-2016 Florian Rival ([email protected]). All rights
 * reserved. This project is released under the MIT License.
 */
#pragma once
 
#include <set>
#include <string>
#include <vector>
 
#include "GDCore/Events/CodeGeneration/EventsCodeGenerator.h"
#include "GDCore/Events/Event.h"
#include "GDCore/Events/InstructionsList.h"
namespace gd {
class ObjectsContainer;
class EventsFunctionsContainer;
class EventsFunction;
class EventsBasedBehavior;
class EventsBasedObject;
class ObjectMetadata;
class BehaviorMetadata;
class InstructionMetadata;
class ExpressionCodeGenerationInformation;
class EventsCodeGenerationContext;
class ProjectScopedContainers;
class ParameterMetadataContainer;
}  // namespace gd
 
namespace gdjs {
 
class EventsCodeGenerator : public gd::EventsCodeGenerator {
 public:
  static gd::String GenerateLayoutCode(const gd::Project& project,
                                       const gd::Layout& scene,
                                       const gd::String& codeNamespace,
                                       std::set<gd::String>& includeFiles,
                                       gd::DiagnosticReport& diagnosticReport,
                                       bool compilationForRuntime = false);
 
  static gd::String GenerateEventsFunctionCode(
      gd::Project& project,
      const gd::EventsFunctionsExtension& eventsFunctionsExtension,
      const gd::EventsFunction& eventsFunction,
      const gd::String& codeNamespace,
      std::set<gd::String>& includeFiles,
      bool compilationForRuntime = false);
 
  static gd::String GenerateBehaviorEventsFunctionCode(
      gd::Project& project,
    const gd::EventsFunctionsExtension& eventsFunctionsExtension,
      const gd::EventsBasedBehavior& eventsBasedBehavior,
      const gd::EventsFunction& eventsFunction,
      const gd::String& codeNamespace,
      const gd::String& fullyQualifiedFunctionName,
      const gd::String& onceTriggersVariable,
      const gd::String& preludeCode,
      std::set<gd::String>& includeFiles,
      bool compilationForRuntime = false);
 
  static gd::String GenerateObjectEventsFunctionCode(
      gd::Project& project,
    const gd::EventsFunctionsExtension& eventsFunctionsExtension,
      const gd::EventsBasedObject& eventsBasedObject,
      const gd::EventsFunction& eventsFunction,
      const gd::String& codeNamespace,
      const gd::String& fullyQualifiedFunctionName,
      const gd::String& onceTriggersVariable,
      const gd::String& preludeCode,
      const gd::String& endingCode,
      std::set<gd::String>& includeFiles,
      bool compilationForRuntime = false);
 
  virtual gd::String GenerateEventsListCode(
      gd::EventsList& events, gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateConditionsListCode(
      gd::InstructionsList& conditions,
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateBooleanFullName(
      const gd::String& boolName,
      const gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateUpperScopeBooleanFullName(
      const gd::String& boolName,
      const gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateBooleanInitializationToFalse(
      const gd::String& boolName,
      const gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GetObjectListName(
      const gd::String& name, const gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GetCodeNamespaceAccessor() override {
    return GetCodeNamespace() + ".";
  };
 
  virtual gd::String GetCodeNamespace() override { return codeNamespace; };
 
  void SetCodeNamespace(const gd::String& codeNamespace_) {
    codeNamespace = codeNamespace_;
  };
 
  virtual gd::String GeneratePropertySetterWithoutCasting(
      const gd::PropertiesContainer &propertiesContainer,
      const gd::NamedPropertyDescriptor &property,
      const gd::String &operandCode) override;
 
 protected:
  virtual gd::String GenerateParameterCodes(
      const gd::Expression& parameter,
      const gd::ParameterMetadata& metadata,
      gd::EventsCodeGenerationContext& context,
      const gd::String& lastObjectName,
      std::vector<std::pair<gd::String, gd::String> >*
          supplementaryParametersTypes) override;
 
  virtual gd::String GenerateObjectFunctionCall(
      gd::String objectListName,
      const gd::ObjectMetadata& objMetadata,
      const gd::ExpressionCodeGenerationInformation& codeInfo,
      gd::String parametersStr,
      gd::String defaultOutput,
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateObjectBehaviorFunctionCall(
      gd::String objectListName,
      gd::String behaviorName,
      const gd::BehaviorMetadata& autoInfo,
      const gd::ExpressionCodeGenerationInformation& codeInfo,
      gd::String parametersStr,
      gd::String defaultOutput,
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateFreeCondition(
      const std::vector<gd::String>& arguments,
      const gd::InstructionMetadata& instrInfos,
      const gd::String& returnBoolean,
      bool conditionInverted,
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateObjectCondition(
      const gd::String& objectName,
      const gd::ObjectMetadata& objInfo,
      const std::vector<gd::String>& arguments,
      const gd::InstructionMetadata& instrInfos,
      const gd::String& returnBoolean,
      bool conditionInverted,
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateBehaviorCondition(
      const gd::String& objectName,
      const gd::String& behaviorName,
      const gd::BehaviorMetadata& autoInfo,
      const std::vector<gd::String>& arguments,
      const gd::InstructionMetadata& instrInfos,
      const gd::String& returnBoolean,
      bool conditionInverted,
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateObjectAction(
      const gd::String& objectName,
      const gd::ObjectMetadata& objInfo,
      const gd::String& functionCallName,
      const std::vector<gd::String>& arguments,
      const gd::InstructionMetadata& instrInfos,
      gd::EventsCodeGenerationContext& context,
      const gd::String& optionalAsyncCallbackName = "") override;
 
  virtual gd::String GenerateBehaviorAction(
      const gd::String& objectName,
      const gd::String& behaviorName,
      const gd::BehaviorMetadata& autoInfo,
      const gd::String& functionCallName,
      const std::vector<gd::String>& arguments,
      const gd::InstructionMetadata& instrInfos,
      gd::EventsCodeGenerationContext& context,
      const gd::String& optionalAsyncCallbackName = "") override;
 
  virtual gd::String GenerateGetBehaviorNameCode(
      const gd::String& behaviorName) override;
 
  virtual gd::String GenerateGetVariable(
      const gd::String& variableName,
      const VariableScope& scope,
      gd::EventsCodeGenerationContext& context,
      const gd::String& objectName,
      bool hasChild) override;
 
  virtual gd::String GenerateVariableAccessor(gd::String childName) override {
    // This could be probably optimised by using `getChildNamed`.
    return ".getChild(" + ConvertToStringExplicit(childName) + ")";
  };
 
  virtual gd::String GenerateVariableBracketAccessor(
      gd::String expressionCode) override {
    // This uses `getChild` which allows to access a child
    // with a number (an index, for an array) or a string (for a structure).
    // This could be optimised, if the type of the accessed variable AND the type of the index is known,
    // so that `getChildAt` (for an array, with an index) or `getChildNamed` (for a structure, with a name)
    // is used instead.
    return ".getChild(" + expressionCode + ")";
  };
 
  virtual gd::String GenerateBadVariable() override {
    return "gdjs.VariablesContainer.badVariable";
  }
 
  virtual gd::String GeneratePropertyGetter(const gd::PropertiesContainer& propertiesContainer,
                                            const gd::NamedPropertyDescriptor& property,
                                            const gd::String& type,
                                            gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GeneratePropertyGetterWithoutCasting(
      const gd::PropertiesContainer &propertiesContainer,
      const gd::NamedPropertyDescriptor &property) override;
 
  virtual gd::String GenerateParameterGetter(const gd::ParameterMetadata& parameter,
                                             const gd::String& type,
                                             gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateParameterGetterWithoutCasting(
      const gd::ParameterMetadata &parameter) override;
 
  virtual gd::String GenerateBadObject() override { return "null"; }
 
  virtual gd::String GenerateObject(const gd::String& objectName,
                                    const gd::String& type,
                                    gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateNegatedPredicate(const gd::String& predicate) const override {
    return "!(" + predicate + ")";
  };
 
  virtual gd::String GenerateObjectsDeclarationCode(
      gd::EventsCodeGenerationContext& context) override;
 
  virtual gd::String GenerateAllInstancesGetterCode(
      const gd::String& objectName, gd::EventsCodeGenerationContext& context);
 
  virtual gd::String GenerateProfilerSectionBegin(const gd::String& section) override;
  virtual gd::String GenerateProfilerSectionEnd(const gd::String& section) override;
 
  virtual gd::String GenerateRelationalOperation(
    const gd::String& relationalOperator,
    const gd::String& lhs,
    const gd::String& rhs) override;
 
 private:
  static gd::String GenerateEventsListCompleteFunctionCode(
      gdjs::EventsCodeGenerator& codeGenerator,
      gd::String fullyQualifiedFunctionName,
      gd::String functionArgumentsCode,
      gd::String functionPreEventsCode,
      const gd::EventsList& events,
      gd::String functionPostEventsCode,
      gd::String functionReturnCode);
 
  gd::String GenerateAllConditionsBooleanDeclarations();
 
  std::pair<gd::String, gd::String> GenerateAllObjectsDeclarationsAndResets(
      unsigned int maxDepthLevelReached);
 
  gd::String GenerateEventsFunctionParameterDeclarationsList(
      const gd::ParameterMetadataContainer& parameters,
      int firstParameterIndex,
      bool addsSceneParameter);
 
  gd::String GenerateFreeEventsFunctionContext(
       const gd::EventsFunctionsExtension &eventsFunctionsExtension,
       const gd::EventsFunction &eventsFunction,
      const gd::String& onceTriggersVariable);
 
  gd::String GenerateBehaviorEventsFunctionContext(
       const gd::EventsFunctionsExtension &eventsFunctionsExtension,
      const gd::EventsBasedBehavior& eventsBasedBehavior,
       const gd::EventsFunction &eventsFunction,
      const gd::String& onceTriggersVariable,
      const gd::String& thisObjectName,
      const gd::String& thisBehaviorName);
 
  gd::String GenerateObjectEventsFunctionContext(
       const gd::EventsFunctionsExtension &eventsFunctionsExtension,
      const gd::EventsBasedObject& eventsBasedObject,
       const gd::EventsFunction &eventsFunction,
      const gd::String& onceTriggersVariable,
      const gd::String& thisObjectName);
 
  gd::String GenerateEventsFunctionReturn(
      const gd::EventsFunction& eventFunction);
 
  EventsCodeGenerator(const gd::Project& project, const gd::Layout& layout);
 
  EventsCodeGenerator(const gd::ProjectScopedContainers& projectScopedContainers);
  virtual ~EventsCodeGenerator();
 
  gd::String codeNamespace;  
 
 private:
   gd::String GenerateEventsFunctionContext(
       const gd::EventsFunctionsExtension &eventsFunctionsExtension,
       const gd::EventsFunctionsContainer &eventsFunctionsContainer,
       const gd::EventsFunction &eventsFunction,
       const gd::String &onceTriggersVariable,
       gd::String &objectsGettersMap,
       gd::String &objectArraysMap,
       gd::String &behaviorNamesMap,
       const gd::String &thisObjectName = "",
       const gd::String &thisBehaviorName = "");
};
 
}  // namespace gdjs