Screenshot command and other small improvements

ChangeLog.md

     * Added utf8-cpp dependency to allow Console to delete multi-byte chars
     * Added stream-style printing to Console
     * Using Console like Stream everywhere, removed old print method
+    * Added Screenshot command back
 
     [ 20140809 ]
     * Script Unit Test brings it’s own scripts to test

include/Game.h

 #ifndef _GAME_H_
 #define _GAME_H_
 
+#include <string>
 #include <vector>
 
 #include "Entity.h"
     void processModels();
     void processRooms();
 
-    char *mName;
+    std::string levelName;
     bool mLoaded;
 
     TombRaider mTombRaider;

include/Render.h

      * \brief Makes a screenshot, writes to disk
      * \param filenameBase basename of file to be written
      */
-    void screenShot(char *filenameBase);
+    void screenShot(const char *filenameBase);
 
     /*!
      * \brief Gets current rendering mode

include/TombRaider.h

      * \returns 0 on success, < 0 on error
      * \sa TombRaider::loadTR5()
      */
-    int Load(char *filename);
+    int Load(const char *filename);
 
     /*!
      * \brief Makes a clamped 0.0 to 1.0 texel from coord pair
      * \param filename pak to load
      * \returns < 0 on error
      */
-    int loadSFX(char *filename);
+    int loadSFX(const char *filename);
 
     void reset();
 

include/config.h.in

 #define _CONFIG_H_
 
 extern const char *VERSION;
+extern const char *VERSION_SHORT;
 extern const char *BUILD_HOST;
 
 #cmakedefine USING_AL

