src/porting.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /*
  21         Random portability stuff
  22 */
  23
  24 #ifndef PORTING_HEADER
  25 #define PORTING_HEADER
  26
  27 #ifdef _WIN32
  28         #ifdef _WIN32_WINNT
  29                 #undef _WIN32_WINNT
  30         #endif
  31         #define _WIN32_WINNT 0x0501 // We need to do this before any other headers
  32                 // because those might include sdkddkver.h which defines _WIN32_WINNT if not already set
  33 #endif
  34
  35 #include <string>
  36 #include <vector>
  37 #include "irrlicht.h"
  38 #include "irrlichttypes.h" // u32
  39 #include "irrlichttypes_extrabloated.h"
  40 #include "debug.h"
  41 #include "constants.h"
  42 #include "gettime.h"
  43 #include "threads.h"
  44
  45 #ifdef _MSC_VER
  46         #define SWPRINTF_CHARSTRING L"%S"
  47 #else
  48         #define SWPRINTF_CHARSTRING L"%s"
  49 #endif
  50
  51 //currently not needed
  52 //template<typename T> struct alignment_trick { char c; T member; };
  53 //#define ALIGNOF(type) offsetof (alignment_trick<type>, member)
  54
  55 #ifdef _WIN32
  56         #include <windows.h>
  57
  58         #define sleep_ms(x) Sleep(x)
  59 #else
  60         #include <unistd.h>
  61         #include <stdint.h> //for uintptr_t
  62
  63         // Use standard Posix macro for Linux
  64         #if (defined(linux) || defined(__linux)) && !defined(__linux__)
  65                 #define __linux__
  66         #endif
  67         #if (defined(__linux__) || defined(__GNU__)) && !defined(_GNU_SOURCE)
  68                 #define _GNU_SOURCE
  69         #endif
  70
  71         #define sleep_ms(x) usleep(x*1000)
  72 #endif
  73
  74 #ifdef _MSC_VER
  75         #define ALIGNOF(x) __alignof(x)
  76         #define strtok_r(x, y, z) strtok_s(x, y, z)
  77         #define strtof(x, y) (float)strtod(x, y)
  78         #define strtoll(x, y, z) _strtoi64(x, y, z)
  79         #define strtoull(x, y, z) _strtoui64(x, y, z)
  80         #define strcasecmp(x, y) stricmp(x, y)
  81         #define strncasecmp(x, y, n) strnicmp(x, y, n)
  82 #else
  83         #define ALIGNOF(x) __alignof__(x)
  84 #endif
  85
  86 #ifdef __MINGW32__
  87         #define strtok_r(x, y, z) mystrtok_r(x, y, z)
  88 #endif
  89
  90 // strlcpy is missing from glibc.  thanks a lot, drepper.
  91 // strlcpy is also missing from AIX and HP-UX because they aim to be weird.
  92 // We can't simply alias strlcpy to MSVC's strcpy_s, since strcpy_s by
  93 // default raises an assertion error and aborts the program if the buffer is
  94 // too small.
  95 #if defined(__FreeBSD__) || defined(__NetBSD__)    || \
  96         defined(__OpenBSD__) || defined(__DragonFly__) || \
  97         defined(__APPLE__)   ||                           \
  98         defined(__sun)       || defined(sun)           || \
  99         defined(__QNX__)     || defined(__QNXNTO__)
 100         #define HAVE_STRLCPY
 101 #endif
 102
 103 // So we need to define our own.
 104 #ifndef HAVE_STRLCPY
 105         #define strlcpy(d, s, n) mystrlcpy(d, s, n)
 106 #endif
 107
 108 #define PADDING(x, y) ((ALIGNOF(y) - ((uintptr_t)(x) & (ALIGNOF(y) - 1))) & (ALIGNOF(y) - 1))
 109
 110 #if defined(__APPLE__)
 111         #include <mach-o/dyld.h>
 112         #include <CoreFoundation/CoreFoundation.h>
 113 #endif
 114
 115 #ifndef _WIN32 // Posix
 116         #include <sys/time.h>
 117         #include <time.h>
 118         #if defined(__MACH__) && defined(__APPLE__)
 119                 #include <mach/clock.h>
 120                 #include <mach/mach.h>
 121         #endif
 122 #endif
 123
 124 namespace porting
 125 {
 126
 127 /*
 128         Signal handler (grabs Ctrl-C on POSIX systems)
 129 */
 130
 131 void signal_handler_init(void);
 132 // Returns a pointer to a bool.
 133 // When the bool is true, program should quit.
 134 bool * signal_handler_killstatus(void);
 135
 136 /*
 137         Path of static data directory.
 138 */
 139 extern std::string path_share;
 140
 141 /*
 142         Directory for storing user data. Examples:
 143         Windows: "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
 144         Linux: "~/.<PROJECT_NAME>"
 145         Mac: "~/Library/Application Support/<PROJECT_NAME>"
 146 */
 147 extern std::string path_user;
 148
 149 /*
 150         Path to gettext locale files
 151 */
 152 extern std::string path_locale;
 153
 154 /*
 155         Path to directory for storing caches.
 156 */
 157 extern std::string path_cache;
 158
 159 /*
 160         Get full path of stuff in data directory.
 161         Example: "stone.png" -> "../data/stone.png"
 162 */
 163 std::string getDataPath(const char *subpath);
 164
 165 /*
 166         Move cache folder from path_user to the
 167         system cache location if possible.
 168 */
 169 void migrateCachePath();
 170
 171 /*
 172         Initialize path_*.
 173 */
 174 void initializePaths();
 175
 176 /*
 177         Return system information
 178         e.g. "Linux/3.12.7 x86_64"
 179 */
 180 std::string get_sysinfo();
 181
 182 void initIrrlicht(irr::IrrlichtDevice * );
 183
 184
 185 // Monotonic counter getters.
 186
 187 #ifdef _WIN32 // Windows
 188
 189 extern double perf_freq;
 190
 191 inline u64 os_get_time(double mult)
 192 {
 193         LARGE_INTEGER t;
 194         QueryPerformanceCounter(&t);
 195         return static_cast<double>(t.QuadPart) / (perf_freq / mult);
 196 }
 197
 198 // Resolution is <1us.
 199 inline u64 getTimeS() { return os_get_time(1); }
 200 inline u64 getTimeMs() { return os_get_time(1000); }
 201 inline u64 getTimeUs() { return os_get_time(1000*1000); }
 202 inline u64 getTimeNs() { return os_get_time(1000*1000*1000); }
 203
 204 #else // Posix
 205
 206 inline void os_get_clock(struct timespec *ts)
 207 {
 208 #if defined(__MACH__) && defined(__APPLE__)
 209 // From http://stackoverflow.com/questions/5167269/clock-gettime-alternative-in-mac-os-x
 210 // OS X does not have clock_gettime, use clock_get_time
 211         clock_serv_t cclock;
 212         mach_timespec_t mts;
 213         host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &cclock);
 214         clock_get_time(cclock, &mts);
 215         mach_port_deallocate(mach_task_self(), cclock);
 216         ts->tv_sec = mts.tv_sec;
 217         ts->tv_nsec = mts.tv_nsec;
 218 #elif defined(CLOCK_MONOTONIC_RAW)
 219         clock_gettime(CLOCK_MONOTONIC_RAW, ts);
 220 #elif defined(_POSIX_MONOTONIC_CLOCK)
 221         clock_gettime(CLOCK_MONOTONIC, ts);
 222 #else
 223         struct timeval tv;
 224         gettimeofday(&tv, NULL);
 225         TIMEVAL_TO_TIMESPEC(&tv, ts);
 226 #endif
 227 }
 228
 229 inline u64 getTimeS()
 230 {
 231         struct timespec ts;
 232         os_get_clock(&ts);
 233         return ts.tv_sec;
 234 }
 235
 236 inline u64 getTimeMs()
 237 {
 238         struct timespec ts;
 239         os_get_clock(&ts);
 240         return ts.tv_sec * 1000 + ts.tv_nsec / 1000000;
 241 }
 242
 243 inline u64 getTimeUs()
 244 {
 245         struct timespec ts;
 246         os_get_clock(&ts);
 247         return ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
 248 }
 249
 250 inline u64 getTimeNs()
 251 {
 252         struct timespec ts;
 253         os_get_clock(&ts);
 254         return ts.tv_sec * 1000000000 + ts.tv_nsec;
 255 }
 256
 257 #endif
 258
 259 inline u64 getTime(TimePrecision prec)
 260 {
 261         switch (prec) {
 262         case PRECISION_SECONDS: return getTimeS();
 263         case PRECISION_MILLI:   return getTimeMs();
 264         case PRECISION_MICRO:   return getTimeUs();
 265         case PRECISION_NANO:    return getTimeNs();
 266         }
 267         FATAL_ERROR("Called getTime with invalid time precision");
 268 }
 269
 270 /**
 271  * Delta calculation function arguments.
 272  * @param old_time_ms old time for delta calculation
 273  * @param new_time_ms new time for delta calculation
 274  * @return positive delta value
 275  */
 276 inline u64 getDeltaMs(u64 old_time_ms, u64 new_time_ms)
 277 {
 278         if (new_time_ms >= old_time_ms) {
 279                 return (new_time_ms - old_time_ms);
 280         } else {
 281                 return (old_time_ms - new_time_ms);
 282         }
 283 }
 284
 285
 286 #ifndef SERVER
 287 float getDisplayDensity();
 288
 289 v2u32 getDisplaySize();
 290 v2u32 getWindowSize();
 291
 292 std::vector<core::vector3d<u32> > getSupportedVideoModes();
 293 std::vector<irr::video::E_DRIVER_TYPE> getSupportedVideoDrivers();
 294 const char *getVideoDriverName(irr::video::E_DRIVER_TYPE type);
 295 const char *getVideoDriverFriendlyName(irr::video::E_DRIVER_TYPE type);
 296 #endif
 297
 298 inline const char *getPlatformName()
 299 {
 300         return
 301 #if defined(ANDROID)
 302         "Android"
 303 #elif defined(__linux__)
 304         "Linux"
 305 #elif defined(_WIN32) || defined(_WIN64)
 306         "Windows"
 307 #elif defined(__DragonFly__) || defined(__FreeBSD__) || \
 308                 defined(__NetBSD__) || defined(__OpenBSD__)
 309         "BSD"
 310 #elif defined(__APPLE__) && defined(__MACH__)
 311         #if TARGET_OS_MAC
 312                 "OSX"
 313         #elif TARGET_OS_IPHONE
 314                 "iOS"
 315         #else
 316                 "Apple"
 317         #endif
 318 #elif defined(_AIX)
 319         "AIX"
 320 #elif defined(__hpux)
 321         "HP-UX"
 322 #elif defined(__sun) || defined(sun)
 323         #if defined(__SVR4)
 324                 "Solaris"
 325         #else
 326                 "SunOS"
 327         #endif
 328 #elif defined(__CYGWIN__)
 329         "Cygwin"
 330 #elif defined(__unix__) || defined(__unix)
 331         #if defined(_POSIX_VERSION)
 332                 "Posix"
 333         #else
 334                 "Unix"
 335         #endif
 336 #else
 337         "?"
 338 #endif
 339         ;
 340 }
 341
 342 void setXorgClassHint(const video::SExposedVideoData &video_data,
 343         const std::string &name);
 344
 345 bool setWindowIcon(IrrlichtDevice *device);
 346
 347 bool setXorgWindowIconFromPath(IrrlichtDevice *device,
 348         const std::string &icon_file);
 349
 350 // This only needs to be called at the start of execution, since all future
 351 // threads in the process inherit this exception handler
 352 void setWin32ExceptionHandler();
 353
 354 bool secure_rand_fill_buf(void *buf, size_t len);
 355
 356 // This attaches to the parents process console, or creates a new one if it doesnt exist.
 357 void attachOrCreateConsole(void);
 358 } // namespace porting
 359
 360 #ifdef __ANDROID__
 361 #include "porting_android.h"
 362 #endif
 363
 364 #endif // PORTING_HEADER
 365