Split Menu into interface and MenuFolder

ChangeLog.md

@@ -5,6 +5,8 @@
     [ 20140811 ]
     * New Font API, allows drawing strings with line-wrapping
     * Added ability to Menu to show info dialogs
+    * Split Menu into interface and implementations, like Sound/Window/Font
+    * Menu now interface and dialog code, MenuFolder is file browser
 
     [ 20140810 ]
     * Removed recursive Folder access method implementations

include/Menu.h

@@ -1,6 +1,6 @@
 /*!
  * \file include/Menu.h
- * \brief Menu 'overlay'
+ * \brief Menu 'overlay' interface
  *
  * \author xythobuz
  */
@@ -9,9 +9,6 @@
 #define _MENU_H_
 
 #include <functional>
-#include <memory>
-
-#include "utils/Folder.h"
 
 /*!
  * \brief Menu 'overlay'
@@ -19,54 +16,47 @@
 class Menu {
 public:
 
-    /*!
-     * \brief Constructs an object of Menu
-     */
-    Menu();
-
-    /*!
-     * \brief Deconstructs an object of Menu
-     */
-    ~Menu();
+    virtual ~Menu() { }
 
-    int initialize();
-    int initialize(std::string folder);
-    int initialize(Folder *folder);
+    virtual void setVisible(bool visible);
 
-    void setVisible(bool visible);
+    virtual bool isVisible();
 
-    bool isVisible();
+    virtual int initialize() = 0;
 
-    void display();
+    virtual void display() = 0;
 
-    void handleKeyboard(KeyboardButton key, bool pressed);
+    virtual void handleKeyboard(KeyboardButton key, bool pressed) = 0;
 
-    void handleMouseClick(unsigned int x, unsigned int y, KeyboardButton button, bool released);
+    virtual void handleMouseClick(unsigned int x, unsigned int y, KeyboardButton button, bool released) = 0;
 
-    void handleMouseScroll(int xrel, int yrel);
+    virtual void handleMouseScroll(int xrel, int yrel) = 0;
 
-private:
+protected:
 
-    void loadOrOpen();
-    void showDialog(std::string msg, std::string btn1, std::string btn2,
+    virtual void showDialog(std::string msg, std::string btn1, std::string btn2,
             std::function<int (bool state)> callback = std::function<int (bool)>());
-    void ackDialog();
-    void displayDialog();
 
-    bool mVisible;
-    long mCursor;
-    long mMin;
+    virtual void ackDialog();
+
+    virtual bool handleKeyboardDialog(KeyboardButton key, bool pressed);
+
+    virtual bool handleMouseClickDialog(unsigned int x, unsigned int y,
+            KeyboardButton button, bool released);
 
-    Folder *mapFolder;
-    bool hiddenState;
+    virtual bool handleMouseScrollDialog(int xrel, int yrel);
 
+    virtual void displayDialog();
+
+    bool mVisible;
+    bool dialogState;
     std::string dialogText;
     std::string dialogButton1;
     std::string dialogButton2;
-    bool dialogState;
     std::function<int (bool state)> dialogFunction;
 };
 
 Menu &getMenu();
 
 #endif
+

include/MenuFolder.h

@@ -0,0 +1,56 @@
+/*!
+ * \file include/MenuFolder.h
+ * \brief File-Explorer like Menu
+ *
+ * \author xythobuz
+ */
+
+#ifndef _MENU_FOLDER_H_
+#define _MENU_FOLDER_H_
+
+#include "Menu.h"
+#include "utils/Folder.h"
+
+/*!
+ * \brief Menu 'overlay'
+ */
+class MenuFolder : public Menu {
+public:
+
+    /*!
+     * \brief Constructs an object of MenuFolder
+     */
+    MenuFolder();
+
+    /*!
+     * \brief Deconstructs an object of MenuFolder
+     */
+    virtual ~MenuFolder();
+
+    virtual int initialize();
+
+    virtual void display();
+
+    virtual void handleKeyboard(KeyboardButton key, bool pressed);
+
+    virtual void handleMouseClick(unsigned int x, unsigned int y, KeyboardButton button, bool released);
+
+    virtual void handleMouseScroll(int xrel, int yrel);
+
+private:
+
+    virtual int initialize(std::string s);
+
+    virtual int initialize(Folder *folder, bool filter = true);
+
+    virtual void loadOrOpen();
+
+    long mCursor;
+    long mMin;
+
+    Folder *mapFolder;
+    bool hiddenState;
+};
+
+#endif
+

