Raw data loading option for engineLoadIFP (#247)

samr46 · saml1er · commit 3b68f4c606b0 · 2018-07-22T06:33:33.000+05:00
* Modified function: engineLoadIFP
New syntax: engineLoadIFP ( string ifp_file / string raw_data, string CustomBlockName )

Added option to use raw data instead of a file name.

* Variables rename
diff --git a/Client/mods/deathmatch/logic/CClientIFP.cpp b/Client/mods/deathmatch/logic/CClientIFP.cpp
@@ -24,22 +24,22 @@ CClientIFP::CClientIFP(class CClientManager* pManager, ElementID ID) : CClientEn
     m_u32Hashkey = 0;
 }
 
-bool CClientIFP::LoadIFP(const SString& strFilePath, const SString& strBlockName)
+bool CClientIFP::LoadIFP(const SString& strFile, const bool isRawData, const SString& strBlockName)
 {
     m_strBlockName = strBlockName;
     m_pVecAnimations = &m_pIFPAnimations->vecAnimations;
 
-    if (LoadIFPFile(strFilePath))
+    if (LoadIFPFile(strFile, isRawData))
     {
         m_u32Hashkey = HashString(strBlockName.ToLower());
         return true;
     }
     return false;
 }
 
-bool CClientIFP::LoadIFPFile(const SString& strFilePath)
+bool CClientIFP::LoadIFPFile(const SString& strFile, const bool isRawData)
 {
-    if (LoadFileToMemory(strFilePath))
+    if (isRawData ? LoadDataBufferToMemory(strFile) : LoadFileToMemory(strFile))
     {
         if (ReadIFPByVersion())
         {
diff --git a/Client/mods/deathmatch/logic/CClientIFP.h b/Client/mods/deathmatch/logic/CClientIFP.h
@@ -205,7 +205,7 @@ class CClientIFP : public CClientEntity, CFileReader
     void MarkAsUnloading(void) { m_bUnloading = true; }
     bool IsUnloading(void) { return m_bUnloading; }
 
-    bool LoadIFP(const SString& strFilePath, const SString& strBlockName);
+    bool LoadIFP(const SString& strFile, const bool isRawData, const SString& strBlockName);
 
     const SString&      GetBlockName(void) { return m_strBlockName; }
     const unsigned int& GetBlockNameHash(void) { return m_u32Hashkey; }
@@ -219,7 +219,7 @@ class CClientIFP : public CClientEntity, CFileReader
     void SetPosition(const CVector& vecPosition){};
 
 private:
-    bool LoadIFPFile(const SString& strFilePath);
+    bool LoadIFPFile(const SString& strFile, const bool isRawData);
     bool ReadIFPByVersion(void);
     void ReadIFPVersion1(void);
     void ReadIFPVersion2(bool bAnp3);
diff --git a/Client/mods/deathmatch/logic/CFileReader.cpp b/Client/mods/deathmatch/logic/CFileReader.cpp
@@ -45,15 +45,31 @@ void CFileReader::SkipBytes(const std::uint32_t u32BytesToSkip)
 bool CFileReader::LoadFileToMemory(const SString& strFilePath)
 {
     std::ifstream   fileStream(FromUTF8(strFilePath), std::ios::binary | std::ios::ate);
-    std::streamsize m_iFileSize = fileStream.tellg();
-    if (m_iFileSize == eIFSTREAM::SIZE_ERROR)
+    std::streamsize iFileSize = fileStream.tellg();
+    if (iFileSize == eIFSTREAM::SIZE_ERROR)
     {
         return false;
     }
 
     fileStream.seekg(0, std::ios::beg);
-    m_vecFileDataBuffer.reserve(static_cast<size_t>(m_iFileSize));
-    if (fileStream.read(m_vecFileDataBuffer.data(), m_iFileSize))
+    m_vecFileDataBuffer.reserve(static_cast<size_t>(iFileSize));
+    if (fileStream.read(m_vecFileDataBuffer.data(), iFileSize))
+    {
+        return true;
+    }
+    return false;
+}
+
+bool CFileReader::LoadDataBufferToMemory(const SString& buffer)
+{
+    std::streamsize iBufferSize = buffer.size();
+    if (iBufferSize == eIFSTREAM::SIZE_ERROR)
+    {
+        return false;
+    }
+
+    m_vecFileDataBuffer.reserve(static_cast<size_t>(iBufferSize));
+    if (std::copy(buffer.begin(), buffer.end(), m_vecFileDataBuffer.data()))
     {
         return true;
     }
diff --git a/Client/mods/deathmatch/logic/CFileReader.h b/Client/mods/deathmatch/logic/CFileReader.h
@@ -24,6 +24,7 @@ class CFileReader
 
     CFileReader(void);
     bool LoadFileToMemory(const SString& strFilePath);
+    bool LoadDataBufferToMemory(const SString& buffer);
     // Do not call any file reader functions after calling this function
     void FreeFileReaderMemory(void);
 
diff --git a/Client/mods/deathmatch/logic/CIFPEngine.cpp b/Client/mods/deathmatch/logic/CIFPEngine.cpp
@@ -10,7 +10,7 @@
 
 #include <StdInc.h>
 
-std::shared_ptr<CClientIFP> CIFPEngine::EngineLoadIFP(CResource* pResource, CClientManager* pManager, const SString& strPath, const SString& strBlockName)
+std::shared_ptr<CClientIFP> CIFPEngine::EngineLoadIFP(CResource* pResource, CClientManager* pManager, const SString& strFile, bool bIsRawData, const SString& strBlockName)
 {
     // Grab the resource root entity
     CClientEntity*     pRoot = pResource->GetResourceIFPRoot();
@@ -23,7 +23,7 @@ std::shared_ptr<CClientIFP> CIFPEngine::EngineLoadIFP(CResource* pResource, CCli
         std::shared_ptr<CClientIFP> pIFP(new CClientIFP(pManager, INVALID_ELEMENT_ID));
 
         // Try to load the IFP file
-        if (pIFP->LoadIFP(strPath, strBlockName))
+        if (pIFP->LoadIFP(strFile, bIsRawData, strBlockName))
         {
             // We can use the map to retrieve correct IFP by block name later
             g_pClientGame->InsertIFPPointerToMap(u32BlockNameHash, pIFP);
@@ -99,3 +99,9 @@ bool CIFPEngine::EngineRestoreAnimation(CClientEntity* pEntity, const SString& s
     }
     return false;
 }
+
+// Return true if data looks like IFP file contents
+bool CIFPEngine::IsIFPData(const SString& strData)
+{
+    return strData.length() > 32 && memcmp(strData, "\x41\x4E\x50", 3) == 0;
+}
diff --git a/Client/mods/deathmatch/logic/CIFPEngine.h b/Client/mods/deathmatch/logic/CIFPEngine.h
@@ -25,11 +25,12 @@ class CIFPEngine
         ALL
     };
 
-    static std::shared_ptr<CClientIFP> EngineLoadIFP(CResource* pResource, CClientManager* pManager, const SString& strPath, const SString& strBlockName);
+    static std::shared_ptr<CClientIFP> EngineLoadIFP(CResource* pResource, CClientManager* pManager, const SString& strFile, bool bIsRawData, const SString& strBlockName);
     static bool                        EngineReplaceAnimation(CClientEntity* pEntity, const SString& strInternalBlockName, const SString& strInternalAnimName,
                                                               const SString& strCustomBlockName, const SString& strCustomAnimName);
     static bool                        EngineRestoreAnimation(CClientEntity* pEntity, const SString& strInternalBlockName, const SString& strInternalAnimName,
                                                               const eRestoreAnimation& eRestoreType);
+    static bool                        IsIFPData(const SString& strData);
 };
 
 #endif
diff --git a/Client/mods/deathmatch/logic/luadefs/CLuaEngineDefs.cpp b/Client/mods/deathmatch/logic/luadefs/CLuaEngineDefs.cpp
@@ -297,22 +297,23 @@ int CLuaEngineDefs::EngineLoadIFP(lua_State* luaVM)
             CResource* pResource = pLuaMain->GetResource();
             if (pResource)
             {
+                bool bIsRawData = CIFPEngine::IsIFPData(strFile);
                 SString strPath;
                 // Is this a legal filepath?
-                if (CResourceManager::ParseResourcePathInput(strFile, pResource, &strPath))
+                if (bIsRawData || CResourceManager::ParseResourcePathInput(strFile, pResource, &strPath))
                 {
-                    std::shared_ptr<CClientIFP> pIFP = CIFPEngine::EngineLoadIFP(pResource, m_pManager, strPath, strBlockName);
+                    std::shared_ptr<CClientIFP> pIFP = CIFPEngine::EngineLoadIFP(pResource, m_pManager, bIsRawData ? strFile : strPath, bIsRawData, strBlockName);
                     if (pIFP != nullptr)
                     {
                         // Return the IFP element
                         lua_pushelement(luaVM, pIFP.get());
                         return 1;
                     }
                     else
-                        argStream.SetCustomError(strFile, "Error loading IFP");
+                        argStream.SetCustomError(bIsRawData ? "raw data" : strFile, "Error loading IFP");
                 }
                 else
-                    argStream.SetCustomError(strFile, "Bad file path");
+                    argStream.SetCustomError(bIsRawData ? "raw data" : strFile, "Bad file path");
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -24,22 +24,22 @@ CClientIFP::CClientIFP(class CClientManager* pManager, ElementID ID) : CClientEn`
`24`	`24`	`m_u32Hashkey = 0;`
`25`	`25`	`}`
`26`	`26`
`27`		`-bool CClientIFP::LoadIFP(const SString& strFilePath, const SString& strBlockName)`
	`27`	`+bool CClientIFP::LoadIFP(const SString& strFile, const bool isRawData, const SString& strBlockName)`
`28`	`28`	`{`
`29`	`29`	`m_strBlockName = strBlockName;`
`30`	`30`	`m_pVecAnimations = &m_pIFPAnimations->vecAnimations;`
`31`	`31`
`32`		`- if (LoadIFPFile(strFilePath))`
	`32`	`+ if (LoadIFPFile(strFile, isRawData))`
`33`	`33`	`{`
`34`	`34`	`m_u32Hashkey = HashString(strBlockName.ToLower());`
`35`	`35`	`return true;`
`36`	`36`	`}`
`37`	`37`	`return false;`
`38`	`38`	`}`
`39`	`39`
`40`		`-bool CClientIFP::LoadIFPFile(const SString& strFilePath)`
	`40`	`+bool CClientIFP::LoadIFPFile(const SString& strFile, const bool isRawData)`
`41`	`41`	`{`
`42`		`- if (LoadFileToMemory(strFilePath))`
	`42`	`+ if (isRawData ? LoadDataBufferToMemory(strFile) : LoadFileToMemory(strFile))`
`43`	`43`	`{`
`44`	`44`	`if (ReadIFPByVersion())`
`45`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`
`11`	`11`	`#include <StdInc.h>`
`12`	`12`
`13`		`-std::shared_ptr<CClientIFP> CIFPEngine::EngineLoadIFP(CResource* pResource, CClientManager* pManager, const SString& strPath, const SString& strBlockName)`
	`13`	`+std::shared_ptr<CClientIFP> CIFPEngine::EngineLoadIFP(CResource* pResource, CClientManager* pManager, const SString& strFile, bool bIsRawData, const SString& strBlockName)`
`14`	`14`	`{`
`15`	`15`	`// Grab the resource root entity`
`16`	`16`	`CClientEntity* pRoot = pResource->GetResourceIFPRoot();`
`@@ -23,7 +23,7 @@ std::shared_ptr<CClientIFP> CIFPEngine::EngineLoadIFP(CResource* pResource, CCli`
`23`	`23`	`std::shared_ptr<CClientIFP> pIFP(new CClientIFP(pManager, INVALID_ELEMENT_ID));`
`24`	`24`
`25`	`25`	`// Try to load the IFP file`
`26`		`- if (pIFP->LoadIFP(strPath, strBlockName))`
	`26`	`+ if (pIFP->LoadIFP(strFile, bIsRawData, strBlockName))`
`27`	`27`	`{`
`28`	`28`	`// We can use the map to retrieve correct IFP by block name later`
`29`	`29`	`g_pClientGame->InsertIFPPointerToMap(u32BlockNameHash, pIFP);`
`@@ -99,3 +99,9 @@ bool CIFPEngine::EngineRestoreAnimation(CClientEntity* pEntity, const SString& s`
`99`	`99`	`}`
`100`	`100`	`return false;`
`101`	`101`	`}`
	`102`	`+`
	`103`	`+// Return true if data looks like IFP file contents`
	`104`	`+bool CIFPEngine::IsIFPData(const SString& strData)`
	`105`	`+{`
	`106`	`+ return strData.length() > 32 && memcmp(strData, "\x41\x4E\x50", 3) == 0;`
	`107`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -297,22 +297,23 @@ int CLuaEngineDefs::EngineLoadIFP(lua_State* luaVM)`
`297`	`297`	`CResource* pResource = pLuaMain->GetResource();`
`298`	`298`	`if (pResource)`
`299`	`299`	`{`
	`300`	`+ bool bIsRawData = CIFPEngine::IsIFPData(strFile);`
`300`	`301`	`SString strPath;`
`301`	`302`	`// Is this a legal filepath?`
`302`		`- if (CResourceManager::ParseResourcePathInput(strFile, pResource, &strPath))`
	`303`	`+ if (bIsRawData \|\| CResourceManager::ParseResourcePathInput(strFile, pResource, &strPath))`
`303`	`304`	`{`
`304`		`- std::shared_ptr<CClientIFP> pIFP = CIFPEngine::EngineLoadIFP(pResource, m_pManager, strPath, strBlockName);`
	`305`	`+ std::shared_ptr<CClientIFP> pIFP = CIFPEngine::EngineLoadIFP(pResource, m_pManager, bIsRawData ? strFile : strPath, bIsRawData, strBlockName);`
`305`	`306`	`if (pIFP != nullptr)`
`306`	`307`	`{`
`307`	`308`	`// Return the IFP element`
`308`	`309`	`lua_pushelement(luaVM, pIFP.get());`
`309`	`310`	`return 1;`
`310`	`311`	`}`
`311`	`312`	`else`
`312`		`- argStream.SetCustomError(strFile, "Error loading IFP");`
	`313`	`+ argStream.SetCustomError(bIsRawData ? "raw data" : strFile, "Error loading IFP");`
`313`	`314`	`}`
`314`	`315`	`else`
`315`		`- argStream.SetCustomError(strFile, "Bad file path");`
	`316`	`+ argStream.SetCustomError(bIsRawData ? "raw data" : strFile, "Bad file path");`
`316`	`317`	`}`
`317`	`318`	`}`
`318`	`319`	`}`