GDCore%20Documentation/_whole_project_refactorer_8h_source.html

 /*

  * GDevelop Core

  * Copyright 2008-2016 Florian Rival ([email protected]). All rights

  * reserved. This project is released under the MIT License.

  */

 #pragma once


 #include <set>

 #include <unordered_set>

 #include <unordered_map>

 #include <vector>

 #include "GDCore/String.h"

 namespace gd {

 class Platform;

 class Project;

 class Layout;

 class Layer;

 class Object;

 class String;

 class EventsFunctionsExtension;

 class EventsFunction;

 class ObjectsContainer;

 class VariablesContainer;

 class EventsBasedBehavior;

 class EventsBasedObject;

 class ArbitraryEventsWorker;

 class ArbitraryObjectsWorker;

 class ArbitraryEventsFunctionsWorker;

 class ArbitraryEventsWorkerWithContext;

 class ArbitraryEventBasedBehaviorsWorker;

 class ArbitraryBehaviorSharedDataWorker;

 class Behavior;

 class BehaviorMetadata;

 class UnfilledRequiredBehaviorPropertyProblem;

 class ProjectBrowser;

 class SerializerElement;

 }  // namespace gd


 namespace gd {


 struct VariablesChangeset {

   std::unordered_set<gd::String> removedVariableNames;

   std::unordered_map<gd::String, gd::String> oldToNewVariableNames;


   bool HasRemovedVariables() { return !removedVariableNames.empty(); }


   VariablesChangeset& ClearRemovedVariables() { removedVariableNames.clear(); return *this; }

 };


 class GD_CORE_API WholeProjectRefactorer {

  public:


   static VariablesChangeset ComputeChangesetForVariablesContainer(

     gd::Project &project,

     const gd::SerializerElement &oldSerializedVariablesContainer,

     const gd::VariablesContainer &newVariablesContainer);


   static void ApplyRefactoringForVariablesContainer(

     gd::Project &project,

     const gd::VariablesContainer &newVariablesContainer,

     const gd::VariablesChangeset& changeset);


   static void RenameEventsFunctionsExtension(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::String& oldName,

       const gd::String& newName);


   static void UpdateExtensionNameInEventsBasedBehavior(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       gd::EventsBasedBehavior& eventsBasedBehavior,

       const gd::String& sourceExtensionName);


   static void RenameEventsFunction(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::String& oldFunctionName,

       const gd::String& newFunctionName);


   static void RenameBehaviorEventsFunction(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedBehavior& eventsBasedBehavior,

       const gd::String& oldFunctionName,

       const gd::String& newFunctionName);


   static void RenameObjectEventsFunction(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedObject& eventsBasedObject,

       const gd::String& oldFunctionName,

       const gd::String& newFunctionName);


   static void MoveEventsFunctionParameter(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::String& functionName,

       std::size_t oldIndex,

       std::size_t newIndex);


   static void MoveBehaviorEventsFunctionParameter(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedBehavior& eventsBasedBehavior,

       const gd::String& functionName,

       std::size_t oldIndex,

       std::size_t newIndex);


   static void MoveObjectEventsFunctionParameter(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedObject& eventsBasedObject,

       const gd::String& functionName,

       std::size_t oldIndex,

       std::size_t newIndex);


   static void RenameEventsBasedBehaviorProperty(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedBehavior& eventsBasedBehavior,

       const gd::String& oldPropertyName,

       const gd::String& newPropertyName);


   static void RenameEventsBasedBehaviorSharedProperty(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedBehavior& eventsBasedBehavior,

       const gd::String& oldPropertyName,

       const gd::String& newPropertyName);


   static void RenameEventsBasedObjectProperty(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedObject& eventsBasedObject,

       const gd::String& oldPropertyName,

       const gd::String& newPropertyName);


   static void AddBehaviorAndRequiredBehaviors(gd::Project& project,

                                               gd::Object& object,

                                               const gd::String& behaviorType,

                                               const gd::String& behaviorName);

   static void AddRequiredBehaviorsFor(gd::Project& project,

                                       gd::Object& object,

                                       const gd::String& behaviorName);


   static std::vector<gd::String> FindDependentBehaviorNames(

       const gd::Project& project,

       const gd::Object& object,

       const gd::String& behaviorName);


   static std::vector<gd::String> GetBehaviorsWithType(const gd::Object& object,

                                                       const gd::String& type);


   static std::vector<gd::UnfilledRequiredBehaviorPropertyProblem>

   FindInvalidRequiredBehaviorProperties(const gd::Project& project);


   static bool

   FixInvalidRequiredBehaviorProperties(gd::Project& project);


   static void RenameEventsBasedBehavior(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::String& oldBehaviorName,

       const gd::String& newBehaviorName);


   static void RenameEventsBasedObject(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::String& oldObjectName,

       const gd::String& newObjectName);


   static void RenameLayout(gd::Project &project, const gd::String &oldName,

                            const gd::String &newName);

   static void RenameExternalLayout(gd::Project &project,

                                    const gd::String &oldName,

                                    const gd::String &newName);

   static void RenameExternalEvents(gd::Project &project,

                                    const gd::String &oldName,

                                    const gd::String &newName);

   static void RenameLayer(gd::Project &project, gd::Layout &layout,

                           const gd::String &oldName, const gd::String &newName);


   static void RenameLayerEffect(gd::Project &project, gd::Layout &layout,

                                 gd::Layer &layer, const gd::String &oldName,

                                 const gd::String &newName);


   static void RenameObjectAnimation(gd::Project &project, gd::Layout &layout,

                                     gd::Object &object,

                                     const gd::String &oldName,

                                     const gd::String &newName);


   static void RenameObjectPoint(gd::Project &project, gd::Layout &layout,

                                 gd::Object &object, const gd::String &oldName,

                                 const gd::String &newName);


   static void RenameObjectEffect(gd::Project &project, gd::Layout &layout,

                                  gd::Object &object, const gd::String &oldName,

                                  const gd::String &newName);


   static void ObjectOrGroupRenamedInLayout(gd::Project& project,

                                            gd::Layout& layout,

                                            const gd::String& oldName,

                                            const gd::String& newName,

                                            bool isObjectGroup);


   static void ObjectOrGroupRemovedInLayout(gd::Project& project,

                                            gd::Layout& layout,

                                            const gd::String& objectName,

                                            bool isObjectGroup,

                                            bool removeEventsAndGroups = true);


   static void ObjectOrGroupRemovedInEventsBasedObject(

       gd::Project& project,

       gd::EventsBasedObject& eventsBasedObject,

       gd::ObjectsContainer& globalObjectsContainer,

       gd::ObjectsContainer& objectsContainer,

       const gd::String& objectName,

       bool isObjectGroup,

       bool removeEventsAndGroups);


   static void ObjectOrGroupRenamedInEventsBasedObject(

       gd::Project& project,

       gd::ObjectsContainer& globalObjectsContainer,

       gd::EventsBasedObject& eventsBasedObject,

       const gd::String& oldName,

       const gd::String& newName,

       bool isObjectGroup);


   static void ObjectOrGroupRenamedInEventsFunction(

       gd::Project& project,

       gd::EventsFunction& eventsFunction,

       gd::ObjectsContainer& globalObjectsContainer,

       gd::ObjectsContainer& objectsContainer,

       const gd::String& oldName,

       const gd::String& newName,

       bool isObjectGroup);


   static void ObjectOrGroupRemovedInEventsFunction(

       gd::Project& project,

       gd::EventsFunction& eventsFunction,

       gd::ObjectsContainer& globalObjectsContainer,

       gd::ObjectsContainer& objectsContainer,

       const gd::String& objectName,

       bool isObjectGroup,

       bool removeEventsAndGroups = true);


   static void GlobalObjectOrGroupRenamed(gd::Project& project,

                                          const gd::String& oldName,

                                          const gd::String& newName,

                                          bool isObjectGroup);


   static void GlobalObjectOrGroupRemoved(gd::Project& project,

                                          const gd::String& objectName,

                                          bool isObjectGroup,

                                          bool removeEventsAndGroups = true);


   static std::set<gd::String> GetAllObjectTypesUsingEventsBasedBehavior(

       const gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedBehavior& eventsBasedBehavior);


   static void EnsureBehaviorEventsFunctionsProperParameters(

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedBehavior& eventsBasedBehavior);


   static void EnsureObjectEventsFunctionsProperParameters(

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::EventsBasedObject& eventsBasedObject);


   static void RemoveLayer(gd::Project &project, gd::Layout &layout,

                           const gd::String &layerName);


   static void MergeLayers(gd::Project &project, gd::Layout &layout,

                           const gd::String &originLayerName,

                           const gd::String &targetLayerName);


   static size_t GetLayoutAndExternalLayoutLayerInstancesCount(

       gd::Project &project, gd::Layout &layout, const gd::String &layerName);


   virtual ~WholeProjectRefactorer(){};


  private:

   static std::vector<gd::String> GetAssociatedExternalLayouts(

       gd::Project& project, gd::Layout& layout);

   static std::vector<gd::String>

   GetAssociatedExternalLayouts(gd::Project &project,

                                const gd::String &layoutName);

   static std::vector<gd::String>

   GetAssociatedExternalEvents(gd::Project &project,

                                const gd::String &layoutName);


   static void DoRenameEventsFunction(gd::Project& project,

                                      const gd::EventsFunction& eventsFunction,

                                      const gd::String& oldFullType,

                                      const gd::String& newFullType,

                                      const gd::ProjectBrowser& projectBrowser);


   static void DoRenameBehavior(gd::Project& project,

                                const gd::String& oldBehaviorType,

                                const gd::String& newBehaviorType,

                                const gd::ProjectBrowser& projectBrowser);


   static void DoRenameObject(gd::Project& project,

                              const gd::String& oldObjectType,

                              const gd::String& newObjectType,

                              const gd::ProjectBrowser& projectBrowser);


   static void RenameEventsFunctionsExtension(

       gd::Project& project,

       const gd::EventsFunctionsExtension& eventsFunctionsExtension,

       const gd::String& oldName,

       const gd::String& newName,

       const gd::ProjectBrowser& projectBrowser);


   static void FindDependentBehaviorNames(

       const gd::Project& project,

       const gd::Object& object,

       const gd::String& behaviorName,

       std::unordered_set<gd::String>& dependentBehaviorNames);


   static const gd::String behaviorObjectParameterName;

   static const gd::String parentObjectParameterName;


   WholeProjectRefactorer(){};

 };


 }  // namespace gd

