2013-07-29 07:13:03 -04:00
|
|
|
|
|
|
|
// Globals.h
|
|
|
|
|
|
|
|
// This file gets included from every module in the project, so that global symbols may be introduced easily
|
|
|
|
// Also used for precompiled header generation in MSVC environments
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Compiler-dependent stuff:
|
|
|
|
#if defined(_MSC_VER)
|
|
|
|
// MSVC produces warning C4481 on the override keyword usage, so disable the warning altogether
|
|
|
|
#pragma warning(disable:4481)
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Disable some warnings that we don't care about:
|
|
|
|
#pragma warning(disable:4100)
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
#define _CRT_SECURE_NO_WARNINGS
|
|
|
|
|
|
|
|
#define OBSOLETE __declspec(deprecated)
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// No alignment needed in MSVC
|
|
|
|
#define ALIGN_8
|
|
|
|
#define ALIGN_16
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2014-06-01 09:19:01 -04:00
|
|
|
#define FORMATSTRING(formatIndex, va_argsIndex)
|
|
|
|
|
|
|
|
// MSVC has its own custom version of zu format
|
|
|
|
#define SIZE_T_FMT "%Iu"
|
|
|
|
#define SIZE_T_FMT_PRECISION(x) "%" #x "Iu"
|
|
|
|
#define SIZE_T_FMT_HEX "%Ix"
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2014-06-01 09:19:01 -04:00
|
|
|
#define NORETURN __declspec(noreturn)
|
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
#elif defined(__GNUC__)
|
|
|
|
|
|
|
|
// TODO: Can GCC explicitly mark classes as abstract (no instances can be created)?
|
|
|
|
#define abstract
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// TODO: Can GCC mark virtual methods as overriding (forcing them to have a virtual function of the same signature in the base class)
|
|
|
|
#define override
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
#define OBSOLETE __attribute__((deprecated))
|
|
|
|
|
|
|
|
#define ALIGN_8 __attribute__((aligned(8)))
|
|
|
|
#define ALIGN_16 __attribute__((aligned(16)))
|
|
|
|
|
|
|
|
// Some portability macros :)
|
|
|
|
#define stricmp strcasecmp
|
|
|
|
|
2014-06-01 09:19:01 -04:00
|
|
|
#define FORMATSTRING(formatIndex, va_argsIndex) __attribute__((format (printf, formatIndex, va_argsIndex)))
|
|
|
|
|
|
|
|
#define SIZE_T_FMT "%zu"
|
|
|
|
#define SIZE_T_FMT_PRECISION(x) "%" #x "zu"
|
|
|
|
#define SIZE_T_FMT_HEX "%zx"
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2014-06-01 09:19:01 -04:00
|
|
|
#define NORETURN __attribute((__noreturn__))
|
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
#else
|
|
|
|
|
|
|
|
#error "You are using an unsupported compiler, you might need to #define some stuff here for your compiler"
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
/*
|
|
|
|
// Copy and uncomment this into another #elif section based on your compiler identification
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Explicitly mark classes as abstract (no instances can be created)
|
|
|
|
#define abstract
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Mark virtual methods as overriding (forcing them to have a virtual function of the same signature in the base class)
|
|
|
|
#define override
|
|
|
|
|
|
|
|
// Mark functions as obsolete, so that their usage results in a compile-time warning
|
|
|
|
#define OBSOLETE
|
|
|
|
|
|
|
|
// Mark types / variables for alignment. Do the platforms need it?
|
|
|
|
#define ALIGN_8
|
|
|
|
#define ALIGN_16
|
|
|
|
*/
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Integral types with predefined sizes:
|
|
|
|
typedef long long Int64;
|
|
|
|
typedef int Int32;
|
|
|
|
typedef short Int16;
|
|
|
|
|
|
|
|
typedef unsigned long long UInt64;
|
|
|
|
typedef unsigned int UInt32;
|
|
|
|
typedef unsigned short UInt16;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// A macro to disallow the copy constructor and operator= functions
|
|
|
|
// This should be used in the private: declarations for any class that shouldn't allow copying itself
|
|
|
|
#define DISALLOW_COPY_AND_ASSIGN(TypeName) \
|
|
|
|
TypeName(const TypeName &); \
|
|
|
|
void operator=(const TypeName &)
|
|
|
|
|
|
|
|
// A macro that is used to mark unused function parameters, to avoid pedantic warnings in gcc
|
|
|
|
#define UNUSED(X) (void)(X)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// OS-dependent stuff:
|
|
|
|
#ifdef _WIN32
|
|
|
|
#define WIN32_LEAN_AND_MEAN
|
|
|
|
#include <Windows.h>
|
|
|
|
#include <winsock2.h>
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Windows SDK defines min and max macros, messing up with our std::min and std::max usage
|
|
|
|
#undef min
|
|
|
|
#undef max
|
2017-12-23 07:49:08 -05:00
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Windows SDK defines GetFreeSpace as a constant, probably a Win16 API remnant
|
|
|
|
#ifdef GetFreeSpace
|
|
|
|
#undef GetFreeSpace
|
|
|
|
#endif // GetFreeSpace
|
|
|
|
#else
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <sys/stat.h> // for mkdir
|
|
|
|
#include <sys/time.h>
|
|
|
|
#include <sys/socket.h>
|
|
|
|
#include <netinet/in.h>
|
|
|
|
#include <arpa/inet.h>
|
|
|
|
#include <netdb.h>
|
|
|
|
#include <time.h>
|
|
|
|
#include <dirent.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include <iostream>
|
|
|
|
|
|
|
|
#include <cstdio>
|
|
|
|
#include <cstring>
|
|
|
|
#include <pthread.h>
|
|
|
|
#include <semaphore.h>
|
|
|
|
#include <errno.h>
|
|
|
|
#include <fcntl.h>
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#define FILE_IO_PREFIX ""
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// CRT stuff:
|
2013-11-24 16:10:27 -05:00
|
|
|
#include <sys/stat.h>
|
2013-07-29 07:13:03 -04:00
|
|
|
#include <assert.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <math.h>
|
|
|
|
#include <stdarg.h>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// STL stuff:
|
|
|
|
#include <vector>
|
|
|
|
#include <list>
|
|
|
|
#include <deque>
|
|
|
|
#include <string>
|
|
|
|
#include <map>
|
|
|
|
#include <algorithm>
|
|
|
|
#include <memory>
|
|
|
|
#include <ctime>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Common headers (part 1, without macros):
|
2013-11-28 04:05:39 -05:00
|
|
|
#include "../../src/StringUtils.h"
|
|
|
|
#include "../../src/OSSupport/CriticalSection.h"
|
|
|
|
#include "../../src/OSSupport/Semaphore.h"
|
|
|
|
#include "../../src/OSSupport/Event.h"
|
|
|
|
#include "../../src/OSSupport/IsThread.h"
|
|
|
|
#include "../../src/OSSupport/File.h"
|
2013-07-29 07:13:03 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Common definitions:
|
|
|
|
|
2017-12-23 07:49:08 -05:00
|
|
|
#define LOG(x, ...) printf(x "\n", __VA_ARGS__)
|
2013-07-29 07:13:03 -04:00
|
|
|
#define LOGERROR LOG
|
|
|
|
#define LOGWARNING LOG
|
|
|
|
#define LOGINFO LOG
|
|
|
|
#define LOGWARN LOG
|
|
|
|
|
2017-12-23 07:49:08 -05:00
|
|
|
/** Evaluates to the number of elements in an array (compile-time!) */
|
2013-07-29 07:13:03 -04:00
|
|
|
#define ARRAYCOUNT(X) (sizeof(X) / sizeof(*(X)))
|
|
|
|
|
2017-12-23 07:49:08 -05:00
|
|
|
/** Allows arithmetic expressions like "32 KiB" (but consider using parenthesis around it, "(32 KiB)") */
|
2013-07-29 07:13:03 -04:00
|
|
|
#define KiB * 1024
|
|
|
|
|
2017-12-23 07:49:08 -05:00
|
|
|
/** Allows arithmetic expressions like "32 MiB" (but consider using parenthesis around it, "(32 MiB)") */
|
2013-07-29 07:13:03 -04:00
|
|
|
#define MiB * 1024 * 1024
|
|
|
|
|
2017-12-23 07:49:08 -05:00
|
|
|
/** Faster than (int)floorf((float)x / (float)div) */
|
|
|
|
#define FAST_FLOOR_DIV(x, div) ((x) < 0 ? (((int)x / div) - 1) : ((int)x / div))
|
2013-07-29 07:13:03 -04:00
|
|
|
|
2014-06-01 09:19:01 -04:00
|
|
|
#define TOLUA_TEMPLATE_BIND(...)
|
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Own version of assert() that writes failed assertions to the log for review
|
|
|
|
#ifdef _DEBUG
|
2017-12-23 07:49:08 -05:00
|
|
|
#define ASSERT(x) (!!(x) || (LOGERROR("Assertion failed: %s, file %s, line %i", #x, __FILE__, __LINE__), assert(0), 0))
|
2013-07-29 07:13:03 -04:00
|
|
|
#else
|
|
|
|
#define ASSERT(x) ((void)0)
|
|
|
|
#endif
|
|
|
|
|
|
|
|
// Pretty much the same as ASSERT() but stays in Release builds
|
2017-12-23 07:49:08 -05:00
|
|
|
#define VERIFY(x) (!!(x) || (LOGERROR("Verification failed: %s, file %s, line %i", #x, __FILE__, __LINE__), exit(1), 0))
|
2013-07-29 07:13:03 -04:00
|
|
|
|
2014-06-01 09:19:01 -04:00
|
|
|
typedef unsigned char Byte;
|
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2017-12-23 07:49:08 -05:00
|
|
|
/** A generic interface used mainly in ForEach() functions */
|
2013-07-29 07:13:03 -04:00
|
|
|
template <typename Type> class cItemCallback
|
|
|
|
{
|
|
|
|
public:
|
2017-12-23 07:49:08 -05:00
|
|
|
/** Called for each item in the internal list; return true to stop the loop, or false to continue enumerating */
|
2013-07-29 07:13:03 -04:00
|
|
|
virtual bool Item(Type * a_Type) = 0;
|
|
|
|
} ;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-08-27 03:46:59 -04:00
|
|
|
/** Clamp value to the specified range. */
|
|
|
|
template <typename T>
|
|
|
|
T Clamp(T a_Value, T a_Min, T a_Max)
|
|
|
|
{
|
|
|
|
return (a_Value < a_Min) ? a_Min : ((a_Value > a_Max) ? a_Max : a_Value);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2013-07-29 07:13:03 -04:00
|
|
|
// Common headers (part 2, with macros):
|
2013-11-28 04:05:39 -05:00
|
|
|
#include "../../src/ChunkDef.h"
|
|
|
|
#include "../../src/BlockID.h"
|