StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
platform.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This is the base for StormByte Suite libraries.
5 *
6 * StormByte original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte source in this repository.
20 * They do not cover other StormByte modules or any third-party material
21 * shipped with this repository (including everything under thirdparty/),
22 * which remains under its own license.
23 *
24 * Neither license grants any patent rights. Any patent licenses required
25 * to use this software or third-party components must be obtained separately
26 * from the patent holders.
27 *
28 * StormByte is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU Lesser General Public License for more details.
32 *
33 * You should have received a copy of the GNU Lesser General Public License
34 * version 3 along with StormByte. If not, see
35 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
36 *
37 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
38 */
39
40#pragma once
41
42// ---------------------------------------------------------------------------
43// Operating system
44// ---------------------------------------------------------------------------
45#if defined(_WIN32) || defined(__CYGWIN__)
46 #define WINDOWS
47#elif defined(__APPLE__) && defined(__MACH__)
48 #define MACOS
49 #define UNIX
50#elif defined(__linux__)
51 #define LINUX
52 #define UNIX
53#elif defined(__unix__) || defined(__unix)
54 #define UNIX
55#else
56 #error "Unsupported operating system"
57#endif
58
59// ---------------------------------------------------------------------------
60// Architecture (pointer / ILP model)
61// ---------------------------------------------------------------------------
62#if defined(_WIN64) || defined(__x86_64__) || defined(__amd64__) \
63 || defined(__aarch64__) || defined(_M_X64) || defined(_M_ARM64) \
64 || (defined(__SIZEOF_POINTER__) && __SIZEOF_POINTER__ == 8)
65 #define BIT64
66#elif defined(_WIN32) || defined(__i386__) || defined(__i386) \
67 || defined(_M_IX86) || defined(__arm__) || defined(_M_ARM) \
68 || (defined(__SIZEOF_POINTER__) && __SIZEOF_POINTER__ == 4)
69 #define BIT32
70#else
71 #error "Unsupported architecture (expected 32-bit or 64-bit)"
72#endif
73
74// ---------------------------------------------------------------------------
75// Compiler
76// ---------------------------------------------------------------------------
77#if defined(__clang__)
78 #define CLANG
79#elif defined(__GNUC__) || defined(__GNUG__)
80 #define GCC
81#elif defined(_MSC_VER)
82 #define MSVC
83#endif
84
85// ---------------------------------------------------------------------------
86// C library. <limits.h> is the lightest header that makes each libc announce
87// itself (<features.h>, <sys/cdefs.h>, <_mingw.h>...). musl defines no
88// identifying macro on purpose, so it is what remains on Linux once the
89// others are ruled out.
90// ---------------------------------------------------------------------------
91#include <limits.h>
92
93#if defined(__NEWLIB__)
94 #define NEWLIB // Cygwin, embedded
95#elif defined(__UCLIBC__)
96 #define UCLIBC // checked before GLIBC: it also defines __GLIBC__
97#elif defined(__BIONIC__)
98 #define BIONIC // Android
99#elif defined(__GLIBC__)
100 #define GLIBC
101#elif defined(WINDOWS)
102 #if defined(_UCRT) || (defined(_MSC_VER) && _MSC_VER >= 1900 && !defined(__MINGW32__))
103 #define UCRT // MSVC since 2015, MinGW-w64 UCRT runtime
104 #else
105 #define MSVCRT // legacy MinGW runtime
106 #endif
107#elif defined(__APPLE__) || defined(__FreeBSD__) || defined(__NetBSD__) \
108 || defined(__OpenBSD__) || defined(__DragonFly__)
109 #define BSD_LIBC
110#elif defined(LINUX)
111 #define MUSL
112#endif
113
114// ---------------------------------------------------------------------------
115// C++ standard library. <version> (C++20) defines each implementation's
116// identifying macro without pulling anything else in.
117// ---------------------------------------------------------------------------
118#if defined(__cplusplus)
119 #include <version>
120
121 #if defined(_LIBCPP_VERSION)
122 #define LIBCXX // LLVM libc++, checked first: it may sit beside GCC
123 #elif defined(__GLIBCXX__) || defined(_GLIBCXX_RELEASE)
124 #define LIBSTDCXX // GNU libstdc++
125 #elif defined(_MSVC_STL_VERSION) || defined(_CPPLIB_VER)
126 #define MSVC_STL
127 #endif
128#endif
129
130// ---------------------------------------------------------------------------
131// Force the body into the caller. `inline` alone is only a hint.
132// ---------------------------------------------------------------------------
133#if defined(MSVC)
134 #define STORMBYTE_FORCE_INLINE __forceinline
135#elif defined(GCC) || defined(CLANG)
136 #define STORMBYTE_FORCE_INLINE inline __attribute__((always_inline))
137#else
138 #define STORMBYTE_FORCE_INLINE inline
139#endif