OpenRCT2/src/openrct2/Version.h

/*****************************************************************************
 * Copyright (c) 2014-2020 OpenRCT2 developers
 *
 * For a complete list of all authors, please refer to contributors.md
 * Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
 *
 * OpenRCT2 is licensed under the GNU General Public License version 3.
 *****************************************************************************/

#pragma once

#include "common.h"

#include <string>

#define OPENRCT2_NAME "OpenRCT2"
#define OPENRCT2_VERSION "0.3.5.1"

#if defined(__amd64__) || defined(_M_AMD64)
#    define OPENRCT2_ARCHITECTURE "x86-64"
#elif defined(__i386__) || defined(_M_IX86)
#    define OPENRCT2_ARCHITECTURE "x86"
#elif defined(__aarch64__) || defined(_M_ARM64)
#    define OPENRCT2_ARCHITECTURE "AArch64"
#elif defined(__arm__) || defined(_M_ARM)
#    if defined(__ARM_ARCH_7A__)
#        define OPENRCT2_ARCHITECTURE "arm-v7a"
#    else
#        define OPENRCT2_ARCHITECTURE "arm"
#    endif
#elif defined(__powerpc__) || defined(_M_PPC)
#    define OPENRCT2_ARCHITECTURE "PowerPC"
#elif defined(__mips64)
#    define OPENRCT2_ARCHITECTURE "mips64"
#elif defined(__mips__)
#    define OPENRCT2_ARCHITECTURE "mips"
#elif defined(__riscv)
#    define OPENRCT2_ARCHITECTURE "RISC-V"
#endif
#ifdef __EMSCRIPTEN__
#    define OPENRCT2_ARCHITECTURE "Emscripten"
#endif

#ifndef OPENRCT2_ARCHITECTURE
#    error "OPENRCT2_ARCHITECTURE is undefined. Please add identification."
#endif

// Platform
#ifdef _WIN32
#    define OPENRCT2_PLATFORM "Windows"
#endif
#if defined(__linux__) && !defined(__ANDROID__)
#    define OPENRCT2_PLATFORM "Linux"
#endif
#if (defined(__APPLE__) && defined(__MACH__))
#    define OPENRCT2_PLATFORM "macOS"
#endif
#ifdef __FreeBSD__
#    define OPENRCT2_PLATFORM "FreeBSD"
#endif
#ifdef __NetBSD__
#    define OPENRCT2_PLATFORM "NetBSD"
#endif
#ifdef __ANDROID__
#    define OPENRCT2_PLATFORM "Android"
#endif
#ifdef __OpenBSD__
#    define OPENRCT2_PLATFORM "OpenBSD"
#endif
#ifdef __EMSCRIPTEN__
#    define OPENRCT2_PLATFORM "Emscripten"
#endif
#ifndef OPENRCT2_PLATFORM
#    error Unknown platform!
#endif

#ifndef OPENRCT2_CUSTOM_INFO
#    define OPENRCT2_CUSTOM_INFO ""
#endif

extern const char gVersionInfoFull[];
extern const char gVersionInfoTag[];
struct NewVersionInfo
{
    std::string tag;
    std::string name;
    std::string changelog;
    std::string url;
};

