Code/CryEngine/CrySchematyc2/Script/Elements/ScriptAbstractInterfaceFunction.cpp

   1 // Copyright 2001-2019 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #include "StdAfx.h"
   4 #include "Script/Elements/ScriptAbstractInterfaceFunction.h"
   5
   6 #include <CrySerialization/BlackBox.h>
   7 #include <CrySerialization/IArchiveHost.h>
   8 #include <CrySerialization/STL.h>
   9 #include <CrySchematyc2/GUIDRemapper.h>
  10 #include <CrySchematyc2/Deprecated/DocUtils.h>
  11 #include <CrySchematyc2/Env/IEnvRegistry.h>
  12 #include <CrySchematyc2/Serialization/ISerializationContext.h>
  13 #include <CrySchematyc2/Serialization/SerializationUtils.h>
  14
  15 namespace Schematyc2
  16 {
  17         //////////////////////////////////////////////////////////////////////////
  18         CScriptAbstractInterfaceFunction::CScriptAbstractInterfaceFunction(IScriptFile& file, const SGUID& guid, const SGUID& scopeGUID, const char* szName)
  19                 : CScriptElementBase(EScriptElementType::AbstractInterfaceFunction, file)
  20                 , m_guid(guid)
  21                 , m_scopeGUID(scopeGUID)
  22                 , m_name(szName)
  23         {}
  24
  25         //////////////////////////////////////////////////////////////////////////
  26         EAccessor CScriptAbstractInterfaceFunction::GetAccessor() const
  27         {
  28                 return EAccessor::Private;
  29         }
  30
  31         //////////////////////////////////////////////////////////////////////////
  32         SGUID CScriptAbstractInterfaceFunction::GetGUID() const
  33         {
  34                 return m_guid;
  35         }
  36
  37         //////////////////////////////////////////////////////////////////////////
  38         SGUID CScriptAbstractInterfaceFunction::GetScopeGUID() const
  39         {
  40                 return m_scopeGUID;
  41         }
  42
  43         //////////////////////////////////////////////////////////////////////////
  44         bool CScriptAbstractInterfaceFunction::SetName(const char* szName)
  45         {
  46                 m_name = szName;
  47                 return true;
  48         }
  49
  50         //////////////////////////////////////////////////////////////////////////
  51         const char* CScriptAbstractInterfaceFunction::GetName() const
  52         {
  53                 return m_name.c_str();
  54         }
  55
  56         //////////////////////////////////////////////////////////////////////////
  57         void CScriptAbstractInterfaceFunction::EnumerateDependencies(const ScriptDependancyEnumerator& enumerator) const
  58         {
  59                 SCHEMATYC2_SYSTEM_ASSERT(enumerator);
  60                 if(enumerator)
  61                 {
  62                         for(const CScriptVariableDeclaration& input : m_inputs)
  63                         {
  64                                 input.EnumerateDependencies(enumerator);
  65                         }
  66                         for(const CScriptVariableDeclaration& output : m_outputs)
  67                         {
  68                                 output.EnumerateDependencies(enumerator);
  69                         }
  70                 }
  71         }
  72
  73         //////////////////////////////////////////////////////////////////////////
  74         void CScriptAbstractInterfaceFunction::Refresh(const SScriptRefreshParams& params)
  75         {
  76                 if(params.reason == EScriptRefreshReason::EditorAdd)
  77                 {
  78                         m_userDocumentation.SetCurrentUserAsAuthor();
  79                 }
  80         }
  81
  82         //////////////////////////////////////////////////////////////////////////
  83         void CScriptAbstractInterfaceFunction::Serialize(Serialization::IArchive& archive)
  84         {
  85                 CRY_PROFILE_FUNCTION(PROFILE_LOADING_ONLY);
  86
  87                 CScriptElementBase::Serialize(archive);
  88
  89                 SerializationContext::SetValidatorLink(archive, SValidatorLink(m_guid)); // #SchematycTODO : Can we set this from CScriptElementBase?
  90                 switch(SerializationContext::GetPass(archive))
  91                 {
  92                 case ESerializationPass::PreLoad:
  93                         {
  94                                 archive(m_guid, "guid");
  95                                 archive(m_scopeGUID, "scope_guid");
  96                                 archive(m_name, "name");
  97                                 archive(m_inputs, "inputs");
  98                                 archive(m_outputs, "outputs");
  99                                 archive(m_userDocumentation, "userDocumentation", "Documentation");
 100                                 break;
 101                         }
 102                 case ESerializationPass::Load:
 103                         {
 104                                 archive(m_inputs, "inputs");
 105                                 archive(m_outputs, "outputs");
 106                                 break;
 107                         }
 108                 case ESerializationPass::Save:
 109                         {
 110                                 Serialization::SContext fileContext(archive, static_cast<IScriptFile*>(&CScriptElementBase::GetFile())); // #SchematycTODO : Do we still need this?
 111                                 archive(m_guid, "guid");
 112                                 archive(m_scopeGUID, "scope_guid");
 113                                 archive(m_name, "name");
 114                                 archive(m_inputs, "inputs");
 115                                 archive(m_outputs, "outputs");
 116                                 archive(m_userDocumentation, "userDocumentation", "Documentation");
 117                                 break;
 118                         }
 119                 case ESerializationPass::Edit:
 120                         {
 121                                 Serialization::SContext fileContext(archive, static_cast<IScriptFile*>(&CScriptElementBase::GetFile())); // #SchematycTODO : Do we still need this?
 122                                 archive(m_inputs, "inputs", "Inputs");
 123                                 archive(m_outputs, "outputs", "Outputs");
 124                                 archive(m_userDocumentation, "userDocumentation", "Documentation");
 125                                 break;
 126                         }
 127                 }
 128         }
 129
 130         //////////////////////////////////////////////////////////////////////////
 131         void CScriptAbstractInterfaceFunction::RemapGUIDs(IGUIDRemapper& guidRemapper)
 132         {
 133                 m_guid      = guidRemapper.Remap(m_guid);
 134                 m_scopeGUID = guidRemapper.Remap(m_scopeGUID);
 135         }
 136
 137         //////////////////////////////////////////////////////////////////////////
 138         const char* CScriptAbstractInterfaceFunction::GetAuthor() const
 139         {
 140                 return m_userDocumentation.author.c_str();
 141         }
 142
 143         //////////////////////////////////////////////////////////////////////////
 144         const char* CScriptAbstractInterfaceFunction::GetDescription() const
 145         {
 146                 return m_userDocumentation.description.c_str();
 147         }
 148
 149         //////////////////////////////////////////////////////////////////////////
 150         size_t CScriptAbstractInterfaceFunction::GetInputCount() const
 151         {
 152                 return m_inputs.size();
 153         }
 154
 155         //////////////////////////////////////////////////////////////////////////
 156         const char* CScriptAbstractInterfaceFunction::GetInputName(size_t inputIdx) const
 157         {
 158                 return inputIdx < m_inputs.size() ? m_inputs[inputIdx].GetName() : "";
 159         }
 160
 161         //////////////////////////////////////////////////////////////////////////
 162         IAnyConstPtr CScriptAbstractInterfaceFunction::GetInputValue(size_t inputIdx) const
 163         {
 164                 return inputIdx < m_inputs.size() ? m_inputs[inputIdx].GetValue() : IAnyConstPtr();
 165         }
 166
 167         //////////////////////////////////////////////////////////////////////////
 168         size_t CScriptAbstractInterfaceFunction::GetOutputCount() const
 169         {
 170                 return m_outputs.size();
 171         }
 172
 173         //////////////////////////////////////////////////////////////////////////
 174         const char* CScriptAbstractInterfaceFunction::GetOutputName(size_t outputIdx) const
 175         {
 176                 return outputIdx < m_outputs.size() ? m_outputs[outputIdx].GetName() : "";
 177         }
 178
 179         //////////////////////////////////////////////////////////////////////////
 180         IAnyConstPtr CScriptAbstractInterfaceFunction::GetOutputValue(size_t outputIdx) const
 181         {
 182                 return outputIdx < m_outputs.size() ? m_outputs[outputIdx].GetValue() : IAnyConstPtr();
 183         }
 184 }