src/liblzma/api/lzma/version.h

   1 /**
   2  * \file        lzma/version.h
   3  * \brief       Version number
   4  *
   5  * \author      Copyright (C) 1999-2006 Igor Pavlov
   6  * \author      Copyright (C) 2007 Lasse Collin
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  */
  18
  19 #ifndef LZMA_H_INTERNAL
  20 #       error Never include this file directly. Use <lzma.h> instead.
  21 #endif
  22
  23
  24 /**
  25  * \brief       Compile-time version number
  26  *
  27  * The version number is of format xyyyzzzs where
  28  *  - x = major
  29  *  - yyy = minor
  30  *  - zzz = revision
  31  *  - s indicates stability: 0 = alpha, 1 = beta, 2 = stable
  32  *
  33  * The same xyyyzzz triplet is never reused with different stability levels.
  34  * For example, if 5.1.0alpha has been released, there will never be 5.1.0beta
  35  * or 5.1.0 stable.
  36  *
  37  * \note        The version number of liblzma has nothing to with
  38  *              the version number of Igor Pavlov's LZMA SDK.
  39  */
  40 #define LZMA_VERSION UINT32_C(49990081)
  41
  42
  43 /**
  44  * \brief       liblzma version number as an integer
  45  *
  46  * Returns the value of LZMA_VERSION macro at the compile time of liblzma.
  47  * This allows the application to compare if it was built against the same,
  48  * older, or newer version of liblzma that is currently running.
  49  */
  50 extern LZMA_API(uint32_t) lzma_version_number(void) lzma_attr_const;
  51
  52
  53 /**
  54  * \brief       Version number of liblzma as a string
  55  *
  56  * This function may be useful if you want to display which version of
  57  * liblzma your application is currently using.
  58  */
  59 extern LZMA_API(const char *) lzma_version_string(void) lzma_attr_const;