NewVersionInfo get_latest_version();
Add and correct licence headers to all sources (#3108) 2016-05-04 19:24:41 +02:00			`/*****************************************************************************`
Update copyright year to 2020 2020-07-21 15:04:34 +02:00			`* Copyright (c) 2014-2020 OpenRCT2 developers`
Add and correct licence headers to all sources (#3108) 2016-05-04 19:24:41 +02:00			`*`
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file). 2018-06-15 14:07:34 +02:00			`* For a complete list of all authors, please refer to contributors.md`
			`* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2`
Add and correct licence headers to all sources (#3108) 2016-05-04 19:24:41 +02:00			`*`
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file). 2018-06-15 14:07:34 +02:00			`* OpenRCT2 is licensed under the GNU General Public License version 3.`
Add and correct licence headers to all sources (#3108) 2016-05-04 19:24:41 +02:00			`*****************************************************************************/`

Move creation of version string to Version.cpp 2017-02-03 14:11:58 +01:00			`#pragma once`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00
use SDL2's platform defines to normalise platform guards 2016-01-13 23:37:13 +01:00			`#include "common.h"`

Pester users to update to latest release 2020-07-21 23:22:48 +02:00			`#include <string>`

clang-format root 2018-06-22 23:25:16 +02:00			`#define OPENRCT2_NAME "OpenRCT2"`
Release v0.3.5.1 - Improved: [#12825, #12869] The Tile Inspector window’s layout has been tweaked slightly. - Change: [#15899] Weird bonus for path 0 - likely intended as a queue bonus (original bug). - Fix: [#15138] Sometimes small scenery stays when building through it. - Fix: [#15620] Placing track designs at locations blocked by anything results in wrong error message. - Fix: [#15843] Tile Inspector can be resized too small. - Fix: [#15844] Tile Inspector has inconsistent text colours. - Fix: [#15878] Crash when opening a ride window for a corrupted vehicle. - Fix: [#15908] Crash when track elements have no ride assigned. - Fix: [#15919] Research status incorrectly considered for scenery when in editor modes. - Fix: [#15938] Track designs of some ride types are incorrectly exported to TD6. 2021-11-21 22:06:59 +01:00			`#define OPENRCT2_VERSION "0.3.5.1"`
Define correct architecture 2016-08-19 01:18:09 +02:00
Improve architecture detection macros 2016-08-28 16:54:38 +02:00			`#if defined(__amd64__) \|\| defined(_M_AMD64)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "x86-64"`
Improve architecture detection macros 2016-08-28 16:54:38 +02:00			`#elif defined(__i386__) \|\| defined(_M_IX86)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "x86"`
Add define for ARM64 (#10096) 2019-10-15 06:47:49 +02:00			`#elif defined(__aarch64__) \|\| defined(_M_ARM64)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "AArch64"`
Improve architecture detection macros 2016-08-28 16:54:38 +02:00			`#elif defined(__arm__) \|\| defined(_M_ARM)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# if defined(__ARM_ARCH_7A__)`
			`# define OPENRCT2_ARCHITECTURE "arm-v7a"`
			`# else`
			`# define OPENRCT2_ARCHITECTURE "arm"`
			`# endif`
Add PowerPC to list of architectures in version.h PowerPC is not supported yet, but it's getting closer. 2016-11-24 13:10:10 +01:00			`#elif defined(__powerpc__) \|\| defined(_M_PPC)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "PowerPC"`
Add Android project 2017-06-15 14:22:15 +02:00			`#elif defined(__mips64)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "mips64"`
Add Android project 2017-06-15 14:22:15 +02:00			`#elif defined(__mips__)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "mips"`
Add RISC-V architecture information (#7966) 2018-09-03 10:22:36 +02:00			`#elif defined(__riscv)`
			`# define OPENRCT2_ARCHITECTURE "RISC-V"`
Improve architecture detection macros 2016-08-28 16:54:38 +02:00			`#endif`
Add Emscripten platform and architecture defines 2017-09-04 23:18:51 +02:00			`#ifdef __EMSCRIPTEN__`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_ARCHITECTURE "Emscripten"`
Add Emscripten platform and architecture defines 2017-09-04 23:18:51 +02:00			`#endif`
Improve architecture detection macros 2016-08-28 16:54:38 +02:00
			`#ifndef OPENRCT2_ARCHITECTURE`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# error "OPENRCT2_ARCHITECTURE is undefined. Please add identification."`
Define correct architecture 2016-08-19 01:18:09 +02:00			`#endif`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00
			`// Platform`
Use standard platform defines 2017-06-12 19:00:15 +02:00			`#ifdef _WIN32`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "Windows"`
use SDL2's platform defines to normalise platform guards 2016-01-13 23:37:13 +01:00			`#endif`
Add Android project 2017-06-15 14:22:15 +02:00			`#if defined(__linux__) && !defined(__ANDROID__)`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "Linux"`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00			`#endif`
Use standard platform defines 2017-06-12 19:00:15 +02:00			`#if (defined(__APPLE__) && defined(__MACH__))`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "macOS"`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00			`#endif`
Use standard platform defines 2017-06-12 19:00:15 +02:00			`#ifdef __FreeBSD__`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "FreeBSD"`
Add FreeBSD support At the moment the platform specific code supports only FreeBSD as OpenBSD and NetBSD does not support the full path retrieval for an executable, we intentionally stop the compilation for those platforms. 2016-12-28 14:18:04 +01:00			`#endif`
Support NetBSD and simplify platform ifdefs. (#10271) For files intended to support unixy freedesktopy systems, reduce the ifdef down to __unix__ && !__APPLE__ && !__ANDROID__, rather than naming linux and all the BSDs and so on by hand. Should simplify adding support for systems like illumos in the future. Co-authored-by: Michael Steenbeek <m.o.steenbeek@gmail.com> 2019-12-22 17:07:40 +01:00			`#ifdef __NetBSD__`
			`# define OPENRCT2_PLATFORM "NetBSD"`
			`#endif`
Add Android project 2017-06-15 14:22:15 +02:00			`#ifdef __ANDROID__`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "Android"`
Add Android project 2017-06-15 14:22:15 +02:00			`#endif`
Add OpenBSD support. 2017-06-25 21:25:55 +02:00			`#ifdef __OpenBSD__`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "OpenBSD"`
Add OpenBSD support. 2017-06-25 21:25:55 +02:00			`#endif`
Add Emscripten platform and architecture defines 2017-09-04 23:18:51 +02:00			`#ifdef __EMSCRIPTEN__`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_PLATFORM "Emscripten"`
Add Emscripten platform and architecture defines 2017-09-04 23:18:51 +02:00			`#endif`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00			`#ifndef OPENRCT2_PLATFORM`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# error Unknown platform!`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00			`#endif`

Remove use of problematic __DATE__ and __TIME__ Replace with a placeholder to be filled by external tools 2017-12-25 22:51:35 +01:00			`#ifndef OPENRCT2_CUSTOM_INFO`
Indent preprocessor directives 2018-07-21 16:17:06 +02:00			`# define OPENRCT2_CUSTOM_INFO ""`
Remove use of problematic __DATE__ and __TIME__ Replace with a placeholder to be filled by external tools 2017-12-25 22:51:35 +01:00			`#endif`
improve project version defines and publish script 2015-12-02 23:28:00 +01:00
Remove almost every extern C block 2018-02-01 18:49:14 +01:00			`extern const char gVersionInfoFull[];`
Pester users to update to latest release 2020-07-21 23:22:48 +02:00			`extern const char gVersionInfoTag[];`
			`struct NewVersionInfo`
			`{`
			`std::string tag;`
			`std::string name;`
			`std::string changelog;`
			`std::string url;`
			`};`

			`NewVersionInfo get_latest_version();`