include/utils/strings.h

 /*!
  * \brief Generates a buffered string for the printf call
  * \param string format string like for printf
- * \param args arguments matching format string
- * \returns string in a buffer
- */
-char *bufferString(const char *string, va_list args) __attribute__((format(printf, 1, 0)));
-
-/*!
- * \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)));

src/Command.cpp

             getConsole() << "  bind      - bind a keyboard/mouse action" << Console::endl;
             getConsole() << "  animate   - [BOOL|n|p] - Animate models" << Console::endl;
             getConsole() << "  move      - [walk|fly|noclip]" << Console::endl;
-/*
             getConsole() << "  sshot     - make a screenshot" << Console::endl;
+/*
             getConsole() << "  sound     - INT - Test play sound" << Console::endl;
             getConsole() << "  mode      - MODE - Render mode" << Console::endl;
             getConsole() << "  light     - BOOL - GL Lights" << Console::endl;
             return -9;
         }
         getConsole() << temp.c_str()  << "ing" << Console::endl;
-
+    } else if (cmd.compare("sshot") == 0) {
+        if (!mRunning) {
+            getConsole() << "Use sshot command interactively!" << Console::endl;
+            return -999;
+        }
+        std::string filename(mBaseDir);
+        filename += "/sshots/";
+        filename += VERSION_SHORT;
+        bool console = false, menu = false;
+        std::string temp;
+        command >> temp;
+        if (temp.compare("console") == 0)
+            console = true;
+        if (temp.compare("menu") == 0)
+            menu = true;
+        if (!console) {
+            getConsole().setVisible(false);
+            if (menu)
+                getMenu().setVisible(true);
+            frame();
+            frame(); // Double buffered
+        }
+        getRender().screenShot(filename.c_str());
+        if (!console) {
+            getConsole().setVisible(true);
+            if (menu)
+                getMenu().setVisible(false);
+        }
+        getConsole() << "Screenshot stored..." << Console::endl;
 /*
     } else if (cmd.compare("mode") == 0) {
         std::string mode;
             getConsole().print("Invalid use of ponytail-command!");
             return -45;
         }
-    } else if (cmd.compare("sshot") == 0) {
-        if (!mRunning) {
-            getConsole().print("Use sshot command interactively!");
-            return -999;
-        }
-        char *filename = bufferString("%s/sshots/%s", mBaseDir, VERSION);
-        bool console = (args->size() > 0) && (strcmp(args->at(0), "console") == 0);
-        bool menu = (args->size() > 0) && (strcmp(args->at(0), "menu") == 0);
-        if (!console) {
-            getConsole().setVisible(false);
-            if (menu)
-                getMenu().setVisible(true);
-            frame();
-            frame(); // Double buffered
-        }
-        getRender().screenShot(filename);
-        if (!console) {
-            getConsole().setVisible(true);
-            if (menu)
-                getMenu().setVisible(false);
-        }
-        getConsole().print("Screenshot stored...");
-        delete filename;
     } else if (cmd.compare("sound") == 0) {
         if ((!mRunning) || (!getGame().isLoaded())) {
             getConsole().print("Use sound command interactively!");
     } else if (cmd.compare("load") == 0) {
         getConsole() << "load-Command Usage:" << Console::endl;
         getConsole() << "  load /path/to/level" << Console::endl;
-/*
     } else if (cmd.compare("sshot") == 0) {
-        getConsole().print("sshot-Command Usage:");
-        getConsole().print("  sshot [console|menu]");
-        getConsole().print("Add console/menu to capture them too");
+        getConsole() << "sshot-Command Usage:" << Console::endl;
+        getConsole() << "  sshot [console|menu]" << Console::endl;
+        getConsole() << "Add console/menu to capture them too" << Console::endl;
+/*
     } else if (cmd.compare("sound") == 0) {
         getConsole().print("sound-Command Usage:");
         getConsole().print("  sound INT");

src/Game.cpp

 
 Game::Game() {
     mLoaded = false;
-    mName = NULL;
     mLara = -1;
     mTextureStart = 0;
     mTextureOffset = 0;
 }
 
 void Game::destroy() {
-    delete [] mName;
-    mName = NULL;
-
     mLoaded = false;
     mLara = -1;
     getRender().setMode(Render::modeDisabled);
     if (mLoaded)
         destroy();
 
-    mName = bufferString("%s", level);
+    levelName = level;
 
-    getConsole() << "Loading " << mName << Console::endl;
-    int error = mTombRaider.Load(mName);
+    getConsole() << "Loading " << levelName << Console::endl;
+    int error = mTombRaider.Load(levelName.c_str());
     if (error != 0)
         return error;
 
     // If required, load the external sound effect file MAIN.SFX into TombRaider
     if ((mTombRaider.getEngine() == TR_VERSION_2) || (mTombRaider.getEngine() == TR_VERSION_3)) {
-        char *tmp = bufferString("%sMAIN.SFX", level); // Ensure theres enough space
-        size_t length = strlen(tmp);
-        size_t dir = 0;
-        for (long i = length - 1; i >= 0; i--) {
-            if ((tmp[i] == '/') || (tmp[i] == '\\')) {
-                dir = i + 1; // Find where the filename (bla.tr2) starts
-                break;
-            }
-        }
-        strcpy(tmp + dir, "MAIN.SFX"); // overwrite the name itself with MAIN.SFX
-        tmp[dir + 8] = '\0';
-        error = mTombRaider.loadSFX(tmp);
+        std::string tmp(levelName);
+        size_t pos = tmp.rfind('/');
+        tmp.erase(pos + 1);
+        tmp += "MAIN.SFX";
+        error = mTombRaider.loadSFX(tmp.c_str());
         if (error != 0)
             getConsole() << "Could not load " << tmp << Console::endl;
-        delete [] tmp;
     }
 
     // Process data
     mTombRaider.reset();
 
     if (mLara == -1) {
+        //! \todo Cutscene support
         getConsole() << "Can't find Lara entity in level pak!" << Console::endl;
         destroy();
         return -1;

src/Menu.cpp

             //! \todo Display something if an error occurs
         }
     } else {
-        char *tmp = bufferString("load %s",
-                mapFolder->getFile((unsigned long)mCursor - 1 - mapFolder->folderCount()).getPath().c_str());
-        if (getOpenRaider().command(tmp) == 0) {
+        std::string tmp = "load ";
+        tmp += mapFolder->getFile((unsigned long)mCursor - 1 - mapFolder->folderCount()).getPath();
+        if (getOpenRaider().command(tmp.c_str()) == 0) {
             setVisible(false);
         } else {
             //! \todo Display something if an error occurs
         }
-        delete [] tmp;
     }
 }
 

src/Render.cpp

  */
 
 #include <algorithm>
+#include <sstream>
 
 #include <stdlib.h>
 #include <math.h>
 }
 
 
