refac: remove dumb root dir func from pl_string.h

Author: hoffstadt

extensions/pl_vfs_ext.c

@@ -147,6 +147,60 @@ plVfsResult     pl_vfs_mount_memory   (const char* directory, plVfsMountFlags);
 // [SECTION] internal api
 //-----------------------------------------------------------------------------
 
+static bool
+pl__str_get_root_directory(const char* pcFilePath, char* pcDirectoryOut, size_t szOutSize)
+{
+    size_t szLen = strlen(pcFilePath);
+    strncpy(pcDirectoryOut, pcFilePath, szOutSize);
+
+    if(szLen > szOutSize || szOutSize < 2)
+        return false;
+
+    if(pcDirectoryOut[0] == '/' || pcDirectoryOut[0] == '\\')
+    {
+        size_t szCurrentLocation = 1;
+        bool bHit = false;
+        while(szCurrentLocation < szLen)
+        {
+            if(pcDirectoryOut[szCurrentLocation] == '/' || pcDirectoryOut[szCurrentLocation] == '\\')
+            {
+                pcDirectoryOut[szCurrentLocation + 1] = 0;
+                bHit = true;
+                break;
+            }
+
+            szCurrentLocation++;
+        }
+        if(!bHit)
+        {
+            pcDirectoryOut[1] = 0;
+        }
+        return true;
+    }
+    else if(pcDirectoryOut[1] == ':')
+    {
+        size_t szCurrentLocation = 3;
+        while(szCurrentLocation < szLen)
+        {
+            if(pcDirectoryOut[szCurrentLocation] == '/' || pcDirectoryOut[szCurrentLocation] == '\\')
+            {
+                pcDirectoryOut[szCurrentLocation + 1] = 0;
+                break;
+            }
+
+            szCurrentLocation++;
+        }
+        return true;  
+    }
+    else
+    {
+        pcDirectoryOut[0] = '.';
+        pcDirectoryOut[1] = '/';
+        pcDirectoryOut[2] = 0;
+    }
+    return true;
+}
+
 static inline plVfsMemoryFile*
 pl__vfs_get_memory_file(plVfsFileSystem* ptSystem, const char* pcFile)
 {
@@ -176,6 +230,8 @@ pl__vfs_get_memory_file_index(plVfsFileSystem* ptSystem, const char* pcFile)
 static inline plVfsFile*
 pl__vfs_get_file(plVfsFileHandle tHandle)
 {
+    if(tHandle.uData == UINT64_MAX)
+        return NULL;
     if(gptVfsCtx->sbtFiles[tHandle.uIndex].uGeneration != tHandle.uGeneration)
         return NULL;
     return &gptVfsCtx->sbtFiles[tHandle.uIndex];
@@ -186,7 +242,7 @@ pl__vfs_get_system(const char* pcFile)
 {
     // retrieve root directory in order to find expected file system
     char acDirectory[PL_VFS_MAX_PATH_LENGTH] = {0};
-    pl_str_get_root_directory(pcFile, acDirectory, PL_VFS_MAX_PATH_LENGTH);
+    pl__str_get_root_directory(pcFile, acDirectory, PL_VFS_MAX_PATH_LENGTH);
 
     // find file system
     const uint32_t uFileSystemIndexCount = pl_sb_size(gptVfsCtx->sbtFileSystems);
@@ -226,7 +282,7 @@ pl__vfs_register_file(const char* pcFile, bool bMustExist)
     if(ptTargetFileSystem->tType != PL_FILE_SYSTEM_TYPE_PHYSICAL)
     {
         char acDirectory[PL_VFS_MAX_PATH_LENGTH] = {0};
-        pl_str_get_root_directory(pcFile, acDirectory, PL_VFS_MAX_PATH_LENGTH);
+        pl__str_get_root_directory(pcFile, acDirectory, PL_VFS_MAX_PATH_LENGTH);
         szRootLength = strnlen(acDirectory, PL_VFS_MAX_PATH_LENGTH);
     }
 
@@ -490,7 +546,7 @@ pl_vfs_does_file_exist(const char* pcFile)
 
     // retrieve root directory in order to find expected file system
     char acDirectory[PL_VFS_MAX_PATH_LENGTH] = {0};
-    pl_str_get_root_directory(pcFile, acDirectory, PL_VFS_MAX_PATH_LENGTH);
+    pl__str_get_root_directory(pcFile, acDirectory, PL_VFS_MAX_PATH_LENGTH);
     size_t szRootLength = strnlen(acDirectory, PL_VFS_MAX_PATH_LENGTH);
 
     // find file system
@@ -770,7 +826,6 @@ pl_vfs_file_size(const char* pcFile)
     plVfsFile* ptFile = pl__vfs_get_file(tHandle);
     if(ptFile == NULL)
     {
-        PL_ASSERT(false && "file doesn't exist");
         return 0;
     }
     size_t szFileSize = 0;

libs/pl_string.h

@@ -15,8 +15,8 @@
 */
 
 // library version (format XYYZZ)
-#define PL_STRING_VERSION    "1.1.1"
-#define PL_STRING_VERSION_NUM 10101
+#define PL_STRING_VERSION    "1.1.2"
+#define PL_STRING_VERSION_NUM 10102
 
 /*
 Index of this file:
@@ -54,7 +54,6 @@ const char* pl_str_get_file_extension(const char* pcFilePath, char* pcExtensionO
 const char* pl_str_get_file_name     (const char* pcFilePath, char* pcFileOut, size_t szOutSize);
 bool        pl_str_get_file_name_only(const char* pcFilePath, char* pcFileOut, size_t szOutSize);
 bool        pl_str_get_directory     (const char* pcFilePath, char* pcDirectoryOut, size_t szOutSize);
-bool        pl_str_get_root_directory(const char* pcFilePath, char* pcDirectoryOut, size_t szOutSize);
 
 // misc. opts
 bool               pl_str_concatenate    (const char* pcStr0, const char* pcStr1, char* pcStringOut, size_t szDataSize);
@@ -347,48 +346,6 @@ pl_str_get_directory(const char* pcFilePath, char* pcDirectoryOut, size_t szOutS
     return true;
 }
 
-bool
-pl_str_get_root_directory(const char* pcFilePath, char* pcDirectoryOut, size_t szOutSize)
-{
-    size_t szLen = strlen(pcFilePath);
-    strncpy(pcDirectoryOut, pcFilePath, szOutSize);
-
-    if(szLen > szOutSize || szOutSize < 2)
-        return false;
-
-    size_t szCurrentLocation = 0;
-    int iHits = 2;
-    while(szCurrentLocation < szLen)
-    {
-        if(pcDirectoryOut[szCurrentLocation] == '/' || pcDirectoryOut[szCurrentLocation] == '\\')
-        {
-            iHits--;
-        }
-
-        if(iHits == 0)
-        {
-            pcDirectoryOut[szCurrentLocation + 1] = 0;
-            break; 
-        }
-
-        szCurrentLocation++;
-    }
-
-    if(iHits == 1)
-    {
-        pcDirectoryOut[0] = '/';
-        pcDirectoryOut[1] = 0;
-        pcDirectoryOut[2] = 0;
-    }
-    else if(szCurrentLocation == szLen)
-    {
-        pcDirectoryOut[0] = '.';
-        pcDirectoryOut[1] = '/';
-        pcDirectoryOut[2] = 0;
-    }
-    return true;
-}
-
 bool
 pl_str_concatenate(const char* pcStr0, const char* pcStr1, char* pcStringOut, size_t szDataSize)
 {

tests/app_tests.c

@@ -25,6 +25,10 @@ Index of this file:
 #define PL_MATH_INCLUDE_FUNCTIONS
 #include "pl_math.h"
 #include "pl_json.h"
+#include "pl_string.h"
+
+// stable extensions
+#include "pl_platform_ext.h"
 
 // unstable extensions
 #include "pl_collision_ext.h"
@@ -44,6 +48,7 @@ const plDateTimeI*  gptDateTime  = NULL;
 const plVfsI*       gptVfs       = NULL;
 const plPakI*       gptPak       = NULL;
 const plCompressI*  gptCompress  = NULL;
+const plFileI*      gptFile      = NULL;
 
 #define PL_ALLOC(x)      gptMemory->tracked_realloc(NULL, (x), __FILE__, __LINE__)
 #define PL_REALLOC(x, y) gptMemory->tracked_realloc((x), (y), __FILE__, __LINE__)
@@ -70,6 +75,7 @@ typedef struct _plAppData
 void collision_only_tests_0(void*);
 void datetime_tests_0(void*);
 void vfs_tests_0(void*);
+void file_tests_0(void*);
 
 //-----------------------------------------------------------------------------
 // [SECTION] pl_app_info
@@ -170,6 +176,7 @@ pl_app_load(plApiRegistryI* ptApiRegistry, plAppData* ptAppData)
     gptVfs       = pl_get_api_latest(ptApiRegistry, plVfsI);
     gptPak       = pl_get_api_latest(ptApiRegistry, plPakI);
     gptCompress  = pl_get_api_latest(ptApiRegistry, plCompressI);
+    gptFile      = pl_get_api_latest(ptApiRegistry, plFileI);
 
     // this path is taken only during first load, so we
     // allocate app memory here
@@ -179,6 +186,7 @@ pl_app_load(plApiRegistryI* ptApiRegistry, plAppData* ptAppData)
     // mount some directories
     gptVfs->mount_directory("/testing", "../out", PL_VFS_MOUNT_FLAGS_NONE);
     gptVfs->mount_memory("/ram", PL_VFS_MOUNT_FLAGS_NONE);
+    gptVfs->mount_memory("/", PL_VFS_MOUNT_FLAGS_NONE);
 
     plPakFile* ptPak = NULL;
     gptPak->begin_packing("../out/testing.pak", 1, &ptPak);
@@ -200,6 +208,8 @@ pl_app_load(plApiRegistryI* ptApiRegistry, plAppData* ptAppData)
     gptVfs->close_file(tHandle);
     tHandle = gptVfs->open_file("/ram/testing_compressed.json", PL_VFS_FILE_MODE_WRITE);
     szFileSize = gptVfs->write_file(tHandle, puBuffer, szFileSize);
+    tHandle = gptVfs->open_file("/testing_compressed.json", PL_VFS_FILE_MODE_WRITE);
+    szFileSize = gptVfs->write_file(tHandle, puBuffer, szFileSize);
     free(puBuffer);
 
     // create 
@@ -220,6 +230,9 @@ pl_app_load(plApiRegistryI* ptApiRegistry, plAppData* ptAppData)
     pl_test_register_test(vfs_tests_0, ptAppData);
     pl_test_run_suite("pl_vfs_ext.h");
 
+    pl_test_register_test(file_tests_0, ptAppData);
+    pl_test_run_suite("pl_platform_ext.h (plFileI)");
+
     return ptAppData;
 }
 
@@ -379,16 +392,22 @@ vfs_tests_0(void* pAppData)
     gptVfs->close_file(tHandle);
 
 
-    const char* acFiles[3] = {
+    const char* acFiles[] = {
         "/ram/testing_compressed.json",
         "/data/testing_compressed.json",
         "/data/testing_uncompressed.json",
+        "/testing_compressed.json",
     };
 
-    for(uint32_t i = 0; i < 3; i++)
+    for(uint32_t i = 0; i < 4; i++)
     {
 
         size_t szFileSize = gptVfs->get_file_size_str(acFiles[i]);
+        if(szFileSize == 0)
+        {
+            pl_test_expect_true(false, NULL);
+            continue;
+        }
         tHandle = gptVfs->open_file(acFiles[i], PL_VFS_FILE_MODE_READ);
         char* pucBuffer = PL_ALLOC(szFileSize + 1);
         memset(pucBuffer, 0, szFileSize + 1);
@@ -492,6 +511,48 @@ vfs_tests_0(void* pAppData)
     }
 }
 
+void
+file_tests_0(void* pAppData)
+{
+
+    const char** sbcFiles = NULL;
+    pl_sb_push(sbcFiles, "pl_ds.h");
+    pl_sb_push(sbcFiles, "pl_json.h");
+    pl_sb_push(sbcFiles, "pl_log.h");
+    pl_sb_push(sbcFiles, "pl_math.h");
+    pl_sb_push(sbcFiles, "pl_memory.h");
+    pl_sb_push(sbcFiles, "pl_profile.h");
+    pl_sb_push(sbcFiles, "pl_stl.h");
+    pl_sb_push(sbcFiles, "pl_string.h");
+    pl_sb_push(sbcFiles, "pl_test.h");
+
+    plDirectoryInfo tInfo = {0};
+    gptFile->get_directory_info("../libs", &tInfo);
+
+    pl_test_expect_uint32_equal(tInfo.uEntryCount, pl_sb_size(sbcFiles), NULL); 
+
+    bool bFindMath = false;
+    uint32_t uMathIndex = 0;
+    for(uint32_t i = 0; i < tInfo.uEntryCount; i++)
+    {
+
+        if(pl_str_equal(tInfo.sbtEntries[i].acName, "pl_math.h"))
+        {
+            bFindMath = true;
+            uMathIndex = i;
+            break;
+        }
+    }
+    pl_test_expect_true(bFindMath, NULL);
+    pl_test_expect_true(tInfo.sbtEntries[uMathIndex].tType == PL_DIRECTORY_ENTRY_TYPE_FILE, NULL);
+
+    gptFile->cleanup_directory_info(&tInfo);
+    pl_sb_free(sbcFiles);
+
+    pl_test_expect_true(gptFile->directory_exists("../libs"), NULL);
+    pl_test_expect_false(gptFile->directory_exists("../libs-offset"), NULL);
+}
+
 //-----------------------------------------------------------------------------
 // [SECTION] unity build
 //-----------------------------------------------------------------------------
@@ -502,3 +563,6 @@ vfs_tests_0(void* pAppData)
 
 #define PL_JSON_IMPLEMENTATION
 #include "pl_json.h"
+
+#define PL_STRING_IMPLEMENTATION
+#include "pl_string.h"

tests/pl_string_tests.h

@@ -11,6 +11,7 @@ string_test_0(void* pData)
     const char* pcFilePath4 = "file1";
     const char* pcFilePath5 = "/tmp/dir2/file1.txt";
     const char* pcFilePath6 = "/tmp/file1.txt";
+    const char* pcFilePath7 = "/file1.txt";
 
     const char* pcExt0 = pl_str_get_file_extension(pcFilePath0, NULL, 0);
     const char* pcExt1 = pl_str_get_file_extension(pcFilePath1, NULL, 0);
@@ -60,6 +61,7 @@ string_test_0(void* pData)
     char acDirectory4[128] = {0};
     char acDirectory5[128] = {0};
     char acDirectory6[128] = {0};
+    char acDirectory7[128] = {0};
 
     pl_str_get_directory(pcFilePath0, acDirectory0, 128);
     pl_str_get_directory(pcFilePath1, acDirectory1, 128);
@@ -76,23 +78,6 @@ string_test_0(void* pData)
     pl_test_expect_string_equal(acDirectory4, "./", NULL);
     pl_test_expect_string_equal(acDirectory5, "/tmp/dir2/", NULL);
     pl_test_expect_string_equal(acDirectory6, "/tmp/", NULL);
-
-    pl_str_get_root_directory(pcFilePath0, acDirectory0, 128);
-    pl_str_get_root_directory(pcFilePath1, acDirectory1, 128);
-    pl_str_get_root_directory(pcFilePath2, acDirectory2, 128);
-    pl_str_get_root_directory(pcFilePath3, acDirectory3, 128);
-    pl_str_get_root_directory(pcFilePath4, acDirectory4, 128);
-    pl_str_get_root_directory(pcFilePath5, acDirectory5, 128);
-    pl_str_get_root_directory(pcFilePath6, acDirectory6, 128);
-
-    pl_test_expect_string_equal(acDirectory0, "C:/Users/", NULL);
-    pl_test_expect_string_equal(acDirectory1, "C:\\Users\\", NULL);
-    pl_test_expect_string_equal(acDirectory2, "C:\\Users/", NULL);
-    pl_test_expect_string_equal(acDirectory3, "./", NULL);
-    pl_test_expect_string_equal(acDirectory4, "./", NULL);
-    pl_test_expect_string_equal(acDirectory5, "/tmp/", NULL);
-    pl_test_expect_string_equal(acDirectory6, "/tmp/", NULL);
-
 }
 
 void