Move KeyList & InputHandler from game.h to client/inputhandler.h (#5752)
[oweals/minetest.git] / src / porting.h
index d7d1073406e69a558d1452aa29b1e42e5178e374..7034d956bdec2abed7a5b136847dd9e7e909335c 100644 (file)
@@ -24,10 +24,23 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef PORTING_HEADER
 #define PORTING_HEADER
 
+#ifdef _WIN32
+       #ifdef _WIN32_WINNT
+               #undef _WIN32_WINNT
+       #endif
+       #define _WIN32_WINNT 0x0501 // We need to do this before any other headers
+               // because those might include sdkddkver.h which defines _WIN32_WINNT if not already set
+#endif
+
 #include <string>
+#include <vector>
+#include "irrlicht.h"
 #include "irrlichttypes.h" // u32
+#include "irrlichttypes_extrabloated.h"
 #include "debug.h"
 #include "constants.h"
+#include "gettime.h"
+#include "threads.h"
 
 #ifdef _MSC_VER
        #define SWPRINTF_CHARSTRING L"%S"
@@ -40,42 +53,22 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 //#define ALIGNOF(type) offsetof (alignment_trick<type>, member)
 
 #ifdef _WIN32
-       #ifndef _WIN32_WINNT
-               #define _WIN32_WINNT 0x0500
-       #endif
        #include <windows.h>
-       
+
        #define sleep_ms(x) Sleep(x)
 #else
        #include <unistd.h>
        #include <stdint.h> //for uintptr_t
-       
-       #if (defined(linux) || defined(__linux)) && !defined(_GNU_SOURCE)
-               #define _GNU_SOURCE
-       #endif
 
-       #include <sched.h>
-
-       #ifdef __FreeBSD__
-               #include <pthread_np.h>
-               typedef cpuset_t cpu_set_t;
-       #elif defined(__sun) || defined(sun)
-               #include <sys/types.h>
-               #include <sys/processor.h>
-       #elif defined(_AIX)
-               #include <sys/processor.h>
-       #elif __APPLE__
-               #include <mach/mach_init.h>
-               #include <mach/thread_policy.h>
+       // Use standard Posix macro for Linux
+       #if (defined(linux) || defined(__linux)) && !defined(__linux__)
+               #define __linux__ 
+       #endif
+       #if (defined(__linux__) || defined(__GNU__)) && !defined(_GNU_SOURCE)
+               #define _GNU_SOURCE
        #endif
 
        #define sleep_ms(x) usleep(x*1000)
-       
-       #define THREAD_PRIORITY_LOWEST       0
-       #define THREAD_PRIORITY_BELOW_NORMAL 1
-       #define THREAD_PRIORITY_NORMAL       2
-       #define THREAD_PRIORITY_ABOVE_NORMAL 3
-       #define THREAD_PRIORITY_HIGHEST      4
 #endif
 
 #ifdef _MSC_VER
@@ -85,6 +78,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #define strtoll(x, y, z) _strtoi64(x, y, z)
        #define strtoull(x, y, z) _strtoui64(x, y, z)
        #define strcasecmp(x, y) stricmp(x, y)
+       #define strncasecmp(x, y, n) strnicmp(x, y, n)
 #else
        #define ALIGNOF(x) __alignof__(x)
 #endif
@@ -93,8 +87,40 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #define strtok_r(x, y, z) mystrtok_r(x, y, z)
 #endif
 
+// strlcpy is missing from glibc.  thanks a lot, drepper.
+// strlcpy is also missing from AIX and HP-UX because they aim to be weird.
+// We can't simply alias strlcpy to MSVC's strcpy_s, since strcpy_s by
+// default raises an assertion error and aborts the program if the buffer is
+// too small.
+#if defined(__FreeBSD__) || defined(__NetBSD__)    || \
+       defined(__OpenBSD__) || defined(__DragonFly__) || \
+       defined(__APPLE__)   ||                           \
+       defined(__sun)       || defined(sun)           || \
+       defined(__QNX__)     || defined(__QNXNTO__)
+       #define HAVE_STRLCPY
+#endif
+
+// So we need to define our own.
+#ifndef HAVE_STRLCPY
+       #define strlcpy(d, s, n) mystrlcpy(d, s, n)
+#endif
+
 #define PADDING(x, y) ((ALIGNOF(y) - ((uintptr_t)(x) & (ALIGNOF(y) - 1))) & (ALIGNOF(y) - 1))
 
+#if defined(__APPLE__)
+       #include <mach-o/dyld.h>
+       #include <CoreFoundation/CoreFoundation.h>
+#endif
+
+#ifndef _WIN32 // Posix
+       #include <sys/time.h>
+       #include <time.h>
+       #if defined(__MACH__) && defined(__APPLE__)
+               #include <mach/clock.h>
+               #include <mach/mach.h>
+       #endif
+#endif
+
 namespace porting
 {
 
@@ -121,60 +147,219 @@ extern std::string path_share;
 extern std::string path_user;
 
 /*
-       Get full path of stuff in data directory.
-       Example: "stone.png" -> "../data/stone.png"
+       Path to gettext locale files
 */
-std::string getDataPath(const char *subpath);
+extern std::string path_locale;
 
 /*
-       Initialize path_share and path_user.
+       Path to directory for storing caches.
 */
-void initializePaths();
+extern std::string path_cache;
 
 /*
-       Get number of online processors in the system.
+       Get full path of stuff in data directory.
+       Example: "stone.png" -> "../data/stone.png"
 */
-int getNumberOfProcessors();
+std::string getDataPath(const char *subpath);
 
 /*
-       Set a thread's affinity to a particular processor.
+       Move cache folder from path_user to the
+       system cache location if possible.
 */
-bool threadBindToProcessor(threadid_t tid, int pnumber);
+void migrateCachePath();
 
 /*
-       Set a thread's priority.
+       Initialize path_*.
 */
-bool threadSetPriority(threadid_t tid, int prio);
+void initializePaths();
 
 /*
-       Resolution is 10-20ms.
-       Remember to check for overflows.
-       Overflow can occur at any value higher than 10000000.
+       Return system information
+       e.g. "Linux/3.12.7 x86_64"
 */
+std::string get_sysinfo();
+
+void initIrrlicht(irr::IrrlichtDevice * );
+
+
+// Monotonic counter getters.
+
 #ifdef _WIN32 // Windows
-       #include <windows.h>
-       inline u32 getTimeMs()
-       {
-               return GetTickCount();
-       }
+
+extern double perf_freq;
+
+inline u64 os_get_time(double mult)
+{
+       LARGE_INTEGER t;
+       QueryPerformanceCounter(&t);
+       return static_cast<double>(t.QuadPart) / (perf_freq / mult);
+}
+
+// Resolution is <1us.
+inline u64 getTimeS() { return os_get_time(1); }
+inline u64 getTimeMs() { return os_get_time(1000); }
+inline u64 getTimeUs() { return os_get_time(1000*1000); }
+inline u64 getTimeNs() { return os_get_time(1000*1000*1000); }
+
 #else // Posix
-       #include <sys/time.h>
-       inline u32 getTimeMs()
-       {
-               struct timeval tv;
-               gettimeofday(&tv, NULL);
-               return tv.tv_sec * 1000 + tv.tv_usec / 1000;
+
+inline void os_get_clock(struct timespec *ts)
+{
+#if defined(__MACH__) && defined(__APPLE__)
+// From http://stackoverflow.com/questions/5167269/clock-gettime-alternative-in-mac-os-x
+// OS X does not have clock_gettime, use clock_get_time
+       clock_serv_t cclock;
+       mach_timespec_t mts;
+       host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &cclock);
+       clock_get_time(cclock, &mts);
+       mach_port_deallocate(mach_task_self(), cclock);
+       ts->tv_sec = mts.tv_sec;
+       ts->tv_nsec = mts.tv_nsec;
+#elif defined(CLOCK_MONOTONIC_RAW)
+       clock_gettime(CLOCK_MONOTONIC_RAW, ts);
+#elif defined(_POSIX_MONOTONIC_CLOCK)
+       clock_gettime(CLOCK_MONOTONIC, ts);
+#else
+       struct timeval tv;
+       gettimeofday(&tv, NULL);
+       TIMEVAL_TO_TIMESPEC(&tv, ts);
+#endif
+}
+
+inline u64 getTimeS()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec;
+}
+
+inline u64 getTimeMs()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec * 1000 + ts.tv_nsec / 1000000;
+}
+
+inline u64 getTimeUs()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
+}
+
+inline u64 getTimeNs()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec * 1000000000 + ts.tv_nsec;
+}
+
+#endif
+
+inline u64 getTime(TimePrecision prec)
+{
+       switch (prec) {
+       case PRECISION_SECONDS: return getTimeS();
+       case PRECISION_MILLI:   return getTimeMs();
+       case PRECISION_MICRO:   return getTimeUs();
+       case PRECISION_NANO:    return getTimeNs();
+       }
+       FATAL_ERROR("Called getTime with invalid time precision");
+}
+
+/**
+ * Delta calculation function arguments.
+ * @param old_time_ms old time for delta calculation
+ * @param new_time_ms new time for delta calculation
+ * @return positive delta value
+ */
+inline u64 getDeltaMs(u64 old_time_ms, u64 new_time_ms)
+{
+       if (new_time_ms >= old_time_ms) {
+               return (new_time_ms - old_time_ms);
+       } else {
+               return (old_time_ms - new_time_ms);
        }
-       /*#include <sys/timeb.h>
-       inline u32 getTimeMs()
-       {
-               struct timeb tb;
-               ftime(&tb);
-               return tb.time * 1000 + tb.millitm;
-       }*/
+}
+
+
+#ifndef SERVER
+float getDisplayDensity();
+
+v2u32 getDisplaySize();
+v2u32 getWindowSize();
+
+std::vector<core::vector3d<u32> > getSupportedVideoModes();
+std::vector<irr::video::E_DRIVER_TYPE> getSupportedVideoDrivers();
+const char *getVideoDriverName(irr::video::E_DRIVER_TYPE type);
+const char *getVideoDriverFriendlyName(irr::video::E_DRIVER_TYPE type);
 #endif
 
+inline const char *getPlatformName()
+{
+       return
+#if defined(ANDROID)
+       "Android"
+#elif defined(__linux__)
+       "Linux"
+#elif defined(_WIN32) || defined(_WIN64)
+       "Windows"
+#elif defined(__DragonFly__) || defined(__FreeBSD__) || \
+               defined(__NetBSD__) || defined(__OpenBSD__)
+       "BSD"
+#elif defined(__APPLE__) && defined(__MACH__)
+       #if TARGET_OS_MAC
+               "OSX"
+       #elif TARGET_OS_IPHONE
+               "iOS"
+       #else
+               "Apple"
+       #endif
+#elif defined(_AIX)
+       "AIX"
+#elif defined(__hpux)
+       "HP-UX"
+#elif defined(__sun) || defined(sun)
+       #if defined(__SVR4)
+               "Solaris"
+       #else
+               "SunOS"
+       #endif
+#elif defined(__CYGWIN__)
+       "Cygwin"
+#elif defined(__unix__) || defined(__unix)
+       #if defined(_POSIX_VERSION)
+               "Posix"
+       #else
+               "Unix"
+       #endif
+#else
+       "?"
+#endif
+       ;
+}
+
+void setXorgClassHint(const video::SExposedVideoData &video_data,
+       const std::string &name);
+
+bool setWindowIcon(IrrlichtDevice *device);
+
+bool setXorgWindowIconFromPath(IrrlichtDevice *device,
+       const std::string &icon_file);
+
+// This only needs to be called at the start of execution, since all future
+// threads in the process inherit this exception handler
+void setWin32ExceptionHandler();
+
+bool secure_rand_fill_buf(void *buf, size_t len);
+
+// This attaches to the parents process console, or creates a new one if it doesnt exist.
+void attachOrCreateConsole(void);
 } // namespace porting
 
+#ifdef __ANDROID__
+#include "porting_android.h"
+#endif
+
 #endif // PORTING_HEADER