src/CMakeLists.txt

@@ -58,6 +58,7 @@ set (SRCS ${SRCS} "FontTRLE.cpp")
 set (SRCS ${SRCS} "Game.cpp")
 set (SRCS ${SRCS} "main.cpp")
 set (SRCS ${SRCS} "Menu.cpp")
+set (SRCS ${SRCS} "MenuFolder.cpp")
 set (SRCS ${SRCS} "Mesh.cpp")
 set (SRCS ${SRCS} "OpenRaider.cpp")
 set (SRCS ${SRCS} "Render.cpp")

src/Menu.cpp

@@ -5,73 +5,12 @@
  * \author xythobuz
  */
 
-#include <cctype>
-#include <cstring>
-
 #include "global.h"
 #include "Console.h"
 #include "Font.h"
-#include "OpenRaider.h"
-#include "utils/strings.h"
-#include "TombRaider.h"
 #include "Window.h"
 #include "Menu.h"
 
-Menu::Menu() {
-    mVisible = false;
-    mCursor = 0;
-    mMin = 0;
-    mapFolder = nullptr;
-    hiddenState = false;
-    dialogState = false;
-}
-
-Menu::~Menu() {
-    delete mapFolder;
-    mapFolder = nullptr;
-}
-
-int Menu::initialize() {
-    return initialize(getOpenRaider().mPakDir);
-}
-
-int Menu::initialize(std::string folder) {
-    return initialize(new Folder(folder, hiddenState));
-}
-
-int Menu::initialize(Folder *folder) {
-    if (mapFolder != nullptr)
-        delete mapFolder;
-    mapFolder = folder;
-    mMin = mCursor = 0;
-
-    mapFolder->executeRemoveFiles([](File &f) {
-        // Filter files based on file name
-        if ((f.getName().length() > 4)
-            && (f.getName().compare(f.getName().length() - 4, 4, ".phd") != 0)
-            && (f.getName().compare(f.getName().length() - 4, 4, ".tr2") != 0)
-            && (f.getName().compare(f.getName().length() - 4, 4, ".tr4") != 0)
-            && (f.getName().compare(f.getName().length() - 4, 4, ".trc") != 0)) {
-            return true; // delete file from list
-        }
-
-        // Check maps for validity
-        int error = TombRaider::checkMime(f.getPath().c_str());
-        if (error != 0) {
-            getConsole() << "Error: pak file '" << f.getName().c_str()
-                << "' " << ((error == -1) ? "not found" : "invalid") << Console::endl;
-            return true; // delete file from list
-        }
-
-        return false; // keep file on list
-    });
-
-    if ((mapFolder->fileCount() + mapFolder->folderCount()) > 0)
-        mCursor = 1; // Don't select ".." by default
-
-    return 0;
-}
-
 void Menu::setVisible(bool visible) {
     mVisible = visible;
 }
@@ -80,62 +19,43 @@ bool Menu::isVisible() {
     return mVisible;
 }
 
