New assert implementation, meta improvements

ChangeLog.md

 
 ## OpenRaider (0.1.3) xythobuz <xythobuz@xythobuz.de>
 
+    [ 20140517 ]
+    * Wrote new assert() implementation for Unix that prints a call stack
+    * Service provider methods (getCamera(), etc...) are now prototyped
+      in the header of the service they provide, making main.h useless
+    * Also some more work on the way to making OR compilable under Windows
+    * Not using glu.h anywhere anymore
+
     [ 20140516 ]
     * Finished moving the Entity/SkeletalModel logic into classes
     * Currently seems as if wrong SkeletalModels are used for entities?

include/Camera.h

     vec_t mRotationDeltaY;
 };
 
+Camera &getCamera();
+
 #endif

include/Console.h

     unsigned int mLineOffset;
 };
 
+Console &getConsole();
+
 #endif

include/Game.h

 
 #include "Camera.h"
 #include "Entity.h"
-#include "global.h"
 #include "Render.h"
 #include "TombRaider.h"
 #include "World.h"
     int mLara;
 };
 
+Game &getGame();
+
 #endif

include/Menu.h

 
 private:
 
+#ifdef WIN32
+    void loadPakFolderHelper(std::vector<char *> &list);
+#endif
+
     void loadPakFolderRecursive(const char *dir);
 
     void fillMapList();
     std::vector<char *> mMapList;
 };
 
+Menu &getMenu();
+
 #endif

include/OpenRaider.h

 
 #include <vector>
 
-#include "global.h"
 #include "Console.h"
 #include "Game.h"
 #include "Menu.h"
     KeyboardButton keyBindings[ActionEventCount];
 };
 
+OpenRaider &getOpenRaider();
+
 #endif

include/Render.h

 
 #include <vector>
 
-#include "config.h"
-#include "math/Matrix.h"
-#include "ViewVolume.h"
-#include "World.h"
-#include "Mesh.h"
+#include "Room.h"
 #include "Texture.h"
-#include "Camera.h"
-#include "RoomData.h"
+#include "ViewVolume.h"
+
+#include "WorldData.h"
 
 /*!
  * \brief OpenRaider Renderer class
     bool mSkyMeshRotation;                //!< Should Skymesh be rotated?
 };
 
+Render &getRender();
+
 #endif

include/Sound.h

      * \param source sound source to stop
      */
     virtual void stop(int source) = 0;
-
-private:
 };
 
+Sound &getSound();
+
 #endif
 

include/TombRaiderData.h

 
 #include <cstdint>
 
-#ifdef WIN32
-// Have to remove GCC packing, by removing in preprocessor
-#define __attribute__(packed)
-
-// MSVC++ pragma to pack structs
-#define TR2_H 1
+#ifdef _MSC_VER
 #pragma pack(push, tr2_h, 1)
 #endif
 
     unsigned int unknown[24];
 } tr5_cinematic_frame_t;
 
-#ifdef WIN32
+#ifdef _MSC_VER
 #pragma pack(pop, tr2_h, 1)
 #endif
 

include/Window.h

 #ifndef _WINDOW_H_
 #define _WINDOW_H_
 
-#ifdef WIN32
-#define __attribute__(x)
-#endif
-
 #include <ctime>
 
-#include "global.h"
-
 typedef struct {
     char *text;
     unsigned int x;
     char *mFontName;
 };
 
+Window &getWindow();
+
 #endif

include/WindowSDL.h

 #include "SDL.h"
 #include "SDL_ttf.h"
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#include <OpenGL/glu.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#include <GL/glu.h>
-#endif
-
 #include "Window.h"
 
 /*!
     SDL_GLContext mGLContext; //!< The OpenGL Context
 
     TTF_Font *mFont;
-    GLuint mFontTexture;
+    unsigned int mFontTexture;
 
     bool mTextInput;
 

include/World.h

     std::vector<SkeletalModel *> mModels;
 };
 
+World &getWorld();
+
 #endif

include/config.h.in

+/*!
+ * \file include/config.h.in
+ * \brief Global config file template
+ *
+ * \author xythobuz
+ */
+
+#ifndef _CONFIG_H_
+#define _CONFIG_H_
+
 #define VERSION "OpenRaider-@OpenRaider_VERSION_MAJOR@.@OpenRaider_VERSION_MINOR@.@OpenRaider_VERSION_MICRO@@OpenRaider_VERSION_RELEASE@ (@CMAKE_BUILD_TYPE@)"
 #define BUILD_HOST "@OpenRaider_BUILD_HOST@ @OpenRaider_HOSTNAME@"
 
 #define DEFAULT_CONFIG_FILE "OpenRaider.ini"
 #define DEFAULT_WIDTH 640
 #define DEFAULT_HEIGHT 480
