Removed C-Style string handling code.

This resolves #4 as bufferString() no longer exists!

ChangeLog.md

@@ -5,6 +5,7 @@
     [ 20140901 ]
     * Created abstract UI class handling “windows” like menu and console. Windows
       can be stacked arbitrarily. The top most gets keyboard/mouse/action events.
+    * Removed old C-String handling utility methods, now using std::string
 
     [ 20140831 ]
     * Moved command specific code from OpenRaider to static Command methods

TODO.md

@@ -4,7 +4,6 @@
 
 * Move to newer OpenGL (GL ES or 2.1 or 3.x or 4.x?)
 * Don't use C-Style code, try to replace with C++ lib
-    * Use std::strings
 * Mesh has 2 different approaches of storing the same data (eg. mColors and mColorArray), but half of ‘em isn’t implemented. Unify this, probably even combining Mesh and StaticMesh...
 * Don’t use float everywhere just because (eg. float colors)
 * Add verbose command line flag for debug output also in release builds
@@ -31,7 +30,3 @@
 * Cut TGA image reader, currently only used for menu background?!
     * Need useful, always available image writer alternative for screenshots then
 
-* Create abstract interface from Game/Menu/Console, use this to do real “windows” that can be layered independently and can receive keyboard/mouse input
-* Put keyboard/mouse/windowing logic into UI or UIManager class
-* Move small rest of OpenRaider into main or a config class or something, remove OpenRaider class
-

include/Font.h

@@ -21,7 +21,7 @@ public:
      */
     virtual ~Font();
 
-    virtual void setFont(const char *font);
+    virtual void setFont(std::string font);
 
     virtual int initialize() = 0;
 
@@ -41,7 +41,7 @@ public:
 
 protected:
     bool mFontInit;
-    char *mFontName;
+    std::string mFontName;
 };
 
 Font &getFont();

include/FontManager.h

@@ -39,11 +39,11 @@ public:
 
 private:
 
-    void add(Font *f, const char *e);
+    void add(Font *f, std::string e);
 
     int font;
     std::vector<Font *> fonts;
-    std::vector<const char *> extensions;
+    std::vector<std::string> extensions;
 };
 
 #endif

include/FontTRLE.h

@@ -40,7 +40,7 @@ public:
 
 private:
 
-    void loadLPS(const char *f);
+    void loadLPS(std::string f);
     void writeChar(unsigned int index, unsigned int xDraw, unsigned int yDraw,
             float scale, const unsigned char color[4]);
 

include/OpenRaider.h

@@ -16,37 +16,38 @@
 class OpenRaider {
 public:
 
-    /*!
-     * \brief Constructs an object of OpenRaider
-     */
     OpenRaider();
 
-    /*!
-     * \brief Deconstructs an object of OpenRaider
-     */
-    ~OpenRaider();
-
     int initialize();
 
     /*!
      * \brief Load the configuration file
      * \returns 0 on success
      */
-    int loadConfig(const char *config);
+    int loadConfig(std::string config);
 
-    int command(std::string command);
+    std::string getBaseDir();
+    void setBaseDir(std::string dir);
+    std::string getPakDir();
+    void setPakDir(std::string dir);
+    std::string getAudioDir();
+    void setAudioDir(std::string dir);
+    std::string getDataDir();
+    void setDataDir(std::string dir);
 
     void run();
     void frame();
 
     //! \fixme should be private
-    char *mBaseDir;
-    char *mPakDir;
-    char *mAudioDir;
-    char *mDataDir;
     KeyboardButton keyBindings[ActionEventCount];
     bool mRunning;
     bool mFPS;
+
+private:
+    std::string baseDir;
+    std::string pakDir;
+    std::string audioDir;
+    std::string dataDir;
 };
 
 OpenRaider &getOpenRaider();

include/utils/strings.h

@@ -3,43 +3,18 @@
  * \brief String handling utilities
  *
  * \author xythobuz
- * \author Mongoose
  */
 
 #ifndef _UTILS_STRINGS_H_
 #define _UTILS_STRINGS_H_
 
-#include <cstdarg>
+#include <string>
 
-char *stringRemoveQuotes(const char *s);
+std::string findAndReplace(std::string s, std::string find, std::string replace);
 
-char *stringReplace(const char *s, const char *search, const char *replace);
+std::string expandHomeDirectory(std::string s);
 
