ls-standard-library/include/ls-std/core/Version.hpp

/*
 * Author:          Patrick-Christopher Mattulat
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2020-09-27
 * Changed:         2024-09-11
 *
 * */

#ifndef LS_STD_VERSION_HPP
#define LS_STD_VERSION_HPP

#include "Class.hpp"
#include <ls-std/core/interface/ISerializable.hpp>
#include <ls-std/core/type/Types.hpp>
#include <ls-std/os/dynamic-goal.hpp>
#include <string_view>

/*
 * @doc: class(name: 'Version', package: 'core')
 * @doc: core.Version.description('This class represents a semantic versioning scheme.')
 * */

namespace ls::std::core
{
  class LS_STD_DYNAMIC_GOAL Version : public ls::std::core::interface_type::ISerializable
  {
    public:

      explicit Version(ls::std::core::type::version_type _majorVersion, ls::std::core::type::version_type _minorVersion, ls::std::core::type::version_type _patchVersion);
      ~Version() noexcept override;

      // implementation

      [[nodiscard]] ls::std::core::type::byte_field marshal() override;
      void unmarshal(const ls::std::core::type::byte_field &_data) override;

      // other functionality

      [[nodiscard]] ls::std::core::type::version_type getMajorVersion() const;
      [[nodiscard]] ls::std::core::type::version_type getMinorVersion() const;
      [[nodiscard]] ls::std::core::type::version_type getPatchVersion() const;
      [[nodiscard]] static bool isValid(const ::std::string &_versionString);
      void setMajorVersion(ls::std::core::type::version_type _major);
      void setMinorVersion(ls::std::core::type::version_type _minor);
      void setPatchVersion(ls::std::core::type::version_type _patch);

    private:

      ls::std::core::type::version_type majorVersion{};
      ls::std::core::type::version_type minorVersion{};
      ls::std::core::type::version_type patchVersion{};

      [[nodiscard]] static bool _isValid(::std::string_view _versionString);
  };
}

#endif