Version.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#define ARP_INSIDE_ARP_BASE_CORE_ARP_H
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Core/Detail/PrimitiveTypes.hpp"
#include "Arp/Base/Core/Detail/String.hpp"
#include <compare>
 
namespace Arp { namespace Base { namespace Core
{
 
class ARP_EXPORT Version
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Value = uint32;
 
public: // construction/destruction/assignment
    explicit Version(Value major, Value minor = 0, Value patch = 0, Value build = 0);
    explicit Version(Value major, Value minor, Value patch, const String& preRelease, const String& buildInfo);
    Version(void);
    Version(const Version& arg);
    Version(Version&& arg)noexcept;
    Version& operator=(const Version& arg);
    Version& operator=(Version&& arg)noexcept;
    ~Version(void);
 
public: // operators
    friend ARP_EXPORT bool operator==(const Version& left, const Version& right);
    friend ARP_EXPORT std::strong_ordering operator<=>(const Version& left, const Version& right);
 
    friend ARP_EXPORT std::ostream& operator<<(std::ostream& os, const Version& arg);
    friend ARP_EXPORT std::istream& operator>>(std::istream& is, Version& arg);
 
public: // static operations
    static Version  Parse(const String& input);
    static bool     TryParse(const String& input, Version& result);
 
public: // setter/getter operations
    Value   GetMajor(void)const;
    Value   GetMinor(void)const;
    Value   GetPatch(void)const;
    Value   GetBuildNumber(void)const;
    String  GetPreRelease(void)const;
    String  GetBuildInfo(void)const;
 
public: // operations
    String ToString(void) const;
 
public: // deprecated operations
    ARP_DEPRECATED("Use class ArpVersion instead.")
    Version(Value major, Value minor, Value patch, Value build, const String& state, const String& name);
    ARP_DEPRECATED("Use class ArpVersion instead.")
    const String&   GetName(void)const;
    ARP_DEPRECATED("Use class ArpVersion instead.")
    const String&   GetState(void)const;
 
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 Version& arg);
ARP_EXPORT std::istream& operator>>(std::istream& os, Version& arg);
 
}}} // end of namespace Arp::Base::Core
 
namespace Arp {
using Arp::Base::Core::Version;
}
template<> struct fmt::formatter<Arp::Base::Core::Version> : public fmt::ostream_formatter {};