Started implementing file system utilities

ChangeLog.md

@@ -6,6 +6,8 @@
     * Script parser successfully loading level scripts
     * Can also read TR3 script now
     * Also working with TR2/TR3 PSX Script (TOMBPSX.DAT)
+    * Using getenv() instead of wordexp() for tilde expansion
+    * Started implementing file-system handling utilities
 
     [ 20140806 ]
     * Improved Script reader and its Unit Test

TODO.md

@@ -21,6 +21,8 @@
 
 ## Future Features
 
+* File system utility layer, so mixed-case on case-sensitive filesystems is working transparently
+* Add ability to play the FMVs. Format? VLC can play them!
 * Cut TGA image reader, currently only used for menu background?!
     * Need useful, always available image writer alternative for screenshots then
 * When cutscene rendering is working, use TR4/5 style menu?

include/config.h.in

@@ -24,6 +24,12 @@ extern const char *BUILD_HOST;
 #cmakedefine HAVE_CLOSEDIR
 #cmakedefine HAVE_DT_DIR
 
+#cmakedefine HAVE_UNISTD_H
+#cmakedefine HAVE_GETCWD
+
+#cmakedefine HAVE_STDLIB_H
+#cmakedefine HAVE_GETENV
+
 #cmakedefine HAVE_SYS_TIME_H
 #cmakedefine HAVE_GETTIMEOFDAY
 

include/global.h

@@ -133,6 +133,26 @@ template<typename T, typename U>
     abort();
 }
 
+template<typename T, typename U>
+[[noreturn]] void assertNotEqualImplementation(const char *exp, T a, U b, const char *file, int line, bool print) {
+    const unsigned int maxSize = 128;
+    void *callstack[maxSize];
+    int frames = backtrace(callstack, maxSize);
+    char **strs = backtrace_symbols(callstack, frames);
+
+    std::cout << std::endl << "assertion failed:" << std::endl;
+    std::cout << "\t" << exp << std::endl;
+    if (print)
+        std::cout << "\t (" << a << " == " << b << ")" << std::endl;
+    std::cout << "in " << file << ":" << line << std::endl << std::endl;
+
+    for (int i = 0; i < frames; i++)
+        std::cout << strs[i] << std::endl;
+
+    delete [] strs;
+    abort();
+}
+
 // Evaluating x or y could have side-effects
 // So we only do it once!
 
@@ -149,10 +169,18 @@ template<typename T, typename U>
         assertEqualImplementation(#x " == " #y, assertEvalTemp, assertEvalTemp2, __FILE__, __LINE__, true); \
 }
 
+#define assertNotEqual(x, y) { \
+    auto assertEvalTemp = x; \
+    auto assertEvalTemp2 = y; \
+    if (assertEvalTemp == assertEvalTemp2) \
+        assertNotEqualImplementation(#x " != " #y, assertEvalTemp, assertEvalTemp2, __FILE__, __LINE__, true); \
+}
+
 #else // NDEBUG
 
 #define assert(x)
 #define assertEqual(x, y)
+#define assertNotEqual(x, y)
 
 #endif // NDEBUG
 
@@ -161,6 +189,7 @@ template<typename T, typename U>
 // Fall back to the default C assert
 #include <cassert>
 #define assertEqual(x, y) assert((x) == (y))
+#define assertNotEqual(x, y) assert((x) != (y))
 
 #endif // EXECINFO
 

include/utils/File.h

@@ -0,0 +1,30 @@
+/*!
+ * \file include/utils/File.h
+ * \brief Recursive file-system walking utilities
+ *
+ * \author xythobuz
+ */
+
+#ifndef _UTILS_FILE_H_
+#define _UTILS_FILE_H_
+
+#include <memory>
+#include <string>
+
+class Folder;
+
+class File {
+public:
+    File(std::string file);
+    ~File();
+
+    std::shared_ptr<Folder> getParent();
+
+private:
+    std::string name;
+    std::string path;
+    std::weak_ptr<Folder> parent;
+};
+
+#endif
+

include/utils/Folder.h

@@ -0,0 +1,29 @@
+/*!
+ * \file include/utils/FileSystem.h
+ * \brief Recursive file-system walking utilities
+ *
+ * \author xythobuz
+ */
+
+#ifndef _UTILS_FOLDER_H_
+#define _UTILS_FOLDER_H_
+
+#include <memory>
+#include <string>
+#include <vector>
+
+class File;
+
+class Folder {
+public:
+    Folder(std::string folder);
+    ~Folder();
+
+private:
+    std::string name;
+    std::string path;
+    std::vector<std::shared_ptr<File>> files;
+};
+
+#endif
+

