ArpVersion.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/Detail/Version.hpp"
#include "Arp/Base/Core/Detail/ArpVersion.Build.h"
#include "Arp/Base/Core/Detail/ArpVersion.Abi.h"
 
namespace Arp { namespace Base { namespace Core
{
 
class ARP_EXPORT ArpVersion
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Value = Version::Value;
 
public: // canonical construction/destruction/assignment
    ArpVersion(const ArpVersion& arg);
    ArpVersion(ArpVersion&& arg)noexcept;
    ArpVersion& operator=(const ArpVersion& arg);
    ArpVersion& operator=(ArpVersion&& arg)noexcept;
    ~ArpVersion(void);
 
public: // construction
    ArpVersion(void);
    ArpVersion(Value major, const String& state = "", const String& name = "");
    ArpVersion(Value major, Value minor, const String& state = "", const String& name = "");
    ArpVersion(Value major, Value minor, Value patch, const String& state = "", const String& name = "");
    ArpVersion(Value major, Value minor, Value patch, Value build, const String& state = "", const String& name = "");
    explicit ArpVersion(const Version& version, const String& state = "", const String& name = "");
 
public: // operators
    ARP_EXPORT friend bool operator==(const ArpVersion& left, const ArpVersion& right);
 
public: // static operations
    static const ArpVersion&    GetCurrent(void);
    static ArpVersion           Parse(const String& input);
    static bool                 TryParse(const String& input, ArpVersion& result);
 
public: // setter/getter operations
    const String&   GetName(void)const;
    const String&   GetState(void)const;
    const Version&  GetBuildVersion(void)const;
 
public: // operations
    String ToString(void)const;
 
public: // deprecated operations
    ARP_DEPRECATED("Use ArpVersion::GetBuildVersion().GetMajor() instead.")
    uint8   GetMajor(void)const;
    ARP_DEPRECATED("Use ArpVersion::GetBuildVersion().GetMinor() instead.")
    uint8   GetMinor(void)const;
    ARP_DEPRECATED("Use ArpVersion::GetBuildVersion().GetPatch() instead.")
    uint8   GetPatch(void)const;
    ARP_DEPRECATED("Use ArpVersion::GetBuildVersion().GetBuildNumber() instead.")
    uint32  GetBuild(void)const;
 
    friend ARP_EXPORT bool operator>(const ArpVersion& left, const ArpVersion& right);
    friend ARP_EXPORT bool operator<(const ArpVersion& left, const ArpVersion& right);
    friend ARP_EXPORT bool operator>=(const ArpVersion& left, const ArpVersion& right);
    friend ARP_EXPORT bool operator<=(const ArpVersion& left, const ArpVersion& right);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
ARP_EXPORT std::ostream& operator<<(std::ostream& os, const ArpVersion& arg);
ARP_EXPORT std::istream& operator>>(std::istream& is, ArpVersion& arg);
 
 
ARP_DEPRECATED("Use compare operator of ArpVersion::GetBuildVersion() instead.")
ARP_EXPORT bool operator>(const ArpVersion& left, const ArpVersion& right);
 
ARP_DEPRECATED("Use compare operator of ArpVersion::GetBuildVersion() instead.")
ARP_EXPORT bool operator<(const ArpVersion& left, const ArpVersion& right);
 
ARP_DEPRECATED("Use compare operator of ArpVersion::GetBuildVersion() instead.")
ARP_EXPORT bool operator>=(const ArpVersion& left, const ArpVersion& right);
 
ARP_DEPRECATED("Use compare operator of ArpVersion::GetBuildVersion() instead.")
ARP_EXPORT bool operator<=(const ArpVersion& left, const ArpVersion& right);
 
 
#define ARP_VERSION_CURRENT ArpVersion(ARP_VERSION_MAJOR, ARP_VERSION_MINOR, ARP_VERSION_PATCH, ARP_VERSION_BUILD, ARP_VERSION_STATE, ARP_VERSION_NAME)
 
#define ARP_VERSION_BUILT ArpVersion(ARP_VERSION_MAJOR, ARP_VERSION_MINOR, ARP_VERSION_PATCH, ARP_VERSION_BUILD, ARP_VERSION_STATE, ARP_VERSION_NAME)
 
#define ARP_ABI_VERSION_CURRENT ArpVersion(ARP_ABI_VERSION_MAJOR, ARP_ABI_VERSION_MINOR, ARP_ABI_VERSION_PATCH, "", "ABI");
 
}}} // end of namespace Arp::Base::Core
 
namespace Arp {
using Arp::Base::Core::ArpVersion;
}
template<> struct fmt::formatter<Arp::Base::Core::ArpVersion> : public fmt::ostream_formatter {};