-void Menu::display() {
-    if (!mVisible)
-        return;
-
-    // Draw half-transparent overlay
-    glColor4f(0.0f, 0.0f, 0.0f, 0.75f);
-    glDisable(GL_TEXTURE_2D);
-    glRecti(0, 0, (GLint)getWindow().getWidth(), (GLint)getWindow().getHeight());
-    glEnable(GL_TEXTURE_2D);
-
-    // Draw heading
-    getFont().drawTextCentered(0, 10, 1.2f, BLUE, getWindow().getWidth(), VERSION);
+void Menu::showDialog(std::string msg, std::string btn1, std::string btn2,
+        std::function<int (bool state)> callback) {
+    // Only show one dialog at a time
+    assert(dialogText.length() == 0);
+    assert(dialogButton1.length() == 0);
+    assert(dialogButton2.length() == 0);
 
-    // Estimate displayable number of items
-    int items = (getWindow().getHeight() - 60) / 25;
+    assert(msg.length() > 0);
+    assert(btn1.length() > 0);
 
-    // 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,
-                ((i - 1) < mapFolder->folderCount()) ?
-                    (mapFolder->getFolder(i - 1).getName() + "/")
-                    : mapFolder->getFile(i - 1 - mapFolder->folderCount()).getName());
-        }
-    }
+    dialogText = msg;
+    dialogButton1 = btn1;
+    dialogButton2 = btn2;
+    dialogState = false;
+    dialogFunction = callback;
 
-    displayDialog();
+    getConsole() << dialogText << Console::endl;
 }
 