gd::EventsBasedBehavior
Represents a behavior that is implemented with events.
Definition: EventsBasedBehavior.h:31

gd::EventsBasedObject
Represents an object that is implemented with events.
Definition: EventsBasedObject.h:29

gd::EventsFunction
Events that can be generated as a stand-alone function, and used as a condition, action or expression...
Definition: EventsFunction.h:39

gd::EventsFunctionsExtension
Hold a list of Events Functions (gd::EventsFunction) and Events Based Behaviors.
Definition: EventsFunctionsExtension.h:38

gd::Layer
Represents a layer of a layout.
Definition: Layer.h:91

gd::Layout
Represent a layout ( also called a scene ) of a project.
Definition: Layout.h:39

gd::Object
Represent an object of a platform.
Definition: Object.h:37

gd::ObjectsContainer
Used as a base class for classes that will own objects (see gd::Object).
Definition: ObjectsContainer.h:36

gd::ProjectBrowser
Expose a subset of the project to workers.
Definition: ProjectBrowser.h:29

gd::Project
Base class representing a project (game), including all resources, scenes, objects,...
Definition: Project.h:50

gd::SerializerElement
A generic container that can represent a value ( containing a string, double, bool or int),...
Definition: SerializerElement.h:37

gd::String
String represents an UTF8 encoded string.
Definition: String.h:31

gd::VariablesContainer
Class defining a container for gd::Variable.
Definition: VariablesContainer.h:30

gd::WholeProjectRefactorer
Tool functions to do refactoring on the whole project after changes like deletion or renaming of an o...
Definition: WholeProjectRefactorer.h:58

gd
Definition: CommonTools.h:24

gd::VariablesChangeset
Definition: WholeProjectRefactorer.h:41