include/utils/filesystem.h

@@ -0,0 +1,18 @@
+/*!
+ * \file include/utils/filesystem.h
+ * \brief file-system utilities
+ *
+ * \author xythobuz
+ */
+
+#ifndef _UTILS_FILESYSTEM_H_
+#define _UTILS_FILESYSTEM_H_
+
+#include <string>
+
+std::string getCurrentWorkingDirectory();
+
+std::string getHomeDirectory();
+
+#endif
+

src/CMakeLists.txt

@@ -121,6 +121,14 @@ check_function_exists (readdir_r HAVE_READDIR_R)
 check_function_exists (closedir HAVE_CLOSEDIR)
 check_symbol_exists (DT_DIR "dirent.h" HAVE_DT_DIR)
 
+# getcwd() for the current working directory
+check_include_files (unistd.h HAVE_UNISTD_H)
+check_function_exists (getcwd HAVE_GETCWD)
+
+# getenv() for reading environment variables
+check_include_files (stdlib.h HAVE_STDLIB_H)
+check_function_exists (getenv HAVE_GETENV)
+
 # gettimeofday() for timing
 check_include_files (sys/time.h HAVE_SYS_TIME_H)
 check_function_exists (gettimeofday HAVE_GETTIMEOFDAY)

src/Menu.cpp

