Merge pull request #193 from Laupetin/feature/improve-info-string-logging

feat: improve info string logging

src/ObjCommon/InfoString/InfoString.cpp

@@ -1,6 +1,7 @@
 #include "InfoString.h"
 
 #include <cstring>
+#include <iostream>
 #include <sstream>
 #include <stack>
 
@@ -170,17 +171,36 @@ bool InfoString::FromStream(const std::string& prefix, std::istream& stream)
 
     std::string readPrefix;
     if (!infoStream.NextField(readPrefix))
+    {
+        std::cerr << "Invalid info string: Empty\n";
         return false;
+    }
 
     if (prefix != readPrefix)
+    {
+        std::cerr << "Invalid info string: Prefix \"" << readPrefix << "\" did not match expected prefix \"" << prefix << "\"\n";
         return false;
+    }
 
     std::string key;
     while (infoStream.NextField(key))
     {
+        if (key.empty())
+        {
+            if (m_keys_by_insertion.empty())
+                std::cerr << "Invalid info string: Got empty key at the start of the info string\n";
+            else
+                std::cerr << "Invalid info string: Got empty key after key \"" << m_keys_by_insertion[m_keys_by_insertion.size() - 1] << "\"\n";
+
+            return false;
+        }
+
         std::string value;
         if (!infoStream.NextField(value))
+        {
+            std::cerr << "Invalid info string: Unexpected eof, no value for key \"" << key << "\"\n";
             return false;
+        }
 
         const auto existingEntry = m_values.find(key);
         if (existingEntry == m_values.end())

src/ObjLoading/Game/IW4/AssetLoaders/AssetLoaderPhysPreset.cpp

@@ -126,7 +126,7 @@ bool AssetLoaderPhysPreset::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_PHYS_PRESET, *file.m_stream))
     {
-        std::cout << "Failed to read phys preset raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/IW4/AssetLoaders/AssetLoaderWeapon.cpp

@@ -440,7 +440,7 @@ bool AssetLoaderWeapon::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_WEAPON, *file.m_stream))
     {
-        std::cerr << "Failed to read weapon raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/IW5/AssetLoaders/AssetLoaderWeapon.cpp

@@ -870,7 +870,7 @@ bool AssetLoaderWeapon::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_WEAPON, *file.m_stream))
     {
-        std::cerr << "Failed to read weapon raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderPhysConstraints.cpp

@@ -146,7 +146,7 @@ bool AssetLoaderPhysConstraints::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_PHYS_CONSTRAINTS, *file.m_stream))
     {
-        std::cout << "Failed to read phys constraints raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderPhysPreset.cpp

@@ -129,7 +129,7 @@ bool AssetLoaderPhysPreset::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_PHYS_PRESET, *file.m_stream))
     {
-        std::cout << "Failed to read phys preset raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderTracer.cpp

@@ -112,7 +112,7 @@ bool AssetLoaderTracer::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_TRACER, *file.m_stream))
     {
-        std::cout << "Failed to read tracer raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderVehicle.cpp

@@ -175,7 +175,7 @@ bool AssetLoaderVehicle::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_VEHICLE, *file.m_stream))
     {
-        std::cout << "Failed to read vehicle raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderWeapon.cpp

@@ -621,7 +621,7 @@ bool AssetLoaderWeapon::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_WEAPON, *file.m_stream))
     {
-        std::cerr << "Failed to read weapon raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderWeaponAttachment.cpp

@@ -165,7 +165,7 @@ bool AssetLoaderWeaponAttachment::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_WEAPON_ATTACHMENT, *file.m_stream))
     {
-        std::cerr << "Failed to read attachment raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderWeaponAttachmentUnique.cpp

@@ -285,7 +285,7 @@ bool AssetLoaderWeaponAttachmentUnique::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_WEAPON_ATTACHMENT_UNIQUE, *file.m_stream))
     {
-        std::cerr << "Failed to read attachment unique raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }
 

src/ObjLoading/Game/T6/AssetLoaders/AssetLoaderZBarrier.cpp

@@ -126,7 +126,7 @@ bool AssetLoaderZBarrier::LoadFromRaw(
     InfoString infoString;
     if (!infoString.FromStream(ObjConstants::INFO_STRING_PREFIX_ZBARRIER, *file.m_stream))
     {
-        std::cout << "Failed to read zbarrier raw file: \"" << fileName << "\"\n";
+        std::cerr << "Could not parse as info string file: \"" << fileName << "\"\n";
         return true;
     }