+
+#cmakedefine USING_AL
+#cmakedefine HAVE_EXECINFO_H
+#cmakedefine HAVE_BACKTRACE
+#cmakedefine HAVE_BACKTRACE_SYMBOLS
+
+#endif
+

include/global.h

 #ifndef _GLOBAL_H_
 #define _GLOBAL_H_
 
+#include "config.h"
+
+// Visual C++ does not understand __attribute__
+#ifdef _MSC_VER
+#define __attribute__(x)
+#endif
+
+// Globally include OpenGL header
+#ifdef __APPLE__
+#include <OpenGL/gl.h>
+#else
+#ifdef WIN32
+#include <Windows.h>
+#endif
+#include <GL/gl.h>
+#endif
+
+#if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE) && defined(HAVE_BACKTRACE_SYMBOLS)
+#ifndef NDEBUG
+[[noreturn]] void assertImplementation(const char *exp, const char *file, int line);
+#define assert(x) (void)((x) || (assertImplementation(#x, __FILE__, __LINE__),0))
+#else
+#define assert(x)
+#endif
+#else
+#include <cassert>
+#endif
+
 const float BLACK[]       = {  0.0f,  0.0f,  0.0f, 1.0f };
 const float DIM_WHITE[]   = {  0.5f,  0.5f,  0.5f, 1.0f };
 const float WHITE[]       = {  1.0f,  1.0f,  1.0f, 1.0f };

include/main.h

-/*!
- * \file include/main.h
- * \brief Service locator
- *
- * \author xythobuz
- */
-#ifndef _MAIN_H_
-#define _MAIN_H_
-
-#include "Camera.h"
-#include "Console.h"
-#include "Game.h"
-#include "Menu.h"
-#include "OpenRaider.h"
-#include "Render.h"
-#include "Sound.h"
-#include "Window.h"
-#include "World.h"
-
-Camera &getCamera();
-
-Console &getConsole();
-
-Game &getGame();
-
-Menu &getMenu();
-
-OpenRaider &getOpenRaider();
-
-Render &getRender();
-
-Sound &getSound();
-
-Window &getWindow();
-
-World &getWorld();
-
-/*!
- * \brief Program entry point
- * \param argc number of arguments
- * \param argv array with argc strings
- * \returns 0 on success
- */
-int main(int argc, char *argv[]);
-
-#endif
-

include/utils/strings.h

 #ifndef _UTILS_STRINGS_H_
 #define _UTILS_STRINGS_H_
 
-#ifdef WIN32
-#define __attribute__(x)
-#endif
-
 #include <cstdarg>
 #include <vector>
 

include/utils/tga.h

 #ifndef _UTILS_TGA_H
 #define _UTILS_TGA_H
 
-#ifdef WIN32
-#define __attribute__(x)
-#endif
-
 /*!
  * \brief Possible TGA image types
  */

src/CMakeLists.txt

 option (ENABLE_AUDIO "Enable Sound Output" YES)
 if (OPENAL_FOUND AND ALUT_FOUND AND ENABLE_AUDIO)
     set (SRCS ${SRCS} "SoundAL.cpp")
-    set (OpenRaider_CXX_FLAGS "${OpenRaider_CXX_FLAGS} -DUSING_AL")
+    set (USING_AL TRUE)
 else (OPENAL_FOUND AND ALUT_FOUND AND ENABLE_AUDIO)
     set (SRCS ${SRCS} "SoundNull.cpp")
+    set (USING_AL FALSE)
     message (STATUS "Disabled Sound support (no OpenAL and ALUT)!")
 endif (OPENAL_FOUND AND ALUT_FOUND AND ENABLE_AUDIO)
 
 
 #################################################################
 
