OpenRCT2/src/openrct2/Version.h

/*****************************************************************************
 * Copyright (c) 2014-2023 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.4.6"

#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

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

NewVersionInfo GetLatestVersion();
Add and correct licence headers to all sources (#3108) 2016-05-04 19:24:41 +02:00			`/*****************************************************************************`
Replace 2022 with 2023 in copyright headers Replace all instances of the year 2022 with 2023 in all copyright headers 2023-01-01 11:58:01 +01:00			`* Copyright (c) 2014-2023 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.4.6 - Feature: [#15660] Ability to show window buttons on the left. - Feature: [#20680] New title sequences (https://github.com/OpenRCT2/title-sequences/releases/tag/v0.4.6). - Feature: [OpenMusic#41] Official Title Theme by Allister Brimble. - Improved: [#20119, #20243] Add new colour presets to several roller coasters (using the new colours). - Improved: [#20393, #20410] Add Cyrillic characters Ґґ, Ѕѕ, Єє, Іі, Її, and Јј to the sprite font. - Change: [#19785] OpenMusic is now selected by default when opening SC4/SC6 - or creating new - scenarios. - Change: [#20110] Fix a few RCT1 build height parity discrepancies. - Change: [#20550] Change SEK conversion rate from 1 GBP to 0.1 GBP. - Fix: [#6152] Camera and UI are no longer locked at 40 Hz, providing a smoother experience. - Fix: [#9534] Screams no longer cut-off on steep diagonal drops. - Fix: [#17666] Using the mountain tool near the edge of the map with clearance checks disabled causes visual glitches. - Fix: [#19450] The correct element is now auto-suggested when building a Medium Half Loop backwards. - Fix: [#19735] Server unable to advertise to master server after a connection loss. - Fix: [#19822] Tile inspector does not deep copy banners. - Fix: [#19823] Parkobj: disallow overriding objects of different object types. - Fix: [#19878] Unresearched scenery can be placed via prebuilt rides. - Fix: [#20083] Cannot use terrain surfaces with ID > 32 and terrain edges with ID > 16. - Fix: [#20089] Potential crash when a window is closed from another window. - Fix: [#20103] [Plugin] Crash when custom plugin actions fail due to immutable state. - Fix: [#20111] All coaster types can access the new diagonal slope pieces. - Fix: [#20155] Fairground organ style 2 shows up as regular music, rather than for the merry-go-round. - Fix: [#20260] Ride locks up when inspecting/fixing staff member is fired. - Fix: [#20262] Title screen music missing when “random” title music is selected and RCT1 is no longer linked. - Fix: [#20310] Map animations are not created on the title screen. - Fix: [#20342] Large Half Loop (left) now only appears once in the special elements dropdown. - Fix: [#20361] Crash when using random map generation. - Fix: [#20364] Adding too much money with cheats causes an overflow. - Fix: [#20365] Money cheat input does not support negative values. - Fix: [#20389] Reversed vehicles are now correctly banked on diagonal slopes. - Fix: [#20413] Crash when attempting to navigate an empty console history. - Fix: [#20417] Plugin/custom windows are missing the left border in the title bar. - Fix: [#20429] Error window tooltip not closing after 8 seconds. - Fix: [#20456] Downward large half loops on flying coasters (fly-to-lie) are now correctly named. - Fix: [#20484] Console caret not properly updated when using command history. - Fix: [#20496] Ride rating requirements for compact inverted coasters is no longer relaxed. - Fix: [#20543] Crash using show segments height from debug paint options. - Fix: [#20607] Infinite loop when renaming rides with default names longer than 32 bytes. - Fix: [#20642] Track list is sometimes empty due to uninitialized data for the filter string. - Fix: [#20659] Phantom rides remain when closing construction window while paused. - Fix: [#20672] Maze ghost elements incorrectly displayed. - Fix: [#20684] Footpath additions getting removed by Miniature railway ghost elements. - Fix: [#20693] Incorrect information shown when hovering over station when another station before it was removed. - Fix: [#20739] Build version info on title screen leaving stray pixels when the camera is moved. 2023-09-03 17:13:15 +02:00			`#define OPENRCT2_VERSION "0.4.6"`
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 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;`
			`};`

Rename snake_case functions in openrct2/src folder Co-authored-by: duncanspumpkin <duncans_pumpkin@hotmail.co.uk> 2023-01-17 13:24:51 +01:00			`NewVersionInfo GetLatestVersion();`