crawl-ref/source/version.h

   1 /*
   2  *  File: version.h
   3  *  Summary: Contains version information
   4  */
   5
   6 #ifndef VERSION_H
   7 #define VERSION_H
   8
   9 #define CRAWL "Dungeon Crawl Stone Soup"
  10
  11 namespace Version
  12 {
  13     //! The short version string.
  14     /*!
  15      * This version will generally match the last version tag. For instance,
  16      * if the last tag of Crawl before this build was '0.1.2', you'd see
  17      * '0.1.2'. This version number does not include some rather important
  18      * extra information useful for getting the exact revision (the Git commit
  19      * hash and the number of revisions since the tag). For that extra information,
  20      * use Version::Long() instead.
  21      *
  22      * For extracting individual components of the version, you should use the
  23      * Major(), Minor(), Revision() and Build() functions.
  24      */
  25     std::string Short();
  26
  27     //! The long version string.
  28     /*!
  29      * This string contains detailed version information about the CrissCross
  30      * build in use. The string will always start with the Git tag that this
  31      * build descended from. If this build is not an exact match for a given
  32      * tag, this string will also include the number of commits since the tag
  33      * and the Git commit id (the SHA-1 hash).
  34      */
  35     std::string Long();
  36
  37     //! The major version number.
  38     /*!
  39      * This is the first number to appear in a version tag. For instance,
  40      * if the tag is '0.1.2.3', this function would return '0'.
  41      */
  42     int Major();
  43
  44     //! The minor version number.
  45     /*!
  46      * This is the second number to appear in a version tag. For instance,
  47      * if the tag is '0.1.2.3', this function would return '1'.
  48      */
  49     int Minor();
  50
  51     //! The revision number.
  52     /*!
  53      * This is the third number to appear in a version tag. For instance,
  54      * if the tag is '0.1.2.3', this function would return '2'.
  55      */
  56     int Revision();
  57
  58     //! The build number.
  59     /*!
  60      * This is the fourth number to appear in a version tag. For instance,
  61      * if the tag is '0.1.2.3', this function would return '3'.
  62      */
  63     int Build();
  64
  65     typedef enum {
  66         DEV,    /*!< In-development version (does not exactly match a tag). i.e. '0.1.2-3-g3af4131'. */
  67         ALPHA,  /*!< An alpha release. i.e. '0.1.2-a3' */
  68         BETA,   /*!< A beta release. i.e. '0.1.2-b3' */
  69         RC,     /*!< A release candidate. i.e. '0.1.2-rc3' */
  70         FINAL   /*!< A final release. i.e. '0.1.2' */
  71     } Class;
  72
  73     //! The release class.
  74     /*!
  75      * Indicates the type of release. For instance, if you have a tag such
  76      * as '0.1.2-b1', the class is 'BETA'. Valid suffixes are '-a', '-b',
  77      * '-rc'. If the version string does not precisely match a tag, then it
  78      * is considered an in-development version.
  79      */
  80     Class ReleaseType();
  81
  82     //! The release ID.
  83     /*!
  84      * If this is a special type of release (alpha, beta, rc), then this
  85      * will return the alpha/beta/rc number. Otherwise, this returns 0.
  86      */
  87     int ReleaseID();
  88
  89     //! The compiler used.
  90     /*!
  91      * Names the compiler used to genrate the executable.
  92      */
  93     std::string Compiler();
  94
  95     //! The compiling operating system.
  96     /*!
  97      * Names the operating system that the executable was compiled on.
  98      */
  99     std::string BuildOS();
 100
 101     //! The compiling operating system's version.
 102     /*!
 103      * Specifies the version of the OS that the executable was compiled on.
 104      */
 105     std::string BuildOSVersion();
 106
 107     //! The machine type.
 108     /*!
 109      * Names the machine type (e.g., "i686") the executable was compiled on.
 110      */
 111     std::string BuildMachine();
 112
 113     //! The processor type.
 114     /*!
 115      * Names the processor type the executable was compiled on.
 116      */
 117     std::string BuildProcessor();
 118
 119     //! The CFLAGS.
 120     /*!
 121      * Returns the CFLAGS the executable was compiled with.
 122      */
 123     std::string CFLAGS();
 124
 125     //! The LDFLAGS.
 126     /*!
 127      * Returns the flags the executable was linked with.
 128      */
 129     std::string LDFLAGS();
 130 }
 131
 132 std::string compilation_info();
 133
 134 #endif