versions.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file versions.hh
 *
 * @brief Interfaces used to perform version number analysis, especially
 *        _Semantic Version_ processing.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <list>
#include <nix/util.hh>
#include <optional>
#include <regex>
#include <string>
 
 
/* -------------------------------------------------------------------------- */
 
namespace versions {
 
/* -------------------------------------------------------------------------- */
 
class VersionException : public std::exception
{
private:
 
  std::string msg;
 
public:
 
  VersionException( std::string_view msg ) : msg( msg ) {}
  const char *
  what() const noexcept override
  {
    return this->msg.c_str();
  }
};
 
 
/* -------------------------------------------------------------------------- */
 
bool
isSemver( const std::string & version );
 
bool
isDate( const std::string & version );
 
bool
isCoercibleToSemver( const std::string & version );
 
bool
isSemverRange( const std::string & version );
 
 
/* -------------------------------------------------------------------------- */
 
std::optional<std::string>
coerceSemver( std::string_view version );
 
 
/* -------------------------------------------------------------------------- */
 
std::pair<int, std::string>
runSemver( const std::list<std::string> & args );
 
std::list<std::string>
semverSat( const std::string & range, const std::list<std::string> & versions );
 
 
/* -------------------------------------------------------------------------- */
 
}  // namespace versions
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */