1/**************************************************************************/
2/* version.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef VERSION_H
32#define VERSION_H
33
34#include "core/version_generated.gen.h"
35
36// Godot versions are of the form <major>.<minor> for the initial release,
37// and then <major>.<minor>.<patch> for subsequent bugfix releases where <patch> != 0
38// That's arbitrary, but we find it pretty and it's the current policy.
39
40// Defines the main "branch" version. Patch versions in this branch should be
41// forward-compatible.
42// Example: "3.1"
43#define VERSION_BRANCH _MKSTR(VERSION_MAJOR) "." _MKSTR(VERSION_MINOR)
44#if VERSION_PATCH
45// Example: "3.1.4"
46#define VERSION_NUMBER VERSION_BRANCH "." _MKSTR(VERSION_PATCH)
47#else // patch is 0, we don't include it in the "pretty" version number.
48// Example: "3.1" instead of "3.1.0"
49#define VERSION_NUMBER VERSION_BRANCH
50#endif // VERSION_PATCH
51
52// Version number encoded as hexadecimal int with one byte for each number,
53// for easy comparison from code.
54// Example: 3.1.4 will be 0x030104, making comparison easy from script.
55#define VERSION_HEX 0x10000 * VERSION_MAJOR + 0x100 * VERSION_MINOR + VERSION_PATCH
56
57// Describes the full configuration of that Godot version, including the version number,
58// the status (beta, stable, etc.) and potential module-specific features (e.g. mono).
59// Example: "3.1.4.stable.mono"
60#define VERSION_FULL_CONFIG VERSION_NUMBER "." VERSION_STATUS VERSION_MODULE_CONFIG
61
62// Similar to VERSION_FULL_CONFIG, but also includes the (potentially custom) VERSION_BUILD
63// description (e.g. official, custom_build, etc.).
64// Example: "3.1.4.stable.mono.official"
65#define VERSION_FULL_BUILD VERSION_FULL_CONFIG "." VERSION_BUILD
66
67// Same as above, but prepended with Godot's name and a cosmetic "v" for "version".
68// Example: "Godot v3.1.4.stable.official.mono"
69#define VERSION_FULL_NAME VERSION_NAME " v" VERSION_FULL_BUILD
70
71// Git commit hash, generated at build time in `core/version_hash.gen.cpp`.
72extern const char *const VERSION_HASH;
73
74#endif // VERSION_H
75