String.hh

Go to the documentation of this file.

#ifndef COSA_STRING_HH
#define COSA_STRING_HH

#include "Cosa/Types.h"
#include "Cosa/IOStream.hh"

class __StringSumHelper;

class String {

  typedef void (String::*StringIfHelperType)() const;
  void StringIfHelper() const {}

public:
  String(const char *cstr = "");
  String(const String &str);
  String(str_P str);
#if (ARDUINO >= 150)
  String(String &&rval);
  String(__StringSumHelper &&rval);
#endif

  explicit String(char c);
  explicit String(unsigned char, unsigned char base=10);
  explicit String(int, unsigned char base=10);
  explicit String(unsigned int, unsigned char base=10);
  explicit String(long, unsigned char base=10);
  explicit String(unsigned long, unsigned char base=10);
  explicit String(float, unsigned char decimalPlaces=2);
  explicit String(double, unsigned char decimalPlaces=2);

  ~String(void);

  unsigned char reserve(unsigned int size);

  inline unsigned int length(void) const
  {
    return (m_length);
  }

  String& operator=(const String &rhs);
  String& operator=(const char *cstr);
  String& operator=(str_P str);

#if (ARDUINO >= 150)
  String& operator=(String &&rval);
  String& operator=(__StringSumHelper &&rval);
#endif

  unsigned char concat(const String &str);
  unsigned char concat(const char *cstr);
  unsigned char concat(char c);
  unsigned char concat(unsigned char c);
  unsigned char concat(int num);
  unsigned char concat(unsigned int num);
  unsigned char concat(long num);
  unsigned char concat(unsigned long num);
  unsigned char concat(float num);
  unsigned char concat(double num);
  unsigned char concat(str_P str);

  String& operator+=(const String &rhs) { concat(rhs); return (*this); }
  String& operator+=(const char *cstr)  { concat(cstr); return (*this); }
  String& operator+=(char c) { concat(c); return (*this); }
  String& operator+=(unsigned char num) { concat(num); return (*this); }
  String& operator+=(int num) { concat(num); return (*this); }
  String& operator+=(unsigned int num) {concat(num); return (*this); }
  String& operator+=(long num)  { concat(num); return (*this); }
  String& operator+=(unsigned long num) { concat(num); return (*this); }
  String& operator+=(float num) { concat(num); return (*this); }
  String& operator+=(double num) { concat(num); return (*this); }
  String& operator+=(str_P str) { concat(str); return (*this);}

  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, const String &rhs);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, const char *cstr);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, char c);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, unsigned char num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, int num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, unsigned int num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, long num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, unsigned long num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, float num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, double num);
  friend __StringSumHelper& operator+(const __StringSumHelper &lhs, str_P rhs);

  operator StringIfHelperType() const
  {
    return m_buffer ? &String::StringIfHelper : 0;
  }

  int compareTo(const String &s) const;
  unsigned char equals(const String &s) const;
  unsigned char equals(const char *cstr) const;
  unsigned char operator==(const String &rhs) const { return equals(rhs); }
  unsigned char operator==(const char *cstr) const { return equals(cstr); }
  unsigned char operator!=(const String &rhs) const { return !equals(rhs); }
  unsigned char operator!=(const char *cstr) const { return !equals(cstr); }
  unsigned char operator<(const String &rhs) const;
  unsigned char operator>(const String &rhs) const;
  unsigned char operator<=(const String &rhs) const;
  unsigned char operator>=(const String &rhs) const;
  unsigned char equalsIgnoreCase(const String &s) const;
  unsigned char startsWith( const String &prefix) const;
  unsigned char startsWith(const String &prefix, unsigned int offset) const;
  unsigned char endsWith(const String &suffix) const;

  char charAt(unsigned int index) const;
  void setCharAt(unsigned int index, char c);
  char operator[](unsigned int index) const;
  char& operator[](unsigned int index);
  void getBytes(unsigned char* buf, unsigned int bufsize, unsigned int index = 0) const;

  void toCharArray(char* buf, unsigned int bufsize, unsigned int index = 0) const
  {
    getBytes((unsigned char*) buf, bufsize, index);
  }

  const char* c_str() const { return (m_buffer); }

  int indexOf(char ch) const;
  int indexOf(char ch, unsigned int fromIndex) const;
  int indexOf(const String &str) const;
  int indexOf(const String &str, unsigned int fromIndex) const;
  int lastIndexOf(char ch) const;
  int lastIndexOf(char ch, unsigned int fromIndex) const;
  int lastIndexOf(const String &str) const;
  int lastIndexOf(const String &str, unsigned int fromIndex) const;

  String substring(unsigned int beginIndex, unsigned int endIndex) const;
  String substring(unsigned int beginIndex) const
  {
    return substring(beginIndex, m_length);
  };

  void replace(char find, char replace);
  void replace(const String& find, const String& replace);
  void remove(unsigned int index);
  void remove(unsigned int index, unsigned int count);
  void toLowerCase(void);
  void toUpperCase(void);
  void trim(void);

  long toInt(void) const;
  float toFloat(void) const;

protected:
  char* m_buffer;           
  unsigned int m_capacity;  
  unsigned int m_length;    

  void init(void);
  void invalidate(void);
  unsigned char changeBuffer(unsigned int maxStrLen);
  unsigned char concat(const char *cstr, unsigned int length);

  String& copy(const char *cstr, unsigned int length);
  String& copy(str_P pstr, unsigned int length);
  void move(String &rhs);
};

class __StringSumHelper : public String
{
public:
  __StringSumHelper(const String& s) : String(s) {}
  __StringSumHelper(const char* p) : String(p) {}
  __StringSumHelper(char c) : String(c) {}
  __StringSumHelper(unsigned char num) : String(num) {}
  __StringSumHelper(int num) : String(num) {}
  __StringSumHelper(unsigned int num) : String(num) {}
  __StringSumHelper(long num) : String(num) {}
  __StringSumHelper(unsigned long num) : String(num) {}
  __StringSumHelper(float num) : String(num) {}
  __StringSumHelper(double num) : String(num) {}
};

inline IOStream& operator<<(IOStream& outs, String& s)
{
  outs.print((char*) s.c_str());
  return (outs);
}
#endif