Fixes to filesystem classes. Stuff now matches ZH WB much more closely. (#781)

Author: jonwil

src/game/client/gametext.cpp

@@ -343,7 +343,7 @@ void GameTextManager::Reverse_Word(char *start, char *end)
 // Get the count of strings in a str file.
 bool GameTextManager::Get_String_Count(const char *filename, int &count)
 {
-    File *file = g_theFileSystem->Open(filename, File::TEXT | File::READ);
+    File *file = g_theFileSystem->Open_File(filename, File::TEXT | File::READ);
     count = 0;
 
     if (file == nullptr) {
@@ -375,7 +375,7 @@ bool GameTextManager::Get_CSF_Info(const char *filename)
 {
     static_assert(sizeof(CSFHeader) == 24, "CSFHeader struct not expected size.");
     CSFHeader header;
-    File *file = g_theFileSystem->Open(filename, File::BINARY | File::READ);
+    File *file = g_theFileSystem->Open_File(filename, File::BINARY | File::READ);
 
     if (file == nullptr || file->Read(&header, sizeof(header)) != sizeof(header)
         || header.id != FourCC<' ', 'F', 'S', 'C'>::value) {
@@ -399,7 +399,7 @@ bool GameTextManager::Get_CSF_Info(const char *filename)
 bool GameTextManager::Parse_String_File(const char *filename)
 {
     captainslog_info("Parsing string file '%s'.", filename);
-    File *file = g_theFileSystem->Open(filename, File::TEXT | File::READ);
+    File *file = g_theFileSystem->Open_File(filename, File::TEXT | File::READ);
 
     if (file == nullptr) {
         return false;
@@ -485,7 +485,7 @@ bool GameTextManager::Parse_CSF_File(const char *filename)
 {
     captainslog_info("Parsing CSF file '%s'.", filename);
     CSFHeader header;
-    File *file = g_theFileSystem->Open(filename, File::BINARY | File::READ);
+    File *file = g_theFileSystem->Open_File(filename, File::BINARY | File::READ);
 
     if (file == nullptr || file->Read(&header, sizeof(header)) != sizeof(header)) {
         return false;
@@ -588,7 +588,7 @@ bool GameTextManager::Parse_CSF_File(const char *filename)
 bool GameTextManager::Parse_Map_String_File(const char *filename)
 {
     captainslog_info("Parsing map string file '%s'.", filename);
-    File *file = g_theFileSystem->Open(filename, File::TEXT | File::READ);
+    File *file = g_theFileSystem->Open_File(filename, File::TEXT | File::READ);
 
     if (file == nullptr) {
         return false;

src/game/client/shadermanager.cpp

@@ -409,7 +409,7 @@ long W3DShaderManager::Load_And_Create_D3D_Shader(
     if (W3DShaderManager::Get_Chipset() < GPU_PS11) {
         return E_FAIL;
     }
-    File *file = g_theFileSystem->Open(path, File::BINARY | File::READ);
+    File *file = g_theFileSystem->Open_File(path, File::BINARY | File::READ);
 
     if (file == nullptr) {
         captainslog_debug("Could not find file \n");

src/game/client/water/w3dwatertracks.cpp

@@ -799,7 +799,7 @@ void WaterTracksRenderSystem::Load_Tracks()
         char fname[256];
         strcpy(fname, filename.Str());
         strcpy(&fname[strlen(fname) - 4], ".wak");
-        File *f = g_theFileSystem->Open(fname, File::BINARY | File::READ);
+        File *f = g_theFileSystem->Open_File(fname, File::BINARY | File::READ);
         int count = 0;
         int flip = 0;
         Vector2 start;

src/game/client/worldheightmap.cpp

@@ -793,11 +793,11 @@ void WorldHeightMap::Read_Tex_Class(TXTextureClass *tex_class, TileData **tile_d
     TerrainType *terrain = g_theTerrainTypes->Find_Terrain(tex_class->name);
 
     if (!terrain) {
-        file = g_theFileSystem->Open(tex_class->name, File::BINARY | File::READ);
+        file = g_theFileSystem->Open_File(tex_class->name, File::BINARY | File::READ);
     } else {
         char fname[260];
         sprintf(fname, "%s%s", "Art/Terrain/", terrain->Get_Texture().Str());
-        file = g_theFileSystem->Open(fname, File::BINARY | File::READ);
+        file = g_theFileSystem->Open_File(fname, File::BINARY | File::READ);
     }
 
     if (file) {

src/game/common/audio/audioeventrts.cpp

@@ -454,7 +454,7 @@ Utf8String AudioEventRTS::Generate_Filename_Extension(AudioType type)
 void AudioEventRTS::Adjust_For_Localization(Utf8String &filename)
 {
     // Search for both posix and windows path separator, original only searches windows.
-    char *tmp = filename.Reverse_Find('/');
+    const char *tmp = filename.Reverse_Find('/');
 
     if (tmp == nullptr) {
         tmp = filename.Reverse_Find('\\');

src/game/common/audio/audiomanager.cpp

@@ -92,7 +92,7 @@ void AudioManager::Init()
 
     if (!Is_Music_Already_Loaded()) {
         m_fromCD = true;
-        captainslog_warn("Music not detected as loaded, this shouldn't happen with released game data.");
+        captainslog_dbgassert(false, "Music not detected as loaded, this shouldn't happen with released game data.");
         // Original code prompts to insert disc at this point, but it shouldn't be possible with the shipped
         // installer to install without the audio installed to the hard drive.
     }

src/game/common/globaldata.cpp

@@ -1016,15 +1016,15 @@ GlobalData::GlobalData()
     // crc the skirmish and multiplayer scripts.
     int read = 0;
     uint8_t buffer[CRC_BUFFER_SIZE];
-    File *scriptfile = g_theFileSystem->Open("Data/Scripts/SkirmishScripts.scb", File::BINARY | File::READ);
+    File *scriptfile = g_theFileSystem->Open_File("Data/Scripts/SkirmishScripts.scb", File::BINARY | File::READ);
     if (scriptfile) {
         while ((read = scriptfile->Read(buffer, sizeof(buffer))) != 0) {
             crc.Compute_CRC(buffer, read);
         }
 
         scriptfile->Close();
     }
-    scriptfile = g_theFileSystem->Open("Data/Scripts/MultiplayerScripts.scb", File::BINARY | File::READ);
+    scriptfile = g_theFileSystem->Open_File("Data/Scripts/MultiplayerScripts.scb", File::BINARY | File::READ);
     if (scriptfile) {
         while ((read = scriptfile->Read(buffer, sizeof(buffer))) != 0) {
             crc.Compute_CRC(buffer, read);
@@ -1050,7 +1050,7 @@ GlobalData::GlobalData()
 #elif PLATFORM_OSX
 // TODO
 #endif // PLATFORM_WINDOWS
-    g_theFileSystem->Create_Dir(m_userDataDirectory);
+    g_theFileSystem->Create_Directory(m_userDataDirectory);
     m_retaliationModeEnabled = true;
     captainslog_info("User data directory is set to '%s'.", m_userDataDirectory.Str());
 }

src/game/common/ini/ini.cpp

@@ -247,7 +247,7 @@ void INI::Load_Directory(Utf8String dir, bool search_subdirs, INILoadType type,
     std::set<Utf8String, rts::less_than_nocase<Utf8String>> files;
     dir += '/';
 
-    g_theFileSystem->Get_File_List_From_Dir(dir, "*.ini", files, true);
+    g_theFileSystem->Get_File_List_In_Directory(dir, "*.ini", files, true);
 
     // Load everything from the top level directory first.
     for (auto it = files.begin(); it != files.end(); ++it) {
@@ -274,7 +274,7 @@ void INI::Prep_File(Utf8String filename, INILoadType type)
 {
     captainslog_relassert(m_backingFile == nullptr, 0xDEAD0006, "Cannot open file %s, file already open.", filename.Str());
 
-    m_backingFile = g_theFileSystem->Open(filename.Str(), File::READ);
+    m_backingFile = g_theFileSystem->Open_File(filename.Str(), File::READ);
 
     captainslog_relassert(m_backingFile != nullptr, 0xDEAD0006, "Could not open file %s.", filename.Str());
 

src/game/common/system/archivefile.cpp

@@ -14,12 +14,13 @@
  */
 #include "archivefile.h"
 #include "file.h"
+bool Search_String_Matches(Utf8String string, Utf8String search);
 
-ArchivedFileInfo *ArchiveFile::Get_Archived_File_Info(Utf8String const &filename)
+const ArchivedFileInfo *ArchiveFile::Get_Archived_File_Info(Utf8String const &filename) const
 {
     Utf8String path = filename;
     Utf8String token;
-    DetailedArchiveDirectoryInfo *dirp = &m_archiveInfo;
+    const DetailedArchivedDirectoryInfo *dirp = &m_archiveInfo;
 
     // Lower case for matching and get first item of the path.
     path.To_Lower();
@@ -28,102 +29,102 @@ ArchivedFileInfo *ArchiveFile::Get_Archived_File_Info(Utf8String const &filename
     // Consider existence of '.' to indicate file as all should have .ext format
     // checks the remaining path does not contain one to catch directories in path
     // that do.
-    while (strchr(token.Str(), '.') == nullptr || strchr(path.Str(), '.') != nullptr) {
-        if (dirp->directories.find(token) == dirp->directories.end()) {
+    while (token.Find('.') == nullptr || path.Find('.') != nullptr) {
+        auto it = dirp->directories.find(token);
+
+        if (!(it != dirp->directories.end())) {
             return nullptr;
         }
 
-        dirp = &dirp->directories[token];
+        dirp = &it->second;
         path.Next_Token(&token, "\\/");
     }
 
     // Assuming we didn't run out of directories to try, find the file
     // in the reached directory.
     auto file_it = dirp->files.find(token);
 
-    if (file_it == dirp->files.end()) {
-        return nullptr;
+    if (file_it != dirp->files.end()) {
+        return &file_it->second;
     }
 
-    return &file_it->second;
+    return nullptr;
 }
 
 void ArchiveFile::Add_File(Utf8String const &filepath, ArchivedFileInfo const *info)
 {
-    // DEBUG_LOG("Adding '%s' to interal archive for '%s'.\n", filepath.Str(), info->archive_name.Str());
     Utf8String path = filepath;
     Utf8String token;
-    DetailedArchiveDirectoryInfo *dirp = &m_archiveInfo;
-
-    // Lower case for matching and get first item of the path.
+    DetailedArchivedDirectoryInfo *dirp = &m_archiveInfo;
     path.To_Lower();
+    path.Next_Token(&token, "\\/");
 
-    for (path.Next_Token(&token, "\\/"); !token.Is_Empty(); path.Next_Token(&token, "\\/")) {
-        // If an element of the path doesn't have a directory node, add it.
-        // DEBUG_LOG("Searching for path element '%s'.\n", token.Str());
+    while (token.Get_Length() > 0) {
         if (dirp->directories.find(token) == dirp->directories.end()) {
-            // DEBUG_LOG("Adding path element '%s'.\n", token.Str());
+            dirp->directories[token].Clear();
             dirp->directories[token].name = token;
         }
 
         dirp = &dirp->directories[token];
+        path.Next_Token(&token, "\\/");
     }
 
     dirp->files[info->file_name] = *info;
 }
 
 void ArchiveFile::Attach_File(File *file)
 {
-    if (m_backingFile != nullptr) {
-        m_backingFile->Close();
-        m_backingFile = nullptr;
+    if (m_attachedFile != nullptr) {
+        m_attachedFile->Close();
+        m_attachedFile = nullptr;
     }
 
-    m_backingFile = file;
+    m_attachedFile = file;
 }
 
-void ArchiveFile::Get_File_List_From_Dir(Utf8String const &subdir,
+void ArchiveFile::Get_File_List_In_Directory(Utf8String const &subdir,
     Utf8String const &dirpath,
     Utf8String const &filter,
     std::set<Utf8String, rts::less_than_nocase<Utf8String>> &filelist,
     bool search_subdir) const
 {
     Utf8String path = dirpath;
+    path.To_Lower();
     Utf8String token;
-    DetailedArchiveDirectoryInfo const *dirp = &m_archiveInfo;
+    DetailedArchivedDirectoryInfo const *dirp = &m_archiveInfo;
+    path.Next_Token(&token, "\\/");
 
-    // Lower case for matching and get first item of the path.
-    path.To_Lower();
+    while (token.Get_Length() > 0) {
+        auto it = dirp->directories.find(token);
 
-    // Go to the last InfoNode in the path to extract file contents from.
-    for (path.Next_Token(&token, "\\/"); token.Is_Not_Empty(); path.Next_Token(&token, "\\/")) {
-        // If an element of the path doesn't have a node for our next directory, return.
-        if (dirp->directories.find(token) == dirp->directories.end()) {
+        if (!(it != dirp->directories.end())) {
             return;
         }
 
-        dirp = &dirp->directories[token];
+        dirp = &it->second;
+        path.Next_Token(&token, "\\/");
     }
 
-    Get_File_List_From_Dir(dirp, dirpath, filter, filelist, search_subdir);
+    Get_File_List_In_Directory(dirp, dirpath, filter, filelist, search_subdir);
 }
 
-void ArchiveFile::Get_File_List_From_Dir(DetailedArchiveDirectoryInfo const *dir_info,
+void ArchiveFile::Get_File_List_In_Directory(DetailedArchivedDirectoryInfo const *dir_info,
     Utf8String const &dirpath,
     Utf8String const &filter,
     std::set<Utf8String, rts::less_than_nocase<Utf8String>> &filelist,
     bool search_subdir) const
 {
     // Add the files from any subdirectories, recursive call.
     for (auto it = dir_info->directories.begin(); it != dir_info->directories.end(); ++it) {
+        const DetailedArchivedDirectoryInfo *info = &it->second;
         Utf8String path = dirpath;
 
-        if (!path.Is_Empty() && !path.Ends_With("\\") && !path.Ends_With("/")) {
-            path += "/";
+        if (path.Get_Length() > 0 && !path.Ends_With("\\") && !path.Ends_With("/")) {
+            path.Concat("/");
         }
 
-        path += it->second.name;
-        Get_File_List_From_Dir(&(it->second), path, filter, filelist, search_subdir);
+        path += info->name;
+        Get_File_List_In_Directory(info, path, filter, filelist, search_subdir);
     }
 
     // Add all the files that match the search pattern.
@@ -132,25 +133,30 @@ void ArchiveFile::Get_File_List_From_Dir(DetailedArchiveDirectoryInfo const *dir
             Utf8String path = dirpath;
 
             if (!path.Is_Empty() && !path.Ends_With("\\") && !path.Ends_With("/")) {
-                path += "/";
+                path.Concat("/");
             }
 
             path += it->second.file_name;
+
             filelist.insert(path);
         }
     }
 }
 
 // Helper funtion to check if a string matches the search string.
-bool ArchiveFile::Search_String_Matches(Utf8String string, Utf8String search)
+bool Search_String_Matches(Utf8String string, Utf8String search)
 {
     // Trivial case if first string is empty.
-    if (string.Is_Empty()) {
-        return search.Is_Empty();
+    if (string.Get_Length() == 0) {
+        if (search.Get_Length() == 0) {
+            return true;
+        }
+
+        return false;
     }
 
     // If there is no seach string, there cannot be a match.
-    if (search.Is_Empty()) {
+    if (search.Get_Length() == 0) {
         return false;
     }
 
@@ -195,5 +201,9 @@ bool ArchiveFile::Search_String_Matches(Utf8String string, Utf8String search)
         }
     }
 
-    return *csearch == '\0';
+    if (*csearch == '\0') {
+        return true;
+    } else {
+        return false;
+    }
 }