Menu now works like a Filemanager

ChangeLog.md

@@ -2,6 +2,12 @@
 
 ## OpenRaider (0.1.3) xythobuz <xythobuz@xythobuz.de>
 
+    [ 20140810 ]
+    * Removed recursive Folder access method implementations
+      into their own file
+    * Menu now acts like a file-manager, only showing one folder,
+      and has the ability to go to the parent folder, and do mouse scrolling
+
     [ 20140809 ]
     * Script Unit Test brings it’s own scripts to test
     * Fixed binary Unit Test not deleting it’s tmp file in case of error

include/Menu.h

@@ -30,6 +30,7 @@ public:
     ~Menu();
 
     int initialize();
+    int initialize(Folder folder);
 
     void setVisible(bool visible);
 
@@ -41,6 +42,8 @@ public:
 
     void handleMouseClick(unsigned int x, unsigned int y, KeyboardButton button, bool released);
 
+    void handleMouseScroll(int xrel, int yrel);
+
 private:
 
     void play();

include/utils/Folder.h

@@ -29,10 +29,16 @@ public:
     unsigned long folderCount();
     Folder &getFolder(unsigned long i);
 
-    unsigned long countRecursiveItems();
-    void executeRemoveRecursiveItems(std::function<bool (File &f)> func);
-    std::string getRecursiveItemName(unsigned long i);
-    //File &getRecursiveItem(unsigned long i);
+    Folder getParent();
+
+    void executeRemoveFiles(std::function<bool (File &f)> func);
+
+    // Accessing a folder recursively
+    // This treats all files in all subfolders as if they were in this folder
+    unsigned long countRecursiveFiles();
+    void executeRemoveRecursiveFiles(std::function<bool (File &f)> func);
+    std::string getRecursiveFileName(unsigned long i);
+    File &getRecursiveFile(unsigned long i);
 
 private:
 

src/Command.cpp

@@ -91,9 +91,7 @@ int OpenRaider::command(std::string &c) {
         }
         std::string temp;
         command >> temp;
