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         Gets the path of our executable.
 160 */
 161 bool getCurrentExecPath(char *buf, size_t len);
 162
 163 /*
 164         Get full path of stuff in data directory.
 165         Example: "stone.png" -> "../data/stone.png"
 166 */
 167 std::string getDataPath(const char *subpath);
 168
 169 /*
 170         Move cache folder from path_user to the
 171         system cache location if possible.
 172 */
 173 void migrateCachePath();
 174
 175 /*
 176         Initialize path_*.
 177 */
 178 void initializePaths();
 179
 180 /*
 181         Return system information
 182         e.g. "Linux/3.12.7 x86_64"
 183 */
 184 std::string get_sysinfo();
 185
 186
 187 // Monotonic counter getters.
 188
 189 #ifdef _WIN32 // Windows
 190
 191 extern double perf_freq;
 192
 193 inline u64 os_get_time(double mult)
 194 {
 195         LARGE_INTEGER t;
 196         QueryPerformanceCounter(&t);
 197         return static_cast<double>(t.QuadPart) / (perf_freq / mult);
 198 }
 199
 200 // Resolution is <1us.
 201 inline u64 getTimeS() { return os_get_time(1); }
 202 inline u64 getTimeMs() { return os_get_time(1000); }
 203 inline u64 getTimeUs() { return os_get_time(1000*1000); }
 204 inline u64 getTimeNs() { return os_get_time(1000*1000*1000); }
 205
 206 #else // Posix
 207
 208 inline void os_get_clock(struct timespec *ts)
 209 {
 210 #if defined(__MACH__) && defined(__APPLE__)
 211 // From http://stackoverflow.com/questions/5167269/clock-gettime-alternative-in-mac-os-x
 212 // OS X does not have clock_gettime, use clock_get_time
 213         clock_serv_t cclock;
 214         mach_timespec_t mts;
 215         host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &cclock);
 216         clock_get_time(cclock, &mts);
 217         mach_port_deallocate(mach_task_self(), cclock);
 218         ts->tv_sec = mts.tv_sec;
 219         ts->tv_nsec = mts.tv_nsec;
 220 #elif defined(CLOCK_MONOTONIC_RAW)
 221         clock_gettime(CLOCK_MONOTONIC_RAW, ts);
 222 #elif defined(_POSIX_MONOTONIC_CLOCK)
 223         clock_gettime(CLOCK_MONOTONIC, ts);
 224 #else
 225         struct timeval tv;
 226         gettimeofday(&tv, NULL);
 227         TIMEVAL_TO_TIMESPEC(&tv, ts);
 228 #endif
 229 }
 230
 231 inline u64 getTimeS()
 232 {
 233         struct timespec ts;
 234         os_get_clock(&ts);
 235         return ts.tv_sec;
 236 }
 237
 238 inline u64 getTimeMs()
 239 {
 240         struct timespec ts;
 241         os_get_clock(&ts);
 242         return ((u64) ts.tv_sec) * 1000LL + ((u64) ts.tv_nsec) / 1000000LL;
 243 }
 244
 245 inline u64 getTimeUs()
 246 {
 247         struct timespec ts;
 248         os_get_clock(&ts);
 249         return ((u64) ts.tv_sec) * 1000000LL + ((u64) ts.tv_nsec) / 1000LL;
 250 }
 251
 252 inline u64 getTimeNs()
 253 {
 254         struct timespec ts;
 255         os_get_clock(&ts);
 256         return ((u64) ts.tv_sec) * 1000000000LL + ((u64) ts.tv_nsec);
 257 }
 258
 259 #endif
 260
 261 inline u64 getTime(TimePrecision prec)
 262 {
 263         switch (prec) {
 264         case PRECISION_SECONDS: return getTimeS();
 265         case PRECISION_MILLI:   return getTimeMs();
 266         case PRECISION_MICRO:   return getTimeUs();
 267         case PRECISION_NANO:    return getTimeNs();
 268         }
 269         FATAL_ERROR("Called getTime with invalid time precision");
 270 }
 271
 272 /**
 273  * Delta calculation function arguments.
 274  * @param old_time_ms old time for delta calculation
 275  * @param new_time_ms new time for delta calculation
 276  * @return positive delta value
 277  */
 278 inline u64 getDeltaMs(u64 old_time_ms, u64 new_time_ms)
 279 {
 280         if (new_time_ms >= old_time_ms) {
 281                 return (new_time_ms - old_time_ms);
 282         }
 283
 284         return (old_time_ms - new_time_ms);
 285 }
 286
 287 inline const char *getPlatformName()
 288 {
 289         return
 290 #if defined(ANDROID)
 291         "Android"
 292 #elif defined(__linux__)
 293         "Linux"
 294 #elif defined(_WIN32) || defined(_WIN64)
 295         "Windows"
 296 #elif defined(__DragonFly__) || defined(__FreeBSD__) || \
 297                 defined(__NetBSD__) || defined(__OpenBSD__)
 298         "BSD"
 299 #elif defined(__APPLE__) && defined(__MACH__)
 300         #if TARGET_OS_MAC
 301                 "OSX"
 302         #elif TARGET_OS_IPHONE
 303                 "iOS"
 304         #else
 305                 "Apple"
 306         #endif
 307 #elif defined(_AIX)
 308         "AIX"
 309 #elif defined(__hpux)
 310         "HP-UX"
 311 #elif defined(__sun) || defined(sun)
 312         #if defined(__SVR4)
 313                 "Solaris"
 314         #else
 315                 "SunOS"
 316         #endif
 317 #elif defined(__HAIKU__)
 318         "Haiku"
 319 #elif defined(__CYGWIN__)
 320         "Cygwin"
 321 #elif defined(__unix__) || defined(__unix)
 322         #if defined(_POSIX_VERSION)
 323                 "Posix"
 324         #else
 325                 "Unix"
 326         #endif
 327 #else
 328         "?"
 329 #endif
 330         ;
 331 }
 332
 333 bool secure_rand_fill_buf(void *buf, size_t len);
 334
 335 // This attaches to the parents process console, or creates a new one if it doesnt exist.
 336 void attachOrCreateConsole();
 337
 338 #ifdef _WIN32
 339 // Quotes an argument for use in a CreateProcess() commandline (not cmd.exe!!)
 340 std::string QuoteArgv(const std::string &arg);
 341 #endif
 342
 343 int mt_snprintf(char *buf, const size_t buf_size, const char *fmt, ...);
 344
 345 /**
 346  * Opens URL in default web browser
 347  *
 348  * Must begin with http:// or https://, and not contain any new lines
 349  *
 350  * @param url The URL
 351  * @return true on success, false on failure
 352  */
 353 bool open_url(const std::string &url);
 354
 355 /**
 356  * Opens a directory in the default file manager
 357  *
 358  * The directory must exist.
 359  *
 360  * @param path Path to directory
 361  * @return true on success, false on failure
 362  */
 363 bool open_directory(const std::string &path);
 364
 365 } // namespace porting
 366
 367 #ifdef __ANDROID__
 368 #include "porting_android.h"
 369 #endif