year.h

Go to the documentation of this file.

 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2023 John Wellbelove
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
******************************************************************************/
 
#ifndef ETL_IN_CHRONO_H
  #error DO NOT DIRECTLY INCLUDE THIS FILE. USE CHRONO.H
#endif
 
namespace etl
{
  namespace chrono
  {
    //***********************************************************************
    //***********************************************************************
    class year
    {
    public:
 
      using rep = int16_t;
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR year() ETL_NOEXCEPT
        : value(0)
      {
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR explicit year(unsigned value_) ETL_NOEXCEPT
        : value(value_)
      {
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 year(const etl::chrono::year& other) ETL_NOEXCEPT
        : value(other.value)
      {
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year& operator =(const etl::chrono::year& rhs) ETL_NOEXCEPT
      {
        value = rhs.value;
 
        return *this;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year& operator ++() ETL_NOEXCEPT
      {
        ++value;
 
        return *this;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year operator ++(int) ETL_NOEXCEPT
      {
        const etl::chrono::year temp = *this;
        ++value;
 
        return temp;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year& operator --() ETL_NOEXCEPT
      {
        --value;
 
        return *this;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year operator --(int) ETL_NOEXCEPT
      {
        const etl::chrono::year temp = *this;
        --value;
 
        return temp;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year& operator +=(const etl::chrono::years& ys) ETL_NOEXCEPT
      {
        value += static_cast<unsigned char>(ys.count());
 
        return *this;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 etl::chrono::year& operator -=(const etl::chrono::years& ys) ETL_NOEXCEPT
      {
        value -= static_cast<unsigned char>(ys.count());
 
        return *this;
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 bool ok() const ETL_NOEXCEPT
      {
        return (value != etl::integral_limits<int16_t>::min);
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_NODISCARD
      static ETL_CONSTEXPR14 etl::chrono::year min() ETL_NOEXCEPT
      {
        return etl::chrono::year(-32767);
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_NODISCARD
      static ETL_CONSTEXPR14 etl::chrono::year max() ETL_NOEXCEPT
      {
        return etl::chrono::year(32767);
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 bool is_leap() const ETL_NOEXCEPT
      {
        return ((value % 4) == 0) &&    // Divisible by 4
               (((value % 100) != 0) || // but not divisible by 100
                ((value % 400) == 0));  // unless divisible by 400
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_CONSTEXPR14 operator int() const ETL_NOEXCEPT
      {
        return static_cast<int>(value);
      }
 
      //***********************************************************************
      //***********************************************************************
      ETL_NODISCARD
      ETL_CONSTEXPR14 int compare(const year& other) const ETL_NOEXCEPT 
      {
        if (value < other.value) return -1;
        if (value > other.value) return 1;
 
        return 0;
      }
 
    private:
 
      rep value;
    };
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 bool operator ==(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return (static_cast<unsigned>(y1) == static_cast<unsigned>(y2));
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 bool operator !=(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return !(y1 == y2);
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 bool operator <(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return (static_cast<unsigned>(y1) < static_cast<unsigned>(y2));
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 bool operator <=(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return (static_cast<unsigned>(y1) <= static_cast<unsigned>(y2));
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 bool operator >(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return (static_cast<unsigned>(y1) > static_cast<unsigned>(y2));
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 bool operator >=(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return (static_cast<unsigned>(y1) >= static_cast<unsigned>(y2));
    }
 
    //***********************************************************************
    //***********************************************************************
#if ETL_USING_CPP20
    [[nodiscard]] inline constexpr auto operator <=>(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return (static_cast<unsigned>(y1) <=> static_cast<unsigned>(y2));
    }
#endif
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year operator +(const etl::chrono::year& y, const etl::chrono::years& ys) ETL_NOEXCEPT
    {
      etl::chrono::year result(y);
 
      result += ys;
 
      return result;
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year operator +(const etl::chrono::years& ys, const etl::chrono::year& y) ETL_NOEXCEPT
    {
      etl::chrono::year result(y);
 
      result += ys;
 
      return result;
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year operator -(const etl::chrono::year& y, const etl::chrono::years& ys) ETL_NOEXCEPT
    {
      etl::chrono::year result(y);
 
      result -= ys;
 
      return result;
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::year operator -(const etl::chrono::years& ys, const etl::chrono::year& y) ETL_NOEXCEPT
    {
      etl::chrono::year result(y);
 
      result -= ys;
 
      return result;
    }
 
    //***********************************************************************
    //***********************************************************************
    inline ETL_CONSTEXPR14 etl::chrono::years operator -(const etl::chrono::year& y1, const etl::chrono::year& y2) ETL_NOEXCEPT
    {
      return etl::chrono::years(static_cast<int>(static_cast<unsigned>(y1)) - 
                                static_cast<int>(static_cast<unsigned>(y2)));
    }
  }
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_8BIT_TYPES
  template <>
  struct hash<etl::chrono::year>
  {
    size_t operator()(const etl::chrono::year& y) const
    {
      etl::chrono::year::rep value = static_cast<etl::chrono::year::rep>(static_cast<unsigned>(y));
      const uint8_t* p = reinterpret_cast<const uint8_t*>(&value);
 
      return etl::private_hash::generic_hash<size_t>(p, p + sizeof(value));
    }
  };
#endif
}
 
#if ETL_HAS_CHRONO_LITERALS_YEAR
namespace etl
{
  inline namespace literals
  {
    inline namespace chrono_literals
    {
      //***********************************************************************
      //***********************************************************************
#if ETL_USING_VERBOSE_CHRONO_LITERALS
      inline ETL_CONSTEXPR14 etl::chrono::year operator ""_year(unsigned long long y) ETL_NOEXCEPT
#else
      inline ETL_CONSTEXPR14 etl::chrono::year operator ""_y(unsigned long long y) ETL_NOEXCEPT
#endif
      {
        return etl::chrono::year(static_cast<int16_t>(y));
      }
    }
  }
}
#endif