]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/porting.h
Document zoom_fov in settingtypes.txt and minetest.conf.example
[dragonfireclient.git] / src / porting.h
index 383d4377ac1a7af96d402aa868bf04f789efe64b..40f6b4dc3c39163673746963cc3f0cfb34eaf13b 100644 (file)
@@ -33,6 +33,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #endif
 
 #include <string>
+#include <vector>
 #include "irrlicht.h"
 #include "irrlichttypes.h" // u32
 #include "irrlichttypes_extrabloated.h"
@@ -53,38 +54,21 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #ifdef _WIN32
        #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
@@ -123,6 +107,20 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #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
 {
 
@@ -149,30 +147,31 @@ 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();
 
 /*
        Return system information
@@ -188,21 +187,17 @@ void initIrrlicht(irr::IrrlichtDevice * );
        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;
        }
-       
+
        inline u32 getTimeMs()
        {
                return GetTickCount();
        }
-       
+
        inline u32 getTimeUs()
        {
                LARGE_INTEGER freq, t;
@@ -210,7 +205,7 @@ void initIrrlicht(irr::IrrlichtDevice * );
                QueryPerformanceCounter(&t);
                return (double)(t.QuadPart) / ((double)(freq.QuadPart) / 1000000.0);
        }
-       
+
        inline u32 getTimeNs()
        {
                LARGE_INTEGER freq, t;
@@ -218,39 +213,61 @@ void initIrrlicht(irr::IrrlichtDevice * );
                QueryPerformanceCounter(&t);
                return (double)(t.QuadPart) / ((double)(freq.QuadPart) / 1000000000.0);
        }
-       
+
 #else // Posix
-       #include <sys/time.h>
-       #include <time.h>
-       
-       inline u32 getTimeS()
+       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);
-               return tv.tv_sec;
+               TIMEVAL_TO_TIMESPEC(&tv, ts);
+#endif // defined(__MACH__) && defined(__APPLE__)
        }
-       
+
+       // Note: these clock functions do not return wall time, but
+       // generally a clock that starts at 0 when the process starts.
+       inline u32 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;
+               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;
+               struct timespec ts;
+               _os_get_clock(&ts);
+               return ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
        }
-       
+
        inline u32 getTimeNs()
        {
                struct timespec ts;
-               clock_gettime(CLOCK_REALTIME, &ts);
+               _os_get_clock(&ts);
                return ts.tv_sec * 1000000000 + ts.tv_nsec;
        }
-       
+
        /*#include <sys/timeb.h>
        inline u32 getTimeMs()
        {
@@ -290,68 +307,79 @@ inline u32 getDeltaMs(u32 old_time_ms, u32 new_time_ms)
        }
 }
 
-#if defined(linux) || defined(__linux)
-       #include <sys/prctl.h>
 
-       inline void setThreadName(const char *name) {
-               /* It would be cleaner to do this with pthread_setname_np,
-                * which was added to glibc in version 2.12, but some major
-                * distributions are still runing 2.11 and previous versions.
-                */
-               prctl(PR_SET_NAME, name);
-       }
-#elif defined(__FreeBSD__) || defined(__OpenBSD__)
-       #include <pthread.h>
-       #include <pthread_np.h>
+#ifndef SERVER
+float getDisplayDensity();
 
-       inline void setThreadName(const char *name) {
-               pthread_set_name_np(pthread_self(), name);
-       }
-#elif defined(__NetBSD__)
-       #include <pthread.h>
+v2u32 getDisplaySize();
+v2u32 getWindowSize();
 
-       inline void setThreadName(const char *name) {
-               pthread_setname_np(pthread_self(), name);
-       }
-#elif defined(_MSC_VER)
-       typedef struct tagTHREADNAME_INFO {
-               DWORD dwType; // must be 0x1000
-               LPCSTR szName; // pointer to name (in user addr space)
-               DWORD dwThreadID; // thread ID (-1=caller thread)
-               DWORD dwFlags; // reserved for future use, must be zero
-       } THREADNAME_INFO;
-
-       inline void setThreadName(const char *name) {
-               THREADNAME_INFO info;
-               info.dwType = 0x1000;
-               info.szName = name;
-               info.dwThreadID = -1;
-               info.dwFlags = 0;
-               __try {
-                       RaiseException(0x406D1388, 0, sizeof(info) / sizeof(DWORD), (ULONG_PTR *) &info);
-               } __except (EXCEPTION_CONTINUE_EXECUTION) {}
-       }
-#elif defined(__APPLE__)
-       #include <pthread.h>
+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 void setThreadName(const char *name) {
-               pthread_setname_np(name);
-       }
-#elif defined(_WIN32)
-       inline void setThreadName(const char* name) {}
+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
-       #warning "Unrecognized platform, thread names will not be available."
-       inline void setThreadName(const char* name) {}
+       "?"
 #endif
+       ;
+}
 
-#ifndef SERVER
-float getDisplayDensity();
+void setXorgClassHint(const video::SExposedVideoData &video_data,
+       const std::string &name);
 
-v2u32 getDisplaySize();
-v2u32 getWindowSize();
-#endif
+bool setXorgWindowIcon(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);
 } // namespace porting
 
+#ifdef __ANDROID__
+#include "porting_android.h"
+#endif
+
 #endif // PORTING_HEADER