u8string.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_U8STRING_INCLUDED
#define ETL_U8STRING_INCLUDED
 
#include "platform.h"
#include "basic_string.h"
#include "string_view.h"
#include "hash.h"
#include "initializer_list.h"
 
#include <ctype.h>
 
#include "private/minmax_push.h"
 
#if ETL_HAS_CHAR8_T
namespace etl
{
#if ETL_USING_CPP11 && ETL_HAS_NATIVE_CHAR8_T
  inline namespace literals
  {
    inline namespace string_literals
    {
      inline constexpr etl::u8string_view operator ""_sv(const char8_t* str, size_t length) ETL_NOEXCEPT
      {
        return etl::u8string_view{ str, length };
      }
    }
  }
#endif
 
  typedef etl::ibasic_string<char8_t> iu8string;
 
  //***************************************************************************
  //***************************************************************************
  template <size_t MAX_SIZE_>
  class u8string : public iu8string
  {
  public:
 
    typedef iu8string base_type;
    typedef iu8string interface_type;
 
    typedef iu8string::value_type value_type;
 
    static ETL_CONSTANT size_t MAX_SIZE = MAX_SIZE_;
 
    //*************************************************************************
    //*************************************************************************
    u8string()
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string(const etl::u8string<MAX_SIZE_>& other)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(other);
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string(const etl::iu8string& other)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(other);
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string(const etl::iu8string& other, size_t position, size_t length = npos)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      ETL_ASSERT(position < other.size(), ETL_ERROR(string_out_of_bounds));
 
      this->initialise();
      this->assign(other, position, length);
    }
 
    //*************************************************************************
    //*************************************************************************
    ETL_EXPLICIT_STRING_FROM_CHAR u8string(const value_type* text)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(text);
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string(const value_type* text, size_t count)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(text, text + count);
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string(size_type count, value_type c)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->resize(count, c);
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    u8string(TIterator first, TIterator last, typename etl::enable_if<!etl::is_integral<TIterator>::value, int>::type = 0)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(first, last);
    }
 
