ls-standard-library/include/ls_std/boxing/String.hpp

/*
 * Author:          Patrick-Christopher Mattulat
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2020-08-14
 * Changed:         2021-05-01
 *
 * */

#ifndef LS_STD_STRING_HPP
#define LS_STD_STRING_HPP

#include "IBoxing.hpp"
#include <ls_std/base/Class.hpp>
#include <ls_std/serialization/ISerializable.hpp>
#include <ls_std/io/IStorable.hpp>
#include <string>
#include <memory>
#include <vector>

namespace ls_std
{
  class String : public ls_std::Class, public ls_std::IBoxing, public ls_std::ISerializable, public ls_std::IStorable
  {
    public:

      String();
      explicit String(std::string _value);
      ~String() override = default;

      // conversion operator

      operator const char *() const; // do not make explicit!
      operator std::string() const; // do not make explicit!

      // assignment operators

      ls_std::String &operator=(std::string _value);

      // arithmetic operators

      std::string operator+(ls_std::String _string) const;
      std::string operator+(const std::string &_string) const;
      std::string operator+(const char *_string) const;
      std::string operator-(int _number);

      // compound operators

      ls_std::String &operator+=(ls_std::String _string);
      ls_std::String &operator+=(const std::string &_text);

      // comparison operators

      bool operator==(ls_std::String _string);
      bool operator==(const std::string &_value);
      bool operator==(const char *_value);
      bool operator!=(ls_std::String _string);
      bool operator!=(const std::string &_value);
      bool operator!=(const char *_value);

      // implementation

      ls_std::byte_field load() override;
      ls_std::byte_field marshal() override;
      void parse(std::string _parseText) override;
      void save(const ls_std::byte_field &_data) override;
      std::string toString() override;
      void unmarshal(const ls_std::byte_field &_data) override;

      // additional functionality

      bool contains(const std::string &_text);
      bool endsWith(const std::string &_text);
      bool equalsIgnoreCase(ls_std::String _string);
      bool equalsIgnoreCase(std::string _text);
      std::vector<ls_std::byte> getByteData();
      std::string padLeft(size_t _width, char _fillCharacter);
      std::string padRight(size_t _width, char _fillCharacter);
      std::string reverse();
      void setSerializable(std::shared_ptr<ls_std::ISerializable> _serializable);
      void setStorable(std::shared_ptr<ls_std::IStorable> _storable);
      bool startsWith(const std::string &_text);
      std::string toLowerCase();
      std::string toUpperCase();

    private:

      std::shared_ptr<ls_std::ISerializable> serializable{};
      std::shared_ptr<ls_std::IStorable> storable{};
      std::string value{};

      static std::string _buildCharacterChain(size_t _amount, char _fillCharacter);
      static std::string _createFillContent(const std::string &_text, size_t _width, char _fillCharacter);
  };
}

#endif