minetest/src/porting.h

347 lines
7.6 KiB
C
Raw Normal View History

/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
2010-11-27 00:02:21 +01:00
/*
2010-12-20 21:03:49 +01:00
Random portability stuff
2010-11-27 00:02:21 +01:00
*/
#pragma once
2010-11-27 00:02:21 +01:00
2024-01-10 19:21:16 +01:00
#if (defined(__linux__) || defined(__GNU__)) && !defined(_GNU_SOURCE)
#define _GNU_SOURCE
#endif
// Be mindful of what you include here!
#include <string>
#include "config.h"
#include "irrlichttypes.h" // u64
#include "debug.h"
#include "constants.h"
2024-04-10 23:56:34 +02:00
#include "util/timetaker.h" // TimePrecision
2010-12-21 17:08:24 +01:00
2011-02-11 15:43:26 +01:00
#ifdef _MSC_VER
2010-11-27 00:02:21 +01:00
#define SWPRINTF_CHARSTRING L"%S"
#else
#define SWPRINTF_CHARSTRING L"%s"
#endif
2010-12-21 17:08:24 +01:00
#ifdef _WIN32
#include <windows.h>
2010-12-21 17:08:24 +01:00
#define sleep_ms(x) Sleep(x)
#define sleep_us(x) Sleep((x)/1000)
2024-01-10 19:21:16 +01:00
#define setenv(n,v,o) _putenv_s(n,v)
#define unsetenv(n) _putenv_s(n,"")
2013-01-23 08:21:26 +01:00
#else
#include <unistd.h>
2024-01-10 19:21:16 +01:00
#include <cstdlib> // setenv
#define sleep_ms(x) usleep((x)*1000)
#define sleep_us(x) usleep(x)
2013-01-23 08:21:26 +01:00
#endif
#ifdef _MSC_VER
2013-01-18 20:12:19 +01:00
#define strtok_r(x, y, z) strtok_s(x, y, z)
#define strtof(x, y) (float)strtod(x, y)
#define strtoll(x, y, z) _strtoi64(x, y, z)
#define strtoull(x, y, z) _strtoui64(x, y, z)
#define strcasecmp(x, y) stricmp(x, y)
#define strncasecmp(x, y, n) strnicmp(x, y, n)
2013-01-23 08:21:26 +01:00
#endif
#ifdef __MINGW32__
2023-12-12 13:20:59 +01:00
// was broken in 2013, unclear if still needed
2013-01-23 08:21:26 +01:00
#define strtok_r(x, y, z) mystrtok_r(x, y, z)
2010-12-21 17:08:24 +01:00
#endif
#if !HAVE_STRLCPY
#define strlcpy(d, s, n) mystrlcpy(d, s, n)
#endif
2023-12-12 13:20:59 +01:00
#ifndef _WIN32 // POSIX
#include <sys/time.h>
#include <ctime>
#if defined(__MACH__) && defined(__APPLE__)
#include <TargetConditionals.h>
#endif
#endif
2010-12-21 17:08:24 +01:00
namespace porting
{
/*
Signal handler (grabs Ctrl-C on POSIX systems)
*/
void signal_handler_init();
// Returns a pointer to a bool.
// When the bool is true, program should quit.
bool * signal_handler_killstatus();
/*
Path of static data directory.
*/
2012-03-10 14:56:24 +01:00
extern std::string path_share;
/*
Directory for storing user data. Examples:
Windows: "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
Linux: "~/.<PROJECT_NAME>"
Mac: "~/Library/Application Support/<PROJECT_NAME>"
*/
2012-03-10 14:56:24 +01:00
extern std::string path_user;
2015-08-24 20:32:15 +02:00
/*
Path to gettext locale files
*/
extern std::string path_locale;
/*
Path to directory for storing caches.
*/
extern std::string path_cache;
/*
Gets the path of our executable.
*/
bool getCurrentExecPath(char *buf, size_t len);
/*
Get full path of stuff in data directory.
Example: "stone.png" -> "../data/stone.png"
*/
std::string getDataPath(const char *subpath);
/*
2015-08-24 20:32:15 +02:00
Initialize path_*.
*/
void initializePaths();
/*
Return system information
e.g. "Linux/3.12.7 x86_64"
*/
std::string get_sysinfo();
2023-12-12 13:20:59 +01:00
// Monotonic timer
#ifdef _WIN32 // Windows
extern double perf_freq;
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); }
2023-12-12 13:20:59 +01:00
#else // POSIX
inline void os_get_clock(struct timespec *ts)
{
#if defined(CLOCK_MONOTONIC_RAW)
clock_gettime(CLOCK_MONOTONIC_RAW, ts);
#elif defined(_POSIX_MONOTONIC_CLOCK) && _POSIX_MONOTONIC_CLOCK > 0
clock_gettime(CLOCK_MONOTONIC, ts);
#else
# if defined(_POSIX_MONOTONIC_CLOCK) && _POSIX_MONOTONIC_CLOCK == 0
// zero means it might be supported at runtime
if (clock_gettime(CLOCK_MONOTONIC, ts) == 0)
return;
# endif
struct timeval tv;
gettimeofday(&tv, NULL);
TIMEVAL_TO_TIMESPEC(&tv, ts);
#endif
}
inline u64 getTimeS()
{
struct timespec ts;
os_get_clock(&ts);
return ts.tv_sec;
}
inline u64 getTimeMs()
{
struct timespec ts;
os_get_clock(&ts);
2021-02-24 12:05:17 +01:00
return ((u64) ts.tv_sec) * 1000LL + ((u64) ts.tv_nsec) / 1000000LL;
}
inline u64 getTimeUs()
{
struct timespec ts;
os_get_clock(&ts);
2021-02-24 12:05:17 +01:00
return ((u64) ts.tv_sec) * 1000000LL + ((u64) ts.tv_nsec) / 1000LL;
}
inline u64 getTimeNs()
{
struct timespec ts;
os_get_clock(&ts);
2021-02-24 12:05:17 +01:00
return ((u64) ts.tv_sec) * 1000000000LL + ((u64) ts.tv_nsec);
}
2010-12-21 17:08:24 +01:00
#endif
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();
}
FATAL_ERROR("Called getTime with invalid time precision");
}
/**
* 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 u64 getDeltaMs(u64 old_time_ms, u64 new_time_ms)
{
if (new_time_ms >= old_time_ms) {
return (new_time_ms - old_time_ms);
}
return (old_time_ms - new_time_ms);
}
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(__HAIKU__)
"Haiku"
#elif defined(__CYGWIN__)
"Cygwin"
#elif defined(__unix__) || defined(__unix)
#if defined(_POSIX_VERSION)
2023-12-12 13:20:59 +01:00
"POSIX"
#else
"Unix"
#endif
#else
"?"
#endif
;
}
2015-08-06 08:57:13 +02:00
bool secure_rand_fill_buf(void *buf, size_t len);
2023-12-19 21:41:48 +01:00
// Call once near beginning of main function.
void osSpecificInit();
// This attaches to the parents process console, or creates a new one if it doesnt exist.
void attachOrCreateConsole();
#if HAVE_MALLOC_TRIM
/**
* Call this after freeing bigger blocks of memory. Used on some platforms to
* properly give memory back to the OS.
* @param amount Number of bytes freed
*/
void TrackFreedMemory(size_t amount);
/**
* Call this regularly from background threads. This performs the actual trimming
* and is potentially slow.
*/
void TriggerMemoryTrim();
#else
static inline void TrackFreedMemory(size_t amount) { (void)amount; }
static inline void TriggerMemoryTrim() { (void)0; }
#endif
#ifdef _WIN32
// Quotes an argument for use in a CreateProcess() commandline (not cmd.exe!!)
std::string QuoteArgv(const std::string &arg);
// Convert an error code (e.g. from GetLastError()) into a string.
std::string ConvertError(DWORD error_code);
#endif
// snprintf wrapper
int mt_snprintf(char *buf, const size_t buf_size, const char *fmt, ...);
/**
* Opens URL in default web browser
*
* Must begin with http:// or https://, and not contain any new lines
*
* @param url The URL
* @return true on success, false on failure
*/
bool open_url(const std::string &url);
/**
* Opens a directory in the default file manager
*
* The directory must exist.
*
* @param path Path to directory
* @return true on success, false on failure
*/
bool open_directory(const std::string &path);
2010-12-21 17:08:24 +01:00
} // namespace porting
#ifdef __ANDROID__
#include "porting_android.h"
#endif