#if ETL_HAS_INITIALIZER_LIST
    //*************************************************************************
    //*************************************************************************
    u8string(std::initializer_list<value_type> init)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(init.begin(), init.end());
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    explicit u8string(const etl::u8string_view& view)
      : iu8string(reinterpret_cast<value_type*>(&buffer), MAX_SIZE)
    {
      this->initialise();
      this->assign(view.begin(), view.end());
    }
 
    //*************************************************************************
    //*************************************************************************
    etl::u8string<MAX_SIZE_> substr(size_type position = 0, size_type length_ = npos) const
    {
      etl::u8string<MAX_SIZE_> new_string;
 
      if (position != this->size())
      {
        ETL_ASSERT(position < this->size(), ETL_ERROR(string_out_of_bounds));
 
        length_ = etl::min(length_, this->size() - position);
 
        new_string.assign(buffer + position, buffer + position + length_);
      }
 
      return new_string;
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string& operator = (const u8string& rhs)
    {
      if (&rhs != this)
      {
        this->assign(rhs);
      }
 
      return *this;
    }
 
 
    //*************************************************************************
    //*************************************************************************
    u8string& operator = (const iu8string& rhs)
    {
      if (&rhs != this)
      {
        this->assign(rhs);
      }
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string& operator = (const value_type* text)
    {
      this->assign(text);
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string& operator = (const etl::u8string_view& view)
    {
      this->assign(view);
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
#if ETL_HAS_ISTRING_REPAIR
    virtual void repair() ETL_OVERRIDE
#else
    void repair()
#endif
    {
      etl::iu8string::repair_buffer(buffer);
    }
 
  private:
 
    value_type buffer[MAX_SIZE + 1];
  };
 
  template <size_t MAX_SIZE_>
  ETL_CONSTANT size_t u8string<MAX_SIZE_>::MAX_SIZE;
 
  //***************************************************************************
  //***************************************************************************
  class u8string_ext : public iu8string
  {
  public:
 
    typedef iu8string base_type;
    typedef iu8string interface_type;
 
    typedef iu8string::value_type value_type;
    typedef iu8string::size_type size_type;
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      this->initialise();
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(const etl::u8string_ext& other, value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(other.data()))
      {
        this->current_size = other.size();
      }
      else
      {
        this->initialise();
        this->assign(other);
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(const etl::iu8string& other, value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(other.data()))
      {
        this->current_size = other.size();
      }
      else
      {
        this->initialise();
        this->assign(other);
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(const etl::iu8string& other, value_type* buffer, size_type buffer_size, size_type position, size_type length = npos)
      : iu8string(buffer, buffer_size - 1U)
    {
      ETL_ASSERT(position < other.size(), ETL_ERROR(string_out_of_bounds));
 
      if (this->is_within_buffer(other.data()))
      {
        this->current_size = other.size();
      }
      else
      {
        this->initialise();
        this->assign(other, position, length);
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TPointer>
    u8string_ext(TPointer text, value_type* buffer, size_type buffer_size,
                 typename etl::enable_if<etl::is_same<const value_type*, TPointer>::value, int>::type* = ETL_NULLPTR)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(text))
      {
        this->current_size = etl::strlen(buffer);
      }
      else
      {
        this->initialise();
        this->assign(text, text + etl::strlen(text));
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    template <size_t Size>
    u8string_ext(const value_type (&literal)[Size], value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(literal))
      {
        this->current_size = etl::strlen(literal);
      }
      else
      {
        this->initialise();
        this->assign(literal);
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(const value_type* text, size_type count, value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(text))
      {
        this->current_size = count;
      }
      else
      {
        this->initialise();
        this->assign(text, text + count);
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(size_type count, value_type c, value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      this->initialise();
      this->resize(count, c);
    }
 
    //*************************************************************************
    //*************************************************************************
    explicit u8string_ext(const etl::u8string_view& view, value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(view.data()))
      {
        this->current_size = view.size();
      }
      else
      {
        this->initialise();
        this->assign(view.begin(), view.end());
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TIterator>
    u8string_ext(TIterator first, TIterator last, value_type* buffer, size_type buffer_size, typename etl::enable_if<!etl::is_integral<TIterator>::value, int>::type = 0)
      : iu8string(buffer, buffer_size - 1U)
    {
      if (this->is_within_buffer(etl::addressof(*first)))
      {
        this->current_size = etl::distance(first, last);
      }
      else
      {
        this->initialise();
        this->assign(first, last);
      }     
    }
 
#if ETL_HAS_INITIALIZER_LIST
    //*************************************************************************
    //*************************************************************************
    u8string_ext(std::initializer_list<value_type> init, value_type* buffer, size_type buffer_size)
      : iu8string(buffer, buffer_size - 1U)
    {
      this->initialise();
      this->assign(init.begin(), init.end());
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext& operator = (const u8string_ext& rhs)
    {
      if (&rhs != this)
      {
        this->assign(rhs);
      }
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext& operator = (const iu8string& rhs)
    {
      if (&rhs != this)
      {
        this->assign(rhs);
      }
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext& operator = (const value_type* text)
    {
      this->assign(text);
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext& operator = (const etl::u8string_view& view)
    {
      this->assign(view);
 
      return *this;
    }
 
    //*************************************************************************
    //*************************************************************************
#if ETL_HAS_ISTRING_REPAIR
    virtual void repair() ETL_OVERRIDE
#else
    void repair()
#endif
    {
    }
 
  private:
 
    //*************************************************************************
    //*************************************************************************
    u8string_ext(const u8string_ext& other) ETL_DELETE;
  };
 
  //*************************************************************************
  //*************************************************************************
#if ETL_USING_8BIT_TYPES
#include "private/diagnostic_useless_cast_push.h"
  template <>
  struct hash<etl::iu8string>
  {
    size_t operator()(const etl::iu8string& text) const
    {
      return etl::private_hash::generic_hash<size_t>(reinterpret_cast<const uint8_t*>(text.data()),
                                                     reinterpret_cast<const uint8_t*>(text.data() + text.size()));
    }
  };
 
  template <size_t SIZE>
  struct hash<etl::u8string<SIZE> >
  {
    size_t operator()(const etl::u8string<SIZE>& text) const
    {
      return etl::private_hash::generic_hash<size_t>(reinterpret_cast<const uint8_t*>(text.data()),
                                                     reinterpret_cast<const uint8_t*>(text.data() + text.size()));
    }
  };
 
  template <>
  struct hash<etl::u8string_ext>
  {
    size_t operator()(const etl::u8string_ext& text) const
    {
      return etl::private_hash::generic_hash<size_t>(reinterpret_cast<const uint8_t*>(text.data()),
                                                     reinterpret_cast<const uint8_t*>(text.data() + text.size()));
    }
  };
#include "private/diagnostic_pop.h"
#endif
 
  //***************************************************************************
  //***************************************************************************
  template<size_t Array_Size>
  etl::u8string<Array_Size - 1U> make_string(const char(&text)[Array_Size])
  {
    return etl::u8string<Array_Size - 1U>(text, etl::strlen(text, Array_Size - 1));
  }
 
  //***************************************************************************
  //***************************************************************************
  template<size_t MAX_SIZE, size_t SIZE>
  etl::u8string<MAX_SIZE> make_string_with_capacity(const char(&text)[SIZE])
  {
    return etl::u8string<MAX_SIZE>(text, etl::strlen(text, SIZE));
  }
}
#endif
 
#include "private/minmax_pop.h"
 
#endif