+# Check for header/function presence
+include (CheckIncludeFiles)
+include (CheckFunctionExists)
+
+# backtrace() for assert with call stack output
+check_include_files (execinfo.h HAVE_EXECINFO_H)
+check_function_exists (backtrace HAVE_BACKTRACE)
+check_function_exists (backtrace_symbols HAVE_BACKTRACE_SYMBOLS)
+
+#################################################################
+
 # Configuration Header file
 configure_file (
     "${PROJECT_SOURCE_DIR}/include/config.h.in"

src/Camera.cpp

 #include <stdio.h>
 #include <math.h>
 
+#include "global.h"
 #include "Camera.h"
 
 Camera::Camera() {

src/Command.cpp

 
 #include <cstdio>
 #include <cstring>
-#include <assert.h>
 
 #include "WindowSDL.h"
 
-#include "config.h"
+#include "global.h"
 #include "Console.h"
 #include "Entity.h"
 #include "Game.h"
-#include "main.h"
 #include "math/math.h"
 #include "Menu.h"
 #include "Sound.h"

src/Console.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
-
-#include "config.h"
 #include "global.h"
 #include "Console.h"
-#include "main.h"
+#include "OpenRaider.h"
 #include "utils/strings.h"
 #include "utils/time.h"
 

src/Entity.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#include <OpenGL/glu.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#include <GL/glu.h>
-#endif
-
+#include "global.h"
+#include "Console.h"
 #include "Entity.h"
-#include "main.h"
 #include "Render.h"
+#include "World.h"
 
 #include "games/TombRaider1.h"
 

src/Game.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
-
 #include <algorithm>
 #include <map>
 #include <cstdlib>
-#include <assert.h>
 
-#include "main.h"
+#include "global.h"
 #include "Console.h"
 #include "Game.h"
+#include "OpenRaider.h"
+#include "Sound.h"
 #include "utils/strings.h"
 
 #include "games/TombRaider1.h"

src/Menu.cpp

  * \author xythobuz
  */
 
-#include <assert.h>
 #include <cctype>
 
-#ifdef WIN32
-#include <Windows.h>
-#else
+#ifndef WIN32
 #include <dirent.h>
 #endif
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <GL/glew.h>
-#include <GL/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
-
-#include "config.h"
 #include "global.h"
-#include "main.h"
+#include "Console.h"
 #include "Menu.h"
+#include "OpenRaider.h"
 #include "utils/strings.h"
 
 Menu::Menu() {
 }
 
 #ifdef WIN32
-void loadPakFolderHelper(std::list<char *> &list) {
+void Menu::loadPakFolderHelper(std::vector<char *> &list) {
     WIN32_FIND_DATA fd;
     char *tmp = bufferString("%s\\*", list.at(0));
     HANDLE hFind = FindFirstFile(tmp, &fd);
     FindClose(hFind);
     delete [] tmp;
     delete [] list.at(0);
-    list.pop_front();
+    list.erase(list.begin());
 }
 #endif
 
     assert(dir != NULL);
     assert(dir[0] != '\0');
 #ifdef WIN32
-    std::list<char *> list;
+    std::vector<char *> list;
     list.push_back(bufferString("%s", dir));
     do {
         loadPakFolderHelper(list);

src/Mesh.cpp

  */
 
 #include <stdlib.h>
-#include <assert.h>
-
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
 
+#include "global.h"
 #include "Mesh.h"
 
 

src/OpenRaider.cpp

 
 #include <cstdio>
 #include <cstring>
-#include <assert.h>
 
-#include "config.h"
+#include "global.h"
 #include "Console.h"
 #include "Game.h"
-#include "main.h"
 #include "math/math.h"
 #include "Menu.h"
 #include "Sound.h"
         returnValue = this->command(token, &args);
     }
 
-    free(cmd);
+    delete [] cmd;
     return returnValue;
 }
 

src/Render.cpp

 
 #include <algorithm>
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
-
 #include <stdlib.h>
 #include <math.h>
 #include <string.h>
 
 #include "global.h"
-#include "main.h"
 #include "Game.h"
 #include "OpenRaider.h"
 #include "Render.h"

src/Room.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#include <OpenGL/glu.h>
-#else
-#include <GL/gl.h>
-#include <GL/glu.h>
-#endif
-
 #include <algorithm>
-#include <assert.h>
 
-#include "main.h"
+#include "global.h"
+#include "Console.h"
+#include "Game.h"
+#include "Render.h"
 #include "Room.h"
 
 Room::Room(TombRaider &tr, unsigned int index) {

src/RoomData.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#include <OpenGL/glu.h>
-#else
-#include <GL/gl.h>
-#include <GL/glu.h>
-#endif
-
-#include "main.h"
+#include "global.h"
+#include "Render.h"
 #include "RoomData.h"
+#include "World.h"
 
 BoundingBox::BoundingBox() {
     a[0] = a[1] = a[2] = 0;

src/SkeletalModel.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#include <OpenGL/glu.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#include <GL/glu.h>
-#endif
-
-#include <assert.h>
-
-#include "main.h"
+#include "global.h"
+#include "Console.h"
+#include "Render.h"
 #include "SkeletalModel.h"
+#include "World.h"
 
 BoneTag::BoneTag(TombRaider &tr, unsigned int index, int j, unsigned int *l, unsigned short **frame, unsigned int *frame_offset) {
     tr2_moveable_t *moveable = tr.Moveable();

src/Sound.cpp

  * \author xythobuz
  */
 
+#include "global.h"
 #include "Sound.h"
 
 Sound::~Sound() {

src/SoundAL.cpp

 
 #include <cstdio>
 #include <cstdlib>
-#include <assert.h>
 
+#include "global.h"
 #include "math/math.h"
 #include "SoundAL.h"
 

src/SoundNull.cpp

  * \author xythobuz
  */
 
+#include "global.h"
 #include "SoundNull.h"
 
 SoundNull::SoundNull() {

src/Sprite.cpp

  * \author xythobuz
  */
 
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#include <OpenGL/glu.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#include <GL/glu.h>
-#endif
-
-#include "main.h"
+#include "global.h"
+#include "Camera.h"
+#include "Game.h"
+#include "Render.h"
 #include "Sprite.h"
 
 SpriteSequence::SpriteSequence(TombRaider &tr, unsigned int item, unsigned int sequence) {

src/Texture.cpp

 #include <stdlib.h>
 #include <stdio.h>
 #include <stdarg.h>
-#include <assert.h>
-
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
 
+#include "global.h"
 #include "utils/strings.h"
 #include "utils/tga.h"
 #include "Texture.h"
     }
 
     // Capture frame buffer
-    glReadPixels(0, 0, width, height, GL_BGR, GL_UNSIGNED_BYTE, image);
+    glReadPixels(0, 0, width, height, GL_BGR_EXT, GL_UNSIGNED_BYTE, image);
 
     tgaSaveFilename(image, width, height, 0, "%s", filename);
     printf("Took screenshot '%s'.\n", filename);

src/TombRaider.cpp

 
 #include <zlib.h>
 
+#include "global.h"
 #include "TombRaider.h"
 
 #ifdef __TEST_TR5_DUMP_TGA

src/ViewVolume.cpp

 
 #include <math.h>
 
+#include "global.h"
 #include "ViewVolume.h"
 
 ViewVolume::ViewVolume() {

src/Window.cpp

 #include <cstdio>
 #include <cstring>
 #include <cstdarg>
-#include <assert.h>
-
-#ifdef __APPLE__
-#include <OpenGL/gl.h>
-#elif defined WIN32
-#include <gl/glew.h>
-#include <gl/wglew.h>
-#else
-#include <GL/gl.h>
-#endif
 
+#include "global.h"
 #include "math/math.h"
 #include "Window.h"
 

src/WindowSDL.cpp

  */
 
 #include <cstdio>
-#include <assert.h>
 
-#include "config.h"
-#include "main.h"
+#include "global.h"
+#include "OpenRaider.h"
 #include "utils/strings.h"
 #include "WindowSDL.h"
 
         if (surface->format->Rmask == 0x000000FF)
             textureFormat = GL_RGB;
         else
-            textureFormat = GL_BGR;
+            textureFormat = GL_BGR_EXT;
     }
 
     glBindTexture(GL_TEXTURE_2D, mFontTexture);

src/World.cpp

 
 #include <cstdio>
 #include <math.h>
-#include <assert.h>
 
+#include "global.h"
 #include "World.h"
 
 World::~World() {

src/main.cpp

 #include <cstdlib>
 #include <cstdio>
 #include <cstring>
-#include <assert.h>
 
-#include "config.h"
-#include "main.h"
+#include "global.h"
+#include "Camera.h"
+#include "Console.h"
+#include "Game.h"
+#include "Menu.h"
+#include "OpenRaider.h"
+#include "Render.h"
+#include "World.h"
 #include "utils/time.h"
 
 #ifdef USING_AL
 #ifdef USING_AL
 SoundAL gSound;
 #else
-#warn Sound output deactivated!
 SoundNull gSound;
 #endif
 
     return 0;
 }
 
+#if defined(HAVE_EXECINFO_H) && defined(HAVE_BACKTRACE) && defined(HAVE_BACKTRACE_SYMBOLS) && (!defined(NDEBUG))
+
+#include <execinfo.h>
+
+void assertImplementation(const char *exp, const char *file, int line) {
+    const unsigned int maxSize = 128;
+    void *callstack[maxSize];
+    int frames = backtrace(callstack, maxSize);
+    char **strs = backtrace_symbols(callstack, frames);
+
+    printf("\nassertion failed:\n");
+    printf("\t%s\n", exp);
+    printf("in %s:%d\n\n", file, line);
+
+    for (int i = 0; i < frames; i++)
+        printf("%s\n", strs[i]);
+
+    delete [] strs;
+    abort();
+}
+
+#endif
+

src/math/Matrix.cpp

 #include <stdio.h>
 #include <math.h>
 
+#include "global.h"
 #include "math/Matrix.h"
 
 Matrix::Matrix() {

src/math/Quaternion.cpp

 
 #include <math.h>
 
+#include "global.h"
 #include "math/Quaternion.h"
 
 Quaternion::Quaternion() {

src/math/Vector3d.cpp

 
 #include <math.h>
 
+#include "global.h"
 #include "math/Vector3d.h"
 
 Vector3d::Vector3d() {

src/math/math.cpp

 #include <stdlib.h>
 #include <math.h>
 #include <float.h>
-#include <assert.h>
+#include <algorithm>
 
+#include "global.h"
 #include "math/Vector3d.h"
 #include "math/Matrix.h"
 #include "math/math.h"
 
 bool equalEpsilon(vec_t a, vec_t b) {
     vec_t epsilon = FLT_EPSILON;
-    if (fabs(a - b) <= (fmax(fabs(a), fabs(b)) * epsilon))
+    if (fabs(a - b) <= (std::max(fabs(a), fabs(b)) * epsilon))
         return true;
     return false;
 }

src/utils/strings.cpp

 #include <cstdlib>
 #include <stdio.h>
 #include <string.h>
-#include <assert.h>
 
 #if defined(unix) || defined(__APPLE__) || defined(__linux__)
 #include <wordexp.h>
 #elif defined(WIN32)
 #include <Windows.h>
+#include <shlobj.h>
+#ifndef va_copy
+#define va_copy(d,s) ((d) = (s))
+#endif
 #endif
 
+#include "global.h"
 #include "utils/strings.h"
 
 char *stringRemoveQuotes(const char *s) {
         wordfree(&word);
 #elif defined(WIN32)
         WCHAR newPath[MAX_PATH];
-        if (SUCCEEDED(SHGetFolderPathW(NULL, CSIDL_PROFILE, NULL, 0, newPath)) {
-            lenPath = strlen(newPath);
+        if (SHGetFolderPathW(NULL, CSIDL_PROFILE, NULL, 0, newPath) == S_OK) {
+            lenPath = strlen((const char *)newPath);
             unsigned int lenPath2 = strlen(path);
             dir = new char[lenPath + lenPath2 + 2]; // space for end char
-            strncpy(dir, newPath, lenPath);
+            strncpy(dir, (const char *)newPath, lenPath);
             dir[lenPath] = '\\';
             strncpy((dir + lenPath + 1), (path + 1), lenPath2 - 1);
             lenPath += lenPath2;

src/utils/tga.cpp

 #include <stdio.h>
 #include <string.h>
 #include <stdarg.h>
-#include <assert.h>
 
+#include "global.h"
 #include "utils/tga.h"
 
 int tgaCheck(FILE *f) {

src/utils/time.cpp

  * \author xythobuz
  */
 
+#include "global.h"
 #include "utils/time.h"
 
 #if defined(unix) || defined(__APPLE__) || defined (__linux__)
 }
 
 #else
-#warn "No support for timer on this platform!"
 
-unsigned long systemTimerGet() { return 0; }
-
-void systemTimerReset() { }
+#error "No support for timer on this platform!"
 
 #endif