-        char *tmp = bufferString("%s/%s", mPakDir, temp.c_str());
-        int error = getGame().loadLevel(tmp);
-        delete [] tmp;
+        int error = getGame().loadLevel(temp.c_str());
         return error;
     } else if (cmd.compare("help") == 0) {
         std::string tmp;
@@ -445,7 +443,7 @@ int OpenRaider::help(std::string &cmd) {
         getConsole().print("  \"leftctrl\"  for symbols and special keys");
     } else if (cmd.compare("load") == 0) {
         getConsole().print("load-Command Usage:");
-        getConsole().print("  load levelfile.name");
+        getConsole().print("  load /path/to/level");
 /*
     } else if (cmd.compare("sshot") == 0) {
         getConsole().print("sshot-Command Usage:");

src/Menu.cpp

@@ -16,6 +16,8 @@
 #include "Window.h"
 #include "Menu.h"
 
+// TODO
+// Going up to / leads to the current working directory
 
 Menu::Menu() {
     mVisible = false;
@@ -43,11 +45,16 @@ Menu::~Menu() {
 }
 
 int Menu::initialize() {
+    return initialize(Folder(getOpenRaider().mPakDir));
+}
+
+int Menu::initialize(Folder folder) {
     if (mapFolder != nullptr)
         delete mapFolder;
-    mapFolder = new Folder(getOpenRaider().mPakDir);
+    mapFolder = new Folder(folder);
+    mMin = mCursor = 0;
 
-    mapFolder->executeRemoveRecursiveItems([](File &f) {
+    mapFolder->executeRemoveFiles([](File &f) {
         // Filter files based on file name
         if ((f.getName().compare(f.getName().length() - 4, 4, ".phd") != 0)
             && (f.getName().compare(f.getName().length() - 4, 4, ".tr2") != 0)
@@ -67,6 +74,9 @@ int Menu::initialize() {
         return false; // keep file on list
     });
 
+    if ((mapFolder->fileCount() + mapFolder->folderCount()) > 0)
+        mCursor = 1; // Don't select ".." by default
+
     return 0;
 }
 
@@ -93,83 +103,71 @@ void Menu::display() {
     mainText.x = (getWindow().getWidth() / 2) - ((unsigned int)(mainText.w / 2));
     getFont().writeString(mainText);
 
-    if ((mapFolder == nullptr) || (mapFolder->countRecursiveItems() == 0)) {
-        getFont().drawText(25, (getWindow().getHeight() / 2) - 20, 0.75f, RED, "No maps found! See README.md");
-        return;
-    } else {
-        // Estimate displayable number of items
-        int items = (getWindow().getHeight() - 60) / 25;
-
-        // Select which part of the list to show
-        long min, max;
-        if (((long)mCursor - (items / 2)) > 0)
-            min = mCursor - (items / 2);
-        else
-            min = 0;
-
-        if ((mCursor + (items / 2)) < (long)mapFolder->countRecursiveItems())
-            max = mCursor + (items / 2);
-        else
-            max = (long)mapFolder->countRecursiveItems();
-
-        while ((max - min) < items) {
-            if (min > 0)
-                min--;
-            else if (max < ((int)mapFolder->countRecursiveItems()))
-                max++;
-            else
-                break;
-        }
-
-        mMin = min;
+    // Estimate displayable number of items
+    int items = (getWindow().getHeight() - 60) / 25;
 
-        for (long i = 0; i < (max - min); i++) {
-            const char *map = mapFolder->getRecursiveItemName((unsigned long)(i + min)).c_str();
-            getFont().drawText(25, (unsigned int)(50 + (25 * i)), 0.75f,
-                    ((i + min) == mCursor) ? RED : BLUE, "%s", map);
+    // Print list of "..", folders, files
+    for (long i = mMin; (i < (mMin + items))
+                && (i < (mapFolder->folderCount() + mapFolder->fileCount() + 1)); i++) {
+        if (i == 0) {
+            getFont().drawText(25, 50, 0.75f, (mCursor == i) ? RED : BLUE, "..");
+        } else {
+            getFont().drawText(25, (unsigned int)(50 + (25 * (i - mMin))), 0.75f,
+                (mCursor == i) ? RED : BLUE, "%s",
+                ((i - 1) < mapFolder->folderCount()) ?
+                    (mapFolder->getFolder(i - 1).getName() + "/").c_str()
+                    : mapFolder->getFile(i - 1 - mapFolder->folderCount()).getName().c_str());
         }
     }
 }
 
 void Menu::play() {
-    char *tmp = bufferString("load %s", mapFolder->getRecursiveItemName((unsigned long)mCursor).c_str());
-    if (getOpenRaider().command(tmp) == 0) {
-        setVisible(false);
+    if (mCursor == 0) {
+        if (initialize(mapFolder->getParent().getPath()) != 0) {
+            //! \todo Display something if an error occurs
+        }
+    } else if ((mCursor - 1) < mapFolder->folderCount()) {
+        if (initialize(mapFolder->getFolder(mCursor - 1).getPath()) != 0) {
+            //! \todo Display something if an error occurs
+        }
     } else {
-        //! \todo Display something if an error occurs
+        char *tmp = bufferString("load %s",
+                mapFolder->getFile((unsigned long)mCursor - 1 - mapFolder->folderCount()).getPath().c_str());
+        if (getOpenRaider().command(tmp) == 0) {
+            setVisible(false);
+        } else {
+            //! \todo Display something if an error occurs
+        }
+        delete [] tmp;
     }
-    delete [] tmp;
 }
 
 void Menu::handleKeyboard(KeyboardButton key, bool pressed) {
     if (!pressed)
         return;
 
+    assert(mapFolder != nullptr);
+    int items = (getWindow().getHeight() - 60) / 25;
+
     if (key == upKey) {
         if (mCursor > 0)
             mCursor--;
         else
-            mCursor = (long)mapFolder->countRecursiveItems() - 1;
+            mCursor = (long)(mapFolder->folderCount() + mapFolder->fileCount());
     } else if (key == downKey) {
-        if (mCursor < (long)(mapFolder->countRecursiveItems() - 1))
+        if (mCursor < (long)(mapFolder->folderCount() + mapFolder->fileCount()))
             mCursor++;
         else
             mCursor = 0;
-    } else if (key == rightKey) {
-        long i = 10;
-        if (mCursor > (long)(mapFolder->countRecursiveItems() - 11))
-            i = ((long)mapFolder->countRecursiveItems()) - 1 - mCursor;
-        while (i-- > 0)
-            handleKeyboard(downKey, true);
-    } else if (key == leftKey) {
-        long i = 10;
-        if (mCursor < 10)
-            i = mCursor;
-        while (i-- > 0)
-            handleKeyboard(upKey, true);
     } else if (key == enterKey) {
         play();
     }
+
+    if (mCursor > (mMin + items - 1)) {
+        mMin = mCursor - items + 1;
+    } else if (mCursor < mMin) {
+        mMin = mCursor;
+    }
 }
 
 void Menu::handleMouseClick(unsigned int x, unsigned int y, KeyboardButton button, bool released) {
@@ -187,3 +185,25 @@ void Menu::handleMouseClick(unsigned int x, unsigned int y, KeyboardButton butto
     }
 }
 
+void Menu::handleMouseScroll(int xrel, int yrel) {
+    assert((xrel != 0) || (yrel != 0));
+    assert(mapFolder != nullptr);
+    int items = (getWindow().getHeight() - 60) / 25;
+
+    if ((mapFolder->folderCount() + mapFolder->fileCount() + 1) > items) {
+        if (yrel < 0) {
+            if (mMin < (mapFolder->folderCount() + mapFolder->fileCount() + 1 - items))
+                mMin++;
+        } else if (yrel > 0) {
+            if (mMin > 0)
+                mMin--;
+        }
+
+        if (mCursor < mMin) {
+            mCursor = mMin;
+        } else if (mCursor > (mMin + items - 1)) {
+            mCursor = mMin + items - 1;
+        }
+    }
+}
+

src/OpenRaider.cpp

@@ -239,7 +239,9 @@ void OpenRaider::handleMouseScroll(int xrel, int yrel) {
     assert((xrel != 0) || (yrel != 0));
     assert(mRunning == true);
 
-    if ((getConsole().isVisible()) && (!getMenu().isVisible())) {
+    if (getMenu().isVisible()) {
+        getMenu().handleMouseScroll(xrel, yrel);
+    } else if (getConsole().isVisible()) {
         getConsole().handleMouseScroll(xrel, yrel);
     }
 

src/utils/CMakeLists.txt

@@ -3,6 +3,7 @@ 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} "FolderRecursive.cpp")
 set (UTIL_SRCS ${UTIL_SRCS} "pcx.cpp")
 set (UTIL_SRCS ${UTIL_SRCS} "pixel.cpp")
 set (UTIL_SRCS ${UTIL_SRCS} "strings.cpp")

src/utils/Folder.cpp

@@ -98,63 +98,19 @@ Folder &Folder::getFolder(unsigned long i) {
     return folders.at(i);
 }
 
-unsigned long Folder::countRecursiveItems() {
-    unsigned long count = fileCount();
-    for (unsigned long i = 0; i < folderCount(); i++)
-        count += getFolder(i).countRecursiveItems();
-    return count;
+Folder Folder::getParent() {
+    size_t last = path.rfind('/', path.length() - 2);
+    return Folder(path.substr(0, last), listDot);
 }
 
-void Folder::executeRemoveRecursiveItems(std::function<bool (File &f)> func) {
+void Folder::executeRemoveFiles(std::function<bool (File &f)> func) {
+    createFolderItems();
     for (unsigned long i = 0; i < fileCount(); i++) {
         if (func(getFile(i))) {
             files.erase(files.begin() + (long)i--);
         }
     }
-
-    for (unsigned long i = 0; i < folderCount(); i++) {
-        getFolder(i).executeRemoveRecursiveItems(func);
-    }
-}
-
-std::string Folder::getRecursiveItemName(unsigned long i) {
-    assert(i < countRecursiveItems());
-    if (i < fileCount()) {
-        return getFile(i).getName();
-    } else {
-        unsigned long count = fileCount();
-        for (unsigned long n = 0; n < folderCount(); n++) {
-            if ((i - count) < getFolder(n).countRecursiveItems()) {
-                return getFolder(n).getName() + '/'
-                    + getFolder(n).getRecursiveItemName(i - count);
-            }
-            count += getFolder(n).countRecursiveItems();
-        }
-    }
-
-    assert(false);
-    return "";
-}
-
-/*
-File &Folder::getRecursiveItem(unsigned long i) {
-    assert(i < countRecursiveItems());
-    if (i < fileCount()) {
-        return getFile(i);
-    } else {
-        unsigned long count = fileCount();
-        for (unsigned long n = 0; n < folderCount(); n++) {
-            if ((i - count) < getFolder(n).countRecursiveItems()) {
-                return getFolder(n).getRecursiveItem(i - count);
-            }
-            count += getFolder(n).countRecursiveItems();
-        }
-    }
-
-    assert(false);
-    return files.at(0);
 }
-*/
 
 void Folder::createFolderItems() {
     if (hasListed)

src/utils/FolderRecursive.cpp

@@ -0,0 +1,65 @@
+/*!
+ * \file src/utils/Folder.cpp
+ * \brief Recursive file-system walking utilities
+ *
+ * \author xythobuz
+ */
+
+#include "global.h"
+#include "utils/File.h"
+#include "utils/Folder.h"
+
+unsigned long Folder::countRecursiveFiles() {
+    createFolderItems();
+    unsigned long count = fileCount();
+    for (unsigned long i = 0; i < folderCount(); i++)
+        count += getFolder(i).countRecursiveFiles();
+    return count;
+}
+
+void Folder::executeRemoveRecursiveFiles(std::function<bool (File &f)> func) {
+    executeRemoveFiles(func);
+    for (unsigned long i = 0; i < folderCount(); i++) {
+        getFolder(i).executeRemoveRecursiveFiles(func);
+    }
+}
+
+std::string Folder::getRecursiveFileName(unsigned long i) {
+    createFolderItems();
+    assert(i < countRecursiveFiles());
+    if (i < fileCount()) {
+        return getFile(i).getName();
+    } else {
+        unsigned long count = fileCount();
+        for (unsigned long n = 0; n < folderCount(); n++) {
+            if ((i - count) < getFolder(n).countRecursiveFiles()) {
+                return getFolder(n).getName() + '/'
+                    + getFolder(n).getRecursiveFileName(i - count);
+            }
+            count += getFolder(n).countRecursiveFiles();
+        }
+    }
+
+    assert(false);
+    return "";
+}
+
+File &Folder::getRecursiveFile(unsigned long i) {
+    createFolderItems();
+    assert(i < countRecursiveFiles());
+    if (i < fileCount()) {
+        return getFile(i);
+    } else {
+        unsigned long count = fileCount();
+        for (unsigned long n = 0; n < folderCount(); n++) {
+            if ((i - count) < getFolder(n).countRecursiveFiles()) {
+                return getFolder(n).getRecursiveFile(i - count);
+            }
+            count += getFolder(n).countRecursiveFiles();
+        }
+    }
+
+    assert(false);
+    return files.at(0);
+}
+

test/ScriptPayload.h

@@ -8,6 +8,11 @@
 #ifndef _SCRIPT_PAYLOAD_H
 #define _SCRIPT_PAYLOAD_H
 
+/* Payload creation:
+ * cat TOMBPC.DAT | python -c 'import sys,zlib; sys.stdout.write(zlib.compress(sys.stdin.read()))' > tr2_pc.z
+ * bin2header tr2_pc.z
+ */
+
 static const unsigned char tr2_pc_dat_z[] = {
     0x78, 0x9c, 0xd5, 0x57, 0x6b, 0x8c, 0x1c, 0xc5, 0x11, 0xae, 0x9e, 0x3d,
     0xdb, 0x3c, 0x7c, 0x7e, 0xf1, 0x08, 0xe1, 0xe5, 0x85, 0xf0, 0x30, 0x04,