// SPDX-License-Identifier: GPL-2.0-or-later

#ifndef VERSION_HPP_
#define VERSION_HPP_

#include "exiv2lib_export.h"
#include "exv_conf.h"

// *****************************************************************************
// included header files
// + standard includes
#include <regex>
#include <vector>

/*!
  @brief Make an integer version number for comparison from a major, minor and
         a patch version number.
 */
#define EXIV2_MAKE_VERSION(major, minor, patch) (((major) << 16) | ((minor) << 8) | (patch))
/*!
  @brief The %Exiv2 version number of the library used at compile-time as
         an integer number for easy comparison.
 */
#define EXIV2_VERSION EXIV2_MAKE_VERSION(EXIV2_MAJOR_VERSION, EXIV2_MINOR_VERSION, EXIV2_PATCH_VERSION)

/*!
  @brief Macro to test the version the %Exiv2 library at compile-time.
         Return true if it is the same as or newer than the passed-in version.

  Versions prior to v0.27 are denoted using a triplet of integers: \em MAJOR.MINOR.PATCH .
  From v0.27 forward, the fourth digit is a "tweak" and designates the pre-release number of the version.

  @code
  // Application code is expected to include <exiv2/exiv2.hpp>
  // Don't include the <exiv2/version.hpp> file directly
  // Early Exiv2 versions didn't have version.hpp and the macros.

  #include <exiv2/exiv2.hpp>

  // Make sure an EXIV2_TEST_VERSION macro exists:
  #ifdef EXIV2_VERSION
  # ifndef EXIV2_TEST_VERSION
  # define EXIV2_TEST_VERSION(major,minor,patch) \
      ( EXIV2_VERSION >= EXIV2_MAKE_VERSION(major,minor,patch) )
  # endif
  #else
  # define EXIV2_TEST_VERSION(major,minor,patch) (false)
  #endif

  std::cout << "Compiled with Exiv2 version " << EXV_PACKAGE_VERSION << "\n"
            << "Runtime Exiv2 version is    " << Exiv2::version()    << "\n";

  // Test the Exiv2 version available at runtime but compile the if-clause only if
  // the compile-time version is at least 0.15. Earlier versions didn't have a
  // testVersion() function:

  #if EXIV2_TEST_VERSION(0,15,0)
  if (Exiv2::testVersion(0,13,0)) {
      std::cout << "Available Exiv2 version is equal to or greater than 0.13\n";
  }
  else {
      std::cout << "Installed Exiv2 version is less than 0.13\n";
  }
  #else
  std::cout << "Compile-time Exiv2 version doesn't have Exiv2::testVersion()\n";
  #endif
  @endcode
 */
#define EXIV2_TEST_VERSION(major, minor, patch) (EXIV2_VERSION >= EXIV2_MAKE_VERSION(major, minor, patch))

// *****************************************************************************
// namespace extensions
namespace Exiv2 {
/*!
  @brief Return the version of %Exiv2 available at runtime as a uint32_t.
*/
EXIV2API uint32_t versionNumber();
/*!
  @brief Return the version string Example: "0.25.0" (major.minor.patch)
*/
EXIV2API std::string versionString();
/*!
  @brief Return the version of %Exiv2 as hex string of fixed length 6.
*/
EXIV2API std::string versionNumberHexString();

/*!
  @brief Return the version of %Exiv2 as "C" string eg "0.27.0.2".
*/
EXIV2API const char* version();

/*!
  @brief Test the version of the available %Exiv2 library at runtime. Return
         true if it is the same as or newer than the passed-in version.

  Versions are denoted using a triplet of integers: \em major.minor.patch .
  The fourth version number is designated a "tweak" an used by Release Candidates
*/
EXIV2API bool testVersion(uint32_t major, uint32_t minor, uint32_t patch);
/*!
  @brief dumpLibraryInfo implements the exiv2 option --version --verbose
         used by exiv2 test suite to inspect libraries loaded at run-time
 */
EXIV2API void dumpLibraryInfo(std::ostream& os, const std::vector<std::regex>& keys);
}  // namespace Exiv2

#endif  // VERSION_HPP_