-int readBool(const char *value, bool *var);
-
-/*!
- * \brief Check if a string ends with another string.
- * \param str string to check
- * \param suffix suffix for which to check
- * \returns true if str ends with suffix
- */
-bool stringEndsWith(const char *str, const char *suffix);
-
-/*!
- * \brief Generates a buffered string for the printf call
- * \param string format string like for printf
- * \returns string in a buffer
- */
-char *bufferString(const char *string, ...) __attribute__((format(printf, 1, 2)));
-
-/*!
- * \brief Expansion of unix home enviroment char.
- * Also makes sure string ends in "end" char.
- * \param path path string
- * \param end end character. 0 appends no additional char
- * \returns allocated string of path with expansions
- */
-char *fullPath(const char *path, char end);
+bool stringEndsWith(std::string s, std::string suffix);
 
 #endif
 

src/Console.cpp

@@ -8,8 +8,8 @@
 #include <iostream>
 
 #include "global.h"
+#include "commands/Command.h"
 #include "Font.h"
-#include "OpenRaider.h"
 #include "utf8-cpp/utf8.h"
 #include "utils/strings.h"
 #include "utils/time.h"
@@ -104,7 +104,7 @@ void Console::handleKeyboard(KeyboardButton key, bool pressed) {
         if (mInputBuffer.length() > 0) {
             (*this) << "> " << mInputBuffer.c_str() << endl;
             mCommandHistory.push_back(mInputBuffer.c_str());
-            int error = getOpenRaider().command(mInputBuffer);
+            int error = Command::command(mInputBuffer);
             if (error != 0) {
                 (*this) << "Error Code: " << error << endl;
             }

src/Font.cpp

@@ -11,16 +11,11 @@
 #include "Font.h"
 
 Font::~Font() {
-    delete [] mFontName;
-    mFontName = NULL;
 }
 
-void Font::setFont(const char *font) {
-    assert(font != NULL);
-    assert(font[0] != '\0');
+void Font::setFont(std::string font) {
     assert(mFontInit == false);
-
-    mFontName = fullPath(font, 0);
+    mFontName = font;
 }
 
 void Font::drawTextCentered(unsigned int x, unsigned int y, float scale,

src/FontManager.cpp

@@ -32,7 +32,7 @@ FontManager::~FontManager() {
     }
 }
 
-void FontManager::add(Font *f, const char *e) {
+void FontManager::add(Font *f, std::string e) {
     fonts.push_back(f);
     extensions.push_back(e);
 }

src/FontSDL.cpp

@@ -13,7 +13,6 @@
 FontSDL::FontSDL() {
     mFont = NULL;
     mFontInit = false;
-    mFontName = NULL;
     mFontTexture = 0;
 }
 
@@ -29,15 +28,13 @@ FontSDL::~FontSDL() {
 
 int FontSDL::initialize() {
     assert(mFontInit == false);
-    assert(mFontName != NULL);
-    assert(mFontName[0] != '\0');
 
     if (TTF_Init() != 0) {
         printf("Could not initialize SDL-TTF!\n");
         return -1;
     }
 
-    mFont = TTF_OpenFont(mFontName, 24);
+    mFont = TTF_OpenFont(mFontName.c_str(), 24);
     if (mFont == NULL) {
         printf("TTF_OpenFont Error: %s\n", TTF_GetError());
         return -2;

src/FontTRLE.cpp

@@ -15,7 +15,6 @@
 
 FontTRLE::FontTRLE() {
     mFontInit = false;
-    mFontName = NULL;
     mFontTexture = 0;
 }
 
@@ -24,8 +23,6 @@ FontTRLE::~FontTRLE() {
 
 int FontTRLE::initialize() {
     assert(mFontInit == false);
-    assert(mFontName != NULL);
-    assert(mFontName[0] != '\0');
     assert(stringEndsWith(mFontName, ".pc") == true);
 
     // Load .pc file...
@@ -53,15 +50,14 @@ int FontTRLE::initialize() {
     delete [] pixels;
 
     // Try to load .lps file, overwriting default glyph positions
-    char *lpsFile = stringReplace(mFontName, ".pc", ".lps");
+    std::string lpsFile = findAndReplace(mFontName, ".pc", ".lps");
     loadLPS(lpsFile);
-    delete [] lpsFile;
 
     mFontInit = true;
     return 0;
 }
 
-void FontTRLE::loadLPS(const char *f) {
+void FontTRLE::loadLPS(std::string f) {
     std::ifstream file(f);
     if (!file)
         return;

src/MenuFolder.cpp

@@ -8,6 +8,7 @@
 #include "global.h"
 #include "Console.h"
 #include "Font.h"
+#include "Game.h"
 #include "loader/Loader.h"
 #include "OpenRaider.h"
 #include "Window.h"
@@ -32,7 +33,7 @@ MenuFolder::~MenuFolder() {
 }
 
 int MenuFolder::initialize() {
-    return initialize(getOpenRaider().mPakDir);
+    return initialize(getOpenRaider().getPakDir());
 }
 
 int MenuFolder::initialize(std::string s) {
@@ -118,9 +119,8 @@ void MenuFolder::loadOrOpen() {
             showDialog("Error reading subfolder!", "OK", "");
         }
     } else {
-        std::string tmp = "load ";
-        tmp += mapFolder->getFile((unsigned long)mCursor - 1 - mapFolder->folderCount()).getPath();
-        int error = getOpenRaider().command(tmp.c_str());
+        int error = getGame().loadLevel(mapFolder->getFile((unsigned long)mCursor
+                    - 1 - mapFolder->folderCount()).getPath().c_str());
         if (error == 0) {
             makeInvisible();
         } else {

src/OpenRaider.cpp

@@ -26,10 +26,6 @@
 OpenRaider::OpenRaider() {
     mRunning = false;
     mFPS = false;
-    mBaseDir = NULL;
-    mPakDir = NULL;
-    mAudioDir = NULL;
-    mDataDir = NULL;
 
     for (int i = 0; i < ActionEventCount; i++)
         keyBindings[i] = unknownKey;
@@ -37,25 +33,40 @@ OpenRaider::OpenRaider() {
     Command::fillCommandList();
 }
 
-OpenRaider::~OpenRaider() {
-    delete mBaseDir;
-    mBaseDir = NULL;
+std::string OpenRaider::getBaseDir() {
+    return baseDir;
+}
+
+void OpenRaider::setBaseDir(std::string dir) {
+    baseDir = dir;
+}
+
+std::string OpenRaider::getPakDir() {
+    return pakDir;
+}
+
+void OpenRaider::setPakDir(std::string dir) {
+    pakDir = dir;
+}
 
-    delete mPakDir;
-    mPakDir = NULL;
+std::string OpenRaider::getAudioDir() {
+    return audioDir;
+}
 
-    delete mAudioDir;
-    mAudioDir = NULL;
+void OpenRaider::setAudioDir(std::string dir) {
+    audioDir = dir;
+}
 
-    delete mDataDir;
-    mDataDir = NULL;
+std::string OpenRaider::getDataDir() {
+    return dataDir;
 }
 
-int OpenRaider::loadConfig(const char *config) {
-    assert(config != NULL);
-    assert(config[0] != '\0');
+void OpenRaider::setDataDir(std::string dir) {
+    dataDir = dir;
+}
 
-    char *configFile = fullPath(config, 0);
+int OpenRaider::loadConfig(std::string config) {
+    std::string configFile = expandHomeDirectory(config);
     getConsole() << "Loading config from \"" << configFile << "\"..." << Console::endl;
 
     std::ifstream file(configFile);
@@ -68,7 +79,7 @@ int OpenRaider::loadConfig(const char *config) {
         if (line.length() == 0)
             continue;
 
-        int error = command(line);
+        int error = Command::command(line);
         if (error != 0)
             getConsole() << "Error Code: " << error << Console::endl;
     }
@@ -78,10 +89,6 @@ int OpenRaider::loadConfig(const char *config) {
     return 0;
 }
 
-int OpenRaider::command(std::string c) {
-    return Command::command(c);
-}
-
 int OpenRaider::initialize() {
     // Initialize Windowing
     int error = getWindow().initialize();

src/TextureManager.cpp

@@ -46,11 +46,11 @@ int TextureManager::initialize() {
     delete [] image;
 
     //! \fixme Temporary
-    std::string filename(getOpenRaider().mPakDir);
+    std::string filename(getOpenRaider().getPakDir());
     filename += "/tr2/TITLE.PCX";
     if (loadPCX(filename.c_str()) < 0) {
         //! \fixme Error Checking. Return negative error code, check in calling place too
-        filename = getOpenRaider().mDataDir;
+        filename = getOpenRaider().getDataDir();
         filename += "/splash.tga";
         loadTGA(filename.c_str());
     }

src/commands/CommandEngine.cpp

@@ -60,7 +60,7 @@ int CommandScreenshot::execute(std::istream& args) {
         return -1;
     }
 
-    std::string filename(getOpenRaider().mBaseDir);
+    std::string filename(getOpenRaider().getBaseDir());
     filename += "/sshots/";
     filename += VERSION_SHORT;
 

src/commands/CommandSet.cpp

@@ -43,51 +43,28 @@ void CommandSet::printHelp() {
 }
 
 namespace {
-    char *expandDirectoryNames(const char *s) {
-        assert(s != NULL);
-        assert(s[0] != '\0');
-
-        char *result = bufferString("%s", s);
-
-        if (getOpenRaider().mPakDir != NULL) {
-            char *tmp = stringReplace(s, "$(pakdir)", getOpenRaider().mPakDir);
-            delete [] result;
-            result = tmp;
-        }
-
-        if (getOpenRaider().mAudioDir != NULL) {
-            char *tmp = stringReplace(s, "$(audiodir)", getOpenRaider().mAudioDir);
-            delete [] result;
-            result = tmp;
+    std::string expandNames(std::string s) {
+        // Remove quotes
+        if ((s.length() >= 3) &&
+                (((s[0] == '"') && (s[s.length() - 1] == '"'))
+                || ((s[0] == '\'') && (s[s.length() - 1] == '\'')))) {
+            s.erase(0, 1);
+            s.erase(s.length() - 1, 1);
         }
 
-        if (getOpenRaider().mDataDir != NULL) {
-            char *tmp = stringReplace(s, "$(datadir)", getOpenRaider().mDataDir);
-            delete [] result;
-            result = tmp;
-        }
+        // Expand Names
+        s = findAndReplace(s, "$(pakdir)", getOpenRaider().getPakDir());
+        s = findAndReplace(s, "$(audiodir)", getOpenRaider().getAudioDir());
+        s = findAndReplace(s, "$(datadir)", getOpenRaider().getDataDir());
+        s = findAndReplace(s, "$(basedir)", getOpenRaider().getBaseDir());
 
-        if (getOpenRaider().mBaseDir != NULL) {
-            char *tmp = stringReplace(result, "$(basedir)", getOpenRaider().mBaseDir);
-            delete [] result;
-            result = tmp;
-        }
+        // Full path
+        s = expandHomeDirectory(s);
 
-        return result;
+        return s;
     }
 }
 
-#define CHANGE_DIR_WITH_EXPANSION(a) do {     \
-    std::string temp;                         \
-    args >> temp;                             \
-    const char *value = temp.c_str();         \
-    char *quotes = stringRemoveQuotes(value); \
-    char *tmp = expandDirectoryNames(quotes); \
-    a = fullPath(tmp, 0);                     \
-    delete [] tmp;                            \
-    delete [] quotes;                         \
-} while(false)
-
 int CommandSet::execute(std::istream& args) {
     std::string var;
     args >> var;
@@ -142,22 +119,25 @@ int CommandSet::execute(std::istream& args) {
         }
         getOpenRaider().mFPS = fps;
     } else if (var.compare("basedir") == 0) {
-        CHANGE_DIR_WITH_EXPANSION(getOpenRaider().mBaseDir);
+        std::string temp;
+        args >> temp;
+        getOpenRaider().setBaseDir(expandNames(temp));
     } else if (var.compare("pakdir") == 0) {
-        CHANGE_DIR_WITH_EXPANSION(getOpenRaider().mPakDir);
+        std::string temp;
+        args >> temp;
+        getOpenRaider().setPakDir(expandNames(temp));
     } else if (var.compare("audiodir") == 0) {
-        CHANGE_DIR_WITH_EXPANSION(getOpenRaider().mAudioDir);
+        std::string temp;
+        args >> temp;
+        getOpenRaider().setAudioDir(expandNames(temp));
     } else if (var.compare("datadir") == 0) {
-        CHANGE_DIR_WITH_EXPANSION(getOpenRaider().mDataDir);
+        std::string temp;
+        args >> temp;
+        getOpenRaider().setDataDir(expandNames(temp));
     } else if (var.compare("font") == 0) {
         std::string temp;
         args >> temp;
-        const char *value = temp.c_str();
-        char *quotes = stringReplace(value, "\"", "");
-        char *tmp = expandDirectoryNames(quotes);
-        getFont().setFont(tmp);
-        delete [] tmp;
-        delete [] quotes;
+        getFont().setFont(expandNames(temp).c_str());
     } else {
         getConsole() << "set-Error: Unknown variable (" << var.c_str() << ")" << Console::endl;
         return -1;

src/utils/strings.cpp

@@ -3,141 +3,36 @@
  * \brief String handling utilities
  *
  * \author xythobuz
- * \author Mongoose
  */
 
-#include <cstdlib>
-#include <stdio.h>
-#include <string.h>
-
-#if defined(_WIN32) && (!defined(va_copy))
-#define va_copy(d,s) ((d) = (s))
-#endif
-
 #include "global.h"
 #include "utils/filesystem.h"
 #include "utils/strings.h"
 
-char *stringRemoveQuotes(const char *s) {
-    size_t length = strlen(s);
-    if ((s[0] == '"') && (s[length - 1] == '"')) {
-        char *buf = new char[length - 1];
-        for (size_t i = 1; i < (length - 1); i++)
-            buf[i - 1] = s[i];
-        buf[length - 2] = '\0';
-        return buf;
-    } else {
-        return bufferString("%s", s);
+std::string findAndReplace(std::string s, std::string find, std::string replace) {
+    size_t p = s.find(find);
+    while (p != std::string::npos) {
+        s.erase(p, find.length());
+        s.insert(p, replace);
+        p = s.find(find);
     }
+    return s;
 }
 
-char *stringReplace(const char *s, const char *search, const char *replace) {
-    const char *tmp = strstr(s, search);
-    if (tmp == NULL)
-        return bufferString("%s", s);
-    size_t offset = tmp - s;
-
-    size_t length = strlen(s) - strlen(search) + strlen(replace);
-    char *buf = new char[length + 1];
-    buf[length] = '\0';
-
-    for (size_t i = 0; i < offset; i++)
-        buf[i] = s[i];
-
-    for (size_t i = 0; i < strlen(replace); i++)
-        buf[offset + i] = replace[i];
-
-    for (size_t i = (offset + strlen(search)); i < strlen(s); i++)
-        buf[i + strlen(replace) - strlen(search)] = s[i];
-
-    char *ret = stringReplace(buf, search, replace);
-    delete [] buf;
-    return ret;
-}
-
-int readBool(const char *value, bool *var) {
-    if ((strcmp(value, "1") == 0) || (strcmp(value, "true") == 0) || (strcmp(value, "on") == 0)) {
-        *var = true;
-    } else if ((strcmp(value, "0") == 0) || (strcmp(value, "false") == 0) || (strcmp(value, "off") == 0)) {
-        *var = false;
-    } else {
-        return -1;
+std::string expandHomeDirectory(std::string s) {
+    if ((s.length() > 0) && (s[0] == '~')) {
+        s.erase(0, 1);
+        s.insert(0, getHomeDirectory());
     }
-
-    return 0;
+    return s;
 }
 
-bool stringEndsWith(const char *str, const char *suffix) {
-    assert(str != NULL);
-    assert(suffix != NULL);
-
-    size_t lenstr = strlen(str);
-    size_t lensuffix = strlen(suffix);
-
-    if (lensuffix > lenstr)
-        return false;
-
-    return strncmp(str + lenstr - lensuffix, suffix, lensuffix) == 0;
-}
-
-char *bufferString(const char *string, ...) {
-    va_list args, tmp;
-    int sz = 60;
-    int n;
-    char *text;
-
-    assert(string != NULL);
-    assert(string[0] != '\0');
-
-    text = new char[sz];
-
-    va_start(args, string);
-    n = vsnprintf(text, sz, string, args);
-
-    if (n < 0) {
-        delete [] text;
-        va_end(args);
-        return NULL; // encoding error
-    } else if (n >= sz) {
-        sz = n + 1; // buffer too small
-        delete [] text;
-        text = new char[sz + 1];
-        vsnprintf(text, sz, string, args);
-    }
-
-    va_end(args);
-    return text;
-}
-
-char *fullPath(const char *path, char end) {
-    size_t lenPath;
-    char *dir;
-
-    assert(path != NULL);
-    assert(path[0] != '\0');
-
-    if (path[0] == '~') {
-        std::string home = getHomeDirectory();
-        assert(home.length() > 0);
-        lenPath = strlen(path);
-        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
-        strncpy(dir, path, lenPath);
-    }
-
-    // Make sure ends in "end" char
-    if ((lenPath > 0) && (end != 0) && (dir[lenPath - 1] != end)) {
-        dir[lenPath] = end;
-        dir[lenPath + 1] = '\0';
-    } else {
-        dir[lenPath] = '\0';
+bool stringEndsWith(std::string s, std::string suffix) {
+    if (s.length() >= suffix.length()) {
+        std::string end = s.substr(s.length() - suffix.length());
+        return (end == suffix);
     }
 
-    return dir;
+    return false;
 }