src/rev.cpp.in

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD 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.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file rev.cpp Autogenerated file with the revision and such of OpenTTD. */
   9
  10 #include "stdafx.h"
  11 #include "core/bitmath_func.hpp"
  12 #include "rev.h"
  13
  14 #include "safeguards.h"
  15
  16 /**
  17  * Is this version of OpenTTD a release version?
  18  * @return True if it is a release version.
  19  */
  20 bool IsReleasedVersion()
  21 {
  22         return HasBit(_openttd_newgrf_version, 19);
  23 }
  24
  25 /**
  26  * The text version of OpenTTD's revision.
  27  * This will be either
  28  * - "<tag>", like "<major>.<minor>.<build>[-RC<rc>]",
  29  * - "<commitdate>-g<shorthash><modified>" in "master",
  30  * - "<commitdate>-<branch>-g<shorthash><modified>" in other branches, or
  31  * - "norev0000", if the version is unknown.
  32  *
  33  * The major, minor and build are the numbers that describe releases of
  34  * OpenTTD (like 0.5.3). "-RC" is used to flag release candidates.
  35  *
  36  * <modified> shows a "M", if the binary is made from modified source code.
  37  */
  38 const char _openttd_revision[] = "${REV_VERSION}";
  39
  40 /**
  41  * The text version of OpenTTD's build date.
  42  * Updating the build date in this file is the safest as it generally gets
  43  * updated for each revision in contrary to most other files that only see
  44  * updates when they are actually changed themselves.
  45  */
  46 const char _openttd_build_date[] = __DATE__ " " __TIME__;
  47
  48 /**
  49  * The git revision hash of this version.
  50  */
  51 const char _openttd_revision_hash[] = "${REV_HASH}";
  52
  53 /**
  54  * The year of this version.
  55  */
  56 const char _openttd_revision_year[] = "${REV_YEAR}";
  57
  58 /**
  59  * Let us know if current build was modified. This detection
  60  * works even in the case when revision string is overridden by
  61  * --revision argument.
  62  * Value 0 means no modification, 1 is for unknown state
  63  * (compiling from sources without any version control software)
  64  * and 2 is for modified revision.
  65  */
  66 const uint8_t _openttd_revision_modified = ${REV_MODIFIED};
  67
  68 /**
  69  * Indicate whether this is a tagged version.
  70  * If this is non-0, then _openttd_revision is the name of the tag,
  71  * and the version is likely a beta, release candidate, or real release.
  72  */
  73 const uint8_t _openttd_revision_tagged = ${REV_ISTAG};
  74
  75 /**
  76  * To check compatibility of BaNaNaS content, this version string is used.
  77  * It should never contain things like "beta", but only the release version
  78  * we are compatible with.
  79  */
  80 const char _openttd_content_version[] = "${REV_MAJOR}.${REV_MINOR}";
  81
  82 /**
  83  * The NewGRF revision of OTTD:
  84  * bits  meaning.
  85  * 24-31 major version + 16
  86  * 20-23 minor version
  87  *    19 1 if it is a release, 0 if it is not.
  88  *  0-18 used to be the SVN revision, now just last revision before switch to git
  89  *
  90  * The 19th bit is there so the development/betas/alpha, etc. leading to a
  91  * final release will always have a lower version number than the released
  92  * version, thus making comparisons on specific revisions easy.
  93  *
  94  * The + 16 for the major version is because we went from 1.11.0 to 12.0, dropping
  95  * the "patch" part of the version. To make sure "1.11.0" is smaller than "12.0", we
  96  * have to adjust the major by 16.
  97  */
  98 const uint32_t _openttd_newgrf_version = (${REV_MAJOR} + 16) << 24 | ${REV_MINOR} << 20 | ${REV_ISSTABLETAG} << 19 | 28004;