-void Render::screenShot(char *filenameBase)
+void Render::screenShot(const char *filenameBase)
 {
     int sz = getWindow().getWidth() * getWindow().getHeight();
     unsigned char *image = new unsigned char[sz * 3];
-    char *filename = NULL;
     static int count = 0;
     bool done = false;
 
-    assert(filenameBase != NULL);
+    assert(filenameBase != nullptr);
 
     // Don't overwrite files
+    std::ostringstream filename;
     while (!done) {
-        filename = bufferString("%s-%04i.tga", filenameBase, count++);
+        filename << filenameBase << "-" << count++ << ".tga";
 
-        FILE *f = fopen(filename, "rb");
-
-        if (f)
+        FILE *f = fopen(filename.str().c_str(), "rb");
+        if (f) {
             fclose(f);
-        else
+        } else {
             done = true;
+        }
     }
 
-    // Capture frame buffer
     glReadPixels(0, 0, getWindow().getWidth(), getWindow().getHeight(), GL_BGR_EXT, GL_UNSIGNED_BYTE, image);
-
-    tgaSave(filename, image, getWindow().getWidth(), getWindow().getHeight(), 0);
-    printf("Took screenshot '%s'.\n", filename);
-
-    delete [] filename;
+    tgaSave(filename.str().c_str(), image, getWindow().getWidth(), getWindow().getHeight(), 0);
     delete [] image;
 }
 

src/TextureManager.cpp

     delete [] image;
 
     //! \fixme Temporary
-    char *filename = bufferString("%s/tr2/TITLE.PCX", getOpenRaider().mPakDir);
-    if (loadPCX(filename) < 0) {
-        delete [] filename;
+    std::string filename(getOpenRaider().mPakDir);
+    filename += "/tr2/TITLE.PCX";
+    if (loadPCX(filename.c_str()) < 0) {
         //! \fixme Error Checking. Return negative error code, check in calling place too
-        filename = bufferString("%s/%s", getOpenRaider().mDataDir, "splash.tga");
-        loadTGA(filename);
+        filename = getOpenRaider().mDataDir;
+        filename += "/splash.tga";
+        loadTGA(filename.c_str());
     }
-    delete [] filename;
 
     return (mTextureIds.size() == 0) ? -1 : 0;
 }

src/TombRaider.cpp

 }
 
 
-int TombRaider::Load(char *filename)
+int TombRaider::Load(const char *filename)
 {
     FILE *f;
     int i, j, l;
 // Public Mutators
 ////////////////////////////////////////////////////////////
 
-int TombRaider::loadSFX(char *filename)
+int TombRaider::loadSFX(const char *filename)
 {
     FILE *f = fopen(filename, "rb");
     long bytes = 0;

src/config.cpp.in

 
 const char *VERSION = "OpenRaider-@OpenRaider_VERSION_MAJOR@.@OpenRaider_VERSION_MINOR@.@OpenRaider_VERSION_MICRO@@OpenRaider_VERSION_RELEASE@ (@CMAKE_BUILD_TYPE@)";
 
+const char *VERSION_SHORT = "OpenRaider-@OpenRaider_VERSION_MAJOR@.@OpenRaider_VERSION_MINOR@.@OpenRaider_VERSION_MICRO@@OpenRaider_VERSION_RELEASE@";
+
 const char *BUILD_HOST = "@OpenRaider_BUILD_HOST@ @OpenRaider_HOSTNAME@";
 

src/utils/strings.cpp

     return strncmp(str + lenstr - lensuffix, suffix, lensuffix) == 0;
 }
 
-char *bufferString(const char *string, va_list args) {
+char *bufferString(const char *string, ...) {
+    va_list args, tmp;
     int sz = 60;
     int n;
     char *text;
-    va_list tmp;
 
     assert(string != NULL);
     assert(string[0] != '\0');
 
     text = new char[sz];
 
-    va_copy(tmp, args);
-    n = vsnprintf(text, sz, string, tmp);
-    va_end(tmp);
+    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];
-        va_copy(tmp, args);
-        vsnprintf(text, sz, string, tmp);
-        va_end(tmp);
+        vsnprintf(text, sz, string, args);
     }
 
-    return text;
-}
-
-char *bufferString(const char *string, ...) {
-    va_list args;
-    va_start(args, string);
-    char *text = bufferString(string, args);
     va_end(args);
     return text;
 }