@@ -94,6 +94,7 @@ void Menu::loadPakFolderRecursive(const char *dir) {
                 if (stringEndsWith(lowerPath, ".phd")
                      || stringEndsWith(lowerPath, ".tr2")
                      || stringEndsWith(lowerPath, ".tr4")
+                    // || stringEndsWith(lowerPath, ".psx")
                      || stringEndsWith(lowerPath, ".trc")) {
                     int error = TombRaider::checkMime(fullPathMap);
                     if (error == 0) {
@@ -134,6 +135,7 @@ void Menu::loadPakFolderRecursive(const char *dir) {
                 if (stringEndsWith(lowerPath, ".phd")
                      || stringEndsWith(lowerPath, ".tr2")
                      || stringEndsWith(lowerPath, ".tr4")
+                    // || stringEndsWith(lowerPath, ".psx")
                      || stringEndsWith(lowerPath, ".trc")) {
                     int error = TombRaider::checkMime(fullPathMap);
                     if (error == 0) {

src/utils/CMakeLists.txt

@@ -1,5 +1,8 @@
 # Source files
 set (UTIL_SRCS ${UTIL_SRCS} "binary.cpp")
+set (UTIL_SRCS ${UTIL_SRCS} "File.cpp")
+set (UTIL_SRCS ${UTIL_SRCS} "filesystem.cpp")
+set (UTIL_SRCS ${UTIL_SRCS} "Folder.cpp")
 set (UTIL_SRCS ${UTIL_SRCS} "pcx.cpp")
 set (UTIL_SRCS ${UTIL_SRCS} "pixel.cpp")
 set (UTIL_SRCS ${UTIL_SRCS} "strings.cpp")

src/utils/File.cpp

@@ -0,0 +1,19 @@
+/*!
+ * \file src/utils/File.cpp
+ * \brief Recursive file-system walking utilities
+ *
+ * \author xythobuz
+ */
+
+#include "global.h"
+#include "utils/File.h"
+#include "utils/Folder.h"
+
+File::File(std::string file) {
+
+}
+
+File::~File() {
+
+}
+

src/utils/Folder.cpp

@@ -0,0 +1,19 @@
+/*!
+ * \file src/utils/Folder.cpp
+ * \brief Recursive file-system walking utilities
+ *
+ * \author xythobuz
+ */
+
+#include "global.h"
+#include "utils/File.h"
+#include "utils/Folder.h"
+
+Folder::Folder(std::string folder) {
+
+}
+
+Folder::~Folder() {
+
+}
+

src/utils/filesystem.cpp

@@ -0,0 +1,63 @@
+/*!
+ * \file src/utils/filesystem.cpp
+ * \brief file-system utilities
+ *
+ * \author xythobuz
+ */
+
+#include "global.h"
+#include "utils/filesystem.h"
+
+#if defined(HAVE_UNISTD_H) && defined(HAVE_GETCWD)
+#include <unistd.h>
+#endif
+
+#if defined(HAVE_STDLIB_H) && defined(HAVE_GETENV)
+#include <stdlib.h>
+#endif
+
+#ifdef _WIN32
+#include <windows.h>
+#include <shlobj.h>
+#endif
+
+std::string getCurrentWorkingDirectory() {
+#if defined(HAVE_UNISTD_H) && defined(HAVE_GETCWD)
+
+    char path[1024];
+    assertEqual(getcwd(path, 1024), path);
+    return std::string(path);
+
+#else
+
+    assert(false);
+    return std::string();
+
+#endif
+}
+
+std::string getHomeDirectory() {
+#if defined(HAVE_STDLIB_H) && defined(HAVE_GETENV)
+
+    char *path = getenv("HOME");
+    assert(path != nullptr);
+    return path;
+
+#elif defined(_WIN32)
+
+    char path[MAX_PATH];
+    assertEqual(SHGetFolderPath(NULL, CSIDL_PROFILE, NULL, 0, path), S_OK);
+    size_t lenPath = strlen(path);
+    for (unsigned int i = 0; i < lenPath; i++)
+        if (dir[i] == '\\')
+            dir[i] = '/';
+    return std::string(path);
+
+#else
+
+    assert(false);
+    return std::string();
+
+#endif
+}
+

src/utils/strings.cpp

@@ -10,17 +10,12 @@
 #include <stdio.h>
 #include <string.h>
 
-#if defined(unix) || defined(__APPLE__) || defined(__linux__)
-#include <wordexp.h>
-#elif defined(_WIN32)
-#include <Windows.h>
-#include <shlobj.h>
-#ifndef va_copy
+#if defined(_WIN32) && (!defined(va_copy))
 #define va_copy(d,s) ((d) = (s))
 #endif
-#endif
 
 #include "global.h"
+#include "utils/filesystem.h"
 #include "utils/strings.h"
 
 char *stringRemoveQuotes(const char *s) {
@@ -131,70 +126,13 @@ char *fullPath(const char *path, char end) {
     assert(path[0] != '\0');
 
     if (path[0] == '~') {
-#if defined(unix) || defined(__APPLE__) || defined(__linux__)
-
-        wordexp_t word;
-
-#ifdef __APPLE__
-        // Workunsigned long systemTimerStart = 0;around for Mac OS X. See:
-        // http://stackoverflow.com/questions/20534788/why-does-wordexp-fail-with-wrde-syntax-on-os-x
-        signal(SIGCHLD, SIG_DFL);
-#endif
-
-        // Expand string into segments
-        int res = wordexp(path, &word, 0);
-
-#ifdef __APPLE__
-        signal(SIGCHLD, SIG_IGN);
-#endif
-
-        if (res != 0) {
-            printf("fullPath> wordexp() failed: %d\n", res);
-            return NULL;
-        }
-
-        // Get length of complete string
-        lenPath = 0;
-        for (unsigned int i = 0; i < word.we_wordc; i++) {
-            lenPath += strlen(word.we_wordv[i]);
-        }
-
-        // Allocate new string
-        dir = new char[lenPath + 2]; // space for end char
-
-        // Copy segments into new string
-        size_t offset = 0;
-        for (unsigned int i = 0; i < word.we_wordc; i++) {
-            size_t len = strlen(word.we_wordv[i]);
-            strncpy(dir + offset, word.we_wordv[i], len);
-            offset += len;
-        }
-
-        wordfree(&word);
-#elif defined(_WIN32)
-        char newPath[MAX_PATH];
-        if (SHGetFolderPath(NULL, CSIDL_PROFILE, NULL, 0, newPath) == S_OK) {
-            lenPath = strlen(newPath);
-            size_t lenPath2 = strlen(path);
-            dir = new char[lenPath + lenPath2 + 2]; // space for end char
-            strncpy(dir, newPath, lenPath);
-            strncpy((dir + lenPath), (path + 1), lenPath2 - 1);
-            lenPath += lenPath2 - 1;
-            for (unsigned int i = 0; i < lenPath; i++)
-                if(dir[i] == '\\')
-                    dir[i] = '/';
-        } else {
-            printf("WARNING: Could not get home folder location for tilde expansion!\n");
-            lenPath = strlen(path);
-            dir = new char[lenPath + 2]; // space for end char
-            strncpy(dir, path, lenPath);
-        }
-#else
-        printf("WARNING: Tilde expansion not supported on this platform:\n\t%s\n", path);
+        std::string home = getHomeDirectory();
+        assert(home.length() > 0);
         lenPath = strlen(path);
-        dir = new char[lenPath + 2]; // space for end char
-        strncpy(dir, path, lenPath);
-#endif
+        dir = new char[home.length() + lenPath + 3]; // space for end char
+        strncpy(dir, home.c_str(), home.length());
+        strncpy(dir + home.length(), path + 1, lenPath - 1);
+        lenPath = home.length() + lenPath - 1;
     } else {
         lenPath = strlen(path);
         dir = new char[lenPath + 2]; // space for end char