-void Menu::loadOrOpen() {
-    if (mCursor == 0) {
-        if (initialize(mapFolder->getParent().getPath()) != 0) {
-            showDialog("Error reading parent folder!", "OK", "");
-        }
-    } else if ((mCursor - 1) < mapFolder->folderCount()) {
-        if (initialize(mapFolder->getFolder(mCursor - 1).getPath()) != 0) {
-            showDialog("Error reading subfolder!", "OK", "");
-        }
-    } else {
-        std::string tmp = "load ";
-        tmp += mapFolder->getFile((unsigned long)mCursor - 1 - mapFolder->folderCount()).getPath();
-        if (getOpenRaider().command(tmp.c_str()) == 0) {
-            setVisible(false);
-        } else {
-            showDialog("Error loading map!", "OK", "");
+void Menu::ackDialog() {
+    dialogText = "";
+    dialogButton1 = "";
+    dialogButton2 = "";
+
+    if (dialogFunction) {
+        int error = dialogFunction(dialogState);
+        if (error != 0) {
+            showDialog("Error processing dialog callback!", "OK", "");
         }
     }
+
+    dialogState = false;
 }
 
-void Menu::handleKeyboard(KeyboardButton key, bool pressed) {
+bool Menu::handleKeyboardDialog(KeyboardButton key, bool pressed) {
     if (!pressed)
-        return;
+        return (dialogText.length() > 0);
 
     if (dialogText.length() > 0) {
         if (dialogButton2.length() == 0) {
@@ -155,114 +75,21 @@ void Menu::handleKeyboard(KeyboardButton key, bool pressed) {
                 dialogState = !dialogState;
             }
         }
-        return;
-    }
-
-    assert(mapFolder != nullptr);
-    int items = (getWindow().getHeight() - 60) / 25;
-
-    if (key == upKey) {
-        if (mCursor > 0)
-            mCursor--;
-        else
-            mCursor = (long)(mapFolder->folderCount() + mapFolder->fileCount());
-    } else if (key == downKey) {
-        if (mCursor < (long)(mapFolder->folderCount() + mapFolder->fileCount()))
-            mCursor++;
-        else
-            mCursor = 0;
-    } else if (key == enterKey) {
-        loadOrOpen();
-    } else if (key == dotKey) {
-        hiddenState = !hiddenState;
-        initialize(mapFolder->getPath());
+        return true;
     }
 
-    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) {
-    int items = (getWindow().getHeight() - 60) / 25;
-
-    if (released || (button != leftmouseKey))
-        return;
-
-    if (dialogText.length() > 0) {
-        //!< \todo Allow mouse usage of Menu dialogs!
-        return;
-    }
-
-    if ((y >= 50) && (y <= (unsigned int)(50 + (25 * items)))
-            && ((mMin + (y / 25)) <= (mapFolder->folderCount() + mapFolder->fileCount() + 2))) {
-        y -= 50;
-        if (mCursor == (mMin + (y / 25)))
-            loadOrOpen();
-        else
-            mCursor = mMin + (y / 25);
-    }
+    return false;
 }
 
-void Menu::handleMouseScroll(int xrel, int yrel) {
-    if (dialogText.length() > 0)
-        return;
-
-    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;
-        }
-    }
+bool Menu::handleMouseClickDialog(unsigned int x, unsigned int y,
+            KeyboardButton button, bool released) {
+    //! \todo Allow mouse usage of Menu dialogs!
+    return (dialogText.length() > 0);
 }
 
-void Menu::showDialog(std::string msg, std::string btn1, std::string btn2,
-        std::function<int (bool state)> callback) {
-    // Only show one dialog at a time
-    assert(dialogText.length() == 0);
-    assert(dialogButton1.length() == 0);
-    assert(dialogButton2.length() == 0);
-
-    assert(msg.length() > 0);
-    assert(btn1.length() > 0);
-
-    dialogText = msg;
-    dialogButton1 = btn1;
-    dialogButton2 = btn2;
-    dialogState = false;
-    dialogFunction = callback;
-
-    getConsole() << dialogText << Console::endl;
-}
-
-void Menu::ackDialog() {
-    dialogText = "";
-    dialogButton1 = "";
-    dialogButton2 = "";
-
-    if (dialogFunction) {
-        int error = dialogFunction(dialogState);
-        if (error != 0) {
-            showDialog("Error processing dialog callback!", "OK", "");
-        }
-    }
-
-    dialogState = false;
+bool Menu::handleMouseScrollDialog(int xrel, int yrel) {
+    //! \todo Allow mouse usage of Menu dialogs!
+    return (dialogText.length() > 0);
 }
 
 void Menu::displayDialog() {

src/MenuFolder.cpp

@@ -0,0 +1,203 @@
+/*!
+ * \file src/MenuFolder.cpp
+ * \brief File-Explorer like menu
+ *
+ * \author xythobuz
+ */
+
+#include "global.h"
+#include "Console.h"
+#include "Font.h"
+#include "OpenRaider.h"
+#include "TombRaider.h"
+#include "Window.h"
+#include "MenuFolder.h"
+
+MenuFolder::MenuFolder() {
+    mVisible = false;
+    mCursor = 0;
+    mMin = 0;
+    mapFolder = nullptr;
+    hiddenState = false;
+    dialogState = false;
+}
+
+MenuFolder::~MenuFolder() {
+    delete mapFolder;
+    mapFolder = nullptr;
+}
+
+int MenuFolder::initialize() {
+    return initialize(getOpenRaider().mPakDir);
+}
+
+int MenuFolder::initialize(std::string s) {
+    return initialize(new Folder(s));
+}
+
+int MenuFolder::initialize(Folder *folder, bool filter) {
+    if (mapFolder != nullptr)
+        delete mapFolder;
+    mapFolder = folder;
+    mMin = mCursor = 0;
+
+    if (filter) {
+        mapFolder->executeRemoveFiles([](File &f) {
+            // Filter files based on file name
+            if ((f.getName().length() > 4)
+                && (f.getName().compare(f.getName().length() - 4, 4, ".phd") != 0)
+                && (f.getName().compare(f.getName().length() - 4, 4, ".tr2") != 0)
+                && (f.getName().compare(f.getName().length() - 4, 4, ".tr4") != 0)
+                && (f.getName().compare(f.getName().length() - 4, 4, ".trc") != 0)) {
+                return true; // delete file from list
+            }
+
+            // Check maps for validity
+            int error = TombRaider::checkMime(f.getPath().c_str());
+            if (error != 0) {
+                getConsole() << "Error: pak file '" << f.getName().c_str()
+                    << "' " << ((error == -1) ? "not found" : "invalid") << Console::endl;
+                return true; // delete file from list
+            }
+
+            return false; // keep file on list
+        });
+    }
+
+    if ((mapFolder->fileCount() + mapFolder->folderCount()) > 0)
+        mCursor = 1; // Don't select ".." by default
+
+    return 0;
+}
+
+void MenuFolder::display() {
+    if (!mVisible)
+        return;
+
+    // Draw half-transparent overlay
+    glColor4f(0.0f, 0.0f, 0.0f, 0.75f);
+    glDisable(GL_TEXTURE_2D);
+    glRecti(0, 0, (GLint)getWindow().getWidth(), (GLint)getWindow().getHeight());
+    glEnable(GL_TEXTURE_2D);
+
+    // Draw heading
+    getFont().drawTextCentered(0, 10, 1.2f, BLUE, getWindow().getWidth(), VERSION);
+
+    // Estimate displayable number of items
+    int items = (getWindow().getHeight() - 60) / 25;
+
+    // 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,
+                ((i - 1) < mapFolder->folderCount()) ?
+                    (mapFolder->getFolder(i - 1).getName() + "/")
+                    : mapFolder->getFile(i - 1 - mapFolder->folderCount()).getName());
+        }
+    }
+
+    displayDialog();
+}
+
+void MenuFolder::loadOrOpen() {
+    if (mCursor == 0) {
+        if (initialize(mapFolder->getParent().getPath()) != 0) {
+            showDialog("Error reading parent folder!", "OK", "");
+        }
+    } else if ((mCursor - 1) < mapFolder->folderCount()) {
+        if (initialize(mapFolder->getFolder(mCursor - 1).getPath()) != 0) {
+            showDialog("Error reading subfolder!", "OK", "");
+        }
+    } else {
+        std::string tmp = "load ";
+        tmp += mapFolder->getFile((unsigned long)mCursor - 1 - mapFolder->folderCount()).getPath();
+        if (getOpenRaider().command(tmp.c_str()) == 0) {
+            setVisible(false);
+        } else {
+            showDialog("Error loading map!", "OK", "");
+        }
+    }
+}
+
+void MenuFolder::handleKeyboard(KeyboardButton key, bool pressed) {
+    if (handleKeyboardDialog(key, pressed))
+        return;
+
+    if (!pressed)
+        return;
+
+    assert(mapFolder != nullptr);
+    int items = (getWindow().getHeight() - 60) / 25;
+
+    if (key == upKey) {
+        if (mCursor > 0)
+            mCursor--;
+        else
+            mCursor = (long)(mapFolder->folderCount() + mapFolder->fileCount());
+    } else if (key == downKey) {
+        if (mCursor < (long)(mapFolder->folderCount() + mapFolder->fileCount()))
+            mCursor++;
+        else
+            mCursor = 0;
+    } else if (key == enterKey) {
+        loadOrOpen();
+    } else if (key == dotKey) {
+        hiddenState = !hiddenState;
+        initialize(mapFolder->getPath());
+    }
+
+    if (mCursor > (mMin + items - 1)) {
+        mMin = mCursor - items + 1;
+    } else if (mCursor < mMin) {
+        mMin = mCursor;
+    }
+}
+
+void MenuFolder::handleMouseClick(unsigned int x, unsigned int y, KeyboardButton button, bool released) {
+    if (handleMouseClickDialog(x, y, button, released))
+        return;
+
+    int items = (getWindow().getHeight() - 60) / 25;
+
+    if (released || (button != leftmouseKey))
+        return;
+
+    if ((y >= 50) && (y <= (unsigned int)(50 + (25 * items)))
+            && ((mMin + (y / 25)) <= (mapFolder->folderCount() + mapFolder->fileCount() + 2))) {
+        y -= 50;
+        if (mCursor == (mMin + (y / 25)))
+            loadOrOpen();
+        else
+            mCursor = mMin + (y / 25);
+    }
+}
+
+void MenuFolder::handleMouseScroll(int xrel, int yrel) {
+    if (handleMouseScrollDialog(xrel, yrel));
+        return;
+
+    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/main.cpp

@@ -15,7 +15,7 @@
 #include "Exception.h"
 #include "FontManager.h"
 #include "Game.h"
-#include "Menu.h"
+#include "MenuFolder.h"
 #include "OpenRaider.h"
 #include "Render.h"
 #include "TextureManager.h"
@@ -59,7 +59,7 @@ Game &getGame() {
 }
 
 Menu &getMenu() {
-    static Menu gMenu;
+    static MenuFolder gMenu;
     return gMenu;
 }