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