Move KeyList & InputHandler from game.h to client/inputhandler.h (#5752)
[oweals/minetest.git] / src / porting.h
index 492c9d3a8d5e6326a6173e203a7835f4600da972..7034d956bdec2abed7a5b136847dd9e7e909335c 100644 (file)
@@ -60,7 +60,11 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #include <unistd.h>
        #include <stdint.h> //for uintptr_t
 
-       #if (defined(linux) || defined(__linux) || defined(__GNU__)) && !defined(_GNU_SOURCE)
+       // 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
 
@@ -108,6 +112,15 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #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
 {
 
@@ -133,6 +146,16 @@ extern std::string path_share;
 */
 extern std::string path_user;
 
+/*
+       Path to gettext locale files
+*/
+extern std::string path_locale;
+
+/*
+       Path to directory for storing caches.
+*/
+extern std::string path_cache;
+
 /*
        Get full path of stuff in data directory.
        Example: "stone.png" -> "../data/stone.png"
@@ -140,7 +163,13 @@ extern std::string path_user;
 std::string getDataPath(const char *subpath);
 
 /*
-       Initialize path_share and path_user.
+       Move cache folder from path_user to the
+       system cache location if possible.
+*/
+void migrateCachePath();
+
+/*
+       Initialize path_*.
 */
 void initializePaths();
 
@@ -152,121 +181,99 @@ std::string get_sysinfo();
 
 void initIrrlicht(irr::IrrlichtDevice * );
 
-/*
-       Resolution is 10-20ms.
-       Remember to check for overflows.
-       Overflow can occur at any value higher than 10000000.
-*/
-#ifdef _WIN32 // Windows
-#ifndef _WIN32_WINNT
-       #define _WIN32_WINNT 0x0501
-#endif
-       #include <windows.h>
 
-       inline u32 getTimeS()
-       {
-               return GetTickCount() / 1000;
-       }
+// Monotonic counter getters.
 
-       inline u32 getTimeMs()
-       {
-               return GetTickCount();
-       }
+#ifdef _WIN32 // Windows
 
-       inline u32 getTimeUs()
-       {
-               LARGE_INTEGER freq, t;
-               QueryPerformanceFrequency(&freq);
-               QueryPerformanceCounter(&t);
-               return (double)(t.QuadPart) / ((double)(freq.QuadPart) / 1000000.0);
-       }
+extern double perf_freq;
 
-       inline u32 getTimeNs()
-       {
-               LARGE_INTEGER freq, t;
-               QueryPerformanceFrequency(&freq);
-               QueryPerformanceCounter(&t);
-               return (double)(t.QuadPart) / ((double)(freq.QuadPart) / 1000000000.0);
-       }
+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>
-#include <time.h>
+
+inline void os_get_clock(struct timespec *ts)
+{
 #if defined(__MACH__) && defined(__APPLE__)
-#include <mach/clock.h>
-#include <mach/mach.h>
+// 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 u32 getTimeS()
-       {
-               struct timeval tv;
-               gettimeofday(&tv, NULL);
-               return tv.tv_sec;
-       }
+inline u64 getTimeS()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec;
+}
 
-       inline u32 getTimeMs()
-       {
-               struct timeval tv;
-               gettimeofday(&tv, NULL);
-               return tv.tv_sec * 1000 + tv.tv_usec / 1000;
-       }
+inline u64 getTimeMs()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec * 1000 + ts.tv_nsec / 1000000;
+}
 
-       inline u32 getTimeUs()
-       {
-               struct timeval tv;
-               gettimeofday(&tv, NULL);
-               return tv.tv_sec * 1000000 + tv.tv_usec;
-       }
+inline u64 getTimeUs()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
+}
 
-       inline u32 getTimeNs()
-       {
-               struct timespec ts;
-               // from http://stackoverflow.com/questions/5167269/clock-gettime-alternative-in-mac-os-x
-#if defined(__MACH__) && defined(__APPLE__) // 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;
-#else
-               clock_gettime(CLOCK_REALTIME, &ts);
-#endif
-               return ts.tv_sec * 1000000000 + ts.tv_nsec;
-       }
+inline u64 getTimeNs()
+{
+       struct timespec ts;
+       os_get_clock(&ts);
+       return ts.tv_sec * 1000000000 + ts.tv_nsec;
+}
 
-       /*#include <sys/timeb.h>
-       inline u32 getTimeMs()
-       {
-               struct timeb tb;
-               ftime(&tb);
-               return tb.time * 1000 + tb.millitm;
-       }*/
 #endif
 
-inline u32 getTime(TimePrecision prec)
+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();
+       case PRECISION_SECONDS: return getTimeS();
+       case PRECISION_MILLI:   return getTimeMs();
+       case PRECISION_MICRO:   return getTimeUs();
+       case PRECISION_NANO:    return getTimeNs();
        }
-       return 0;
+       FATAL_ERROR("Called getTime with invalid time precision");
 }
 
 /**
- * Delta calculation function taking two 32bit arguments.
- * @param old_time_ms old time for delta calculation (order is relevant!)
- * @param new_time_ms new time for delta calculation (order is relevant!)
- * @return positive 32bit delta value
+ * 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 u32 getDeltaMs(u32 old_time_ms, u32 new_time_ms)
+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);
@@ -293,7 +300,7 @@ inline const char *getPlatformName()
        return
 #if defined(ANDROID)
        "Android"
-#elif defined(linux) || defined(__linux) || defined(__linux__)
+#elif defined(__linux__)
        "Linux"
 #elif defined(_WIN32) || defined(_WIN64)
        "Windows"
@@ -335,10 +342,19 @@ inline const char *getPlatformName()
 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__