Code/CryEngine/CrySchematyc2/Script/ScriptSerializationUtils.h

   1 // Copyright 2001-2019 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #pragma once
   4
   5 #include "CrySerialization/BlackBox.h"
   6
   7 #include <CrySchematyc2/Script/IScriptFile.h>
   8 #include <CrySchematyc2/Script/IScriptGraph.h>
   9 #include <CrySchematyc2/Serialization/ISerializationContext.h>
  10
  11 namespace Schematyc2
  12 {
  13         namespace DocSerializationUtils
  14         {
  15                 DECLARE_SHARED_POINTERS(IScriptElement)
  16
  17                 class CDocGraphFactory // #SchematycTODO : Combine with CScriptElementFactory?
  18                 {
  19                 public:
  20
  21                         IDocGraphPtr CreateGraph(IScriptFile& file, const SGUID& guid, const SGUID& scopeGUID, const char* szName, EScriptGraphType type, const SGUID& contextGUID);
  22                 };
  23
  24                 // #SchematycTODO : Move to separate file .cpp and .h files and/or to IFramework?
  25                 // #SchematycTODO : Resolve disconnect between factory method used to construct elements during serialization and in place methods used when editing?
  26                 class CScriptElementFactory
  27                 {
  28                 public:
  29
  30                         CScriptElementFactory();
  31
  32                         void SetDefaultElementType(EScriptElementType defaultElementType);
  33                         IScriptElementPtr CreateElement(IScriptFile& file, EScriptElementType elementType);
  34                         IScriptElementPtr CreateElement(Serialization::IArchive& archive, const char* szName);
  35
  36                 private:
  37
  38                         EScriptElementType m_defaultElementType; // N.B. This is a hack to work around the fact that elements are located in discreet sections of each file. In future we should inline element type.
  39                 };
  40
  41                 class CInputBlock
  42                 {
  43                 public:
  44
  45                         typedef std::vector<size_t> DependencyIndices;
  46
  47                         struct SElement
  48                         {
  49                                 SElement();
  50
  51                                 void Serialize(Serialization::IArchive& archive);
  52
  53                                 IScriptElementPtr        ptr;
  54                                 Serialization::SBlackBox blackBox;
  55                                 ESerializationPass       serializationPass;
  56                                 DependencyIndices        dependencyIndices;
  57                                 size_t                   sortPriority;
  58                         };
  59
  60                         typedef std::vector<SElement> Elements;
  61
  62                 public:
  63
  64                         CInputBlock(IScriptFile& file);
  65
  66                         void Serialize(Serialization::IArchive& archive);
  67                         void BuildElementHierarchy(IScriptElement& root);
  68                         void SortElementsByDependency();
  69                         Elements& GetElements();
  70
  71                 private:
  72
  73                         void AppendElements(Elements& dst, const Elements& src) const;
  74                         void EraseEmptyElements(Elements &elements) const;
  75                         void SortElementsByDependency(Elements &elements);
  76                         void VerifyElementDependencies(const Elements &elements);
  77
  78                 private:
  79
  80                         IScriptFile& m_file;
  81                         Elements     m_elements;
  82                 };
  83
  84                 extern CDocGraphFactory      g_docGraphFactory;
  85                 extern CScriptElementFactory g_scriptElementFactory;
  86         }
  87 }