spark_wiring_string.h

#ifndef String_class_h
#define String_class_h
//#ifdef __cplusplus

#include <stdarg.h>
#include "spark_wiring_print.h" // for HEX, DEC ... constants
#include "spark_wiring_printable.h"

// When compiling programs with this class, the following gcc parameters
// dramatically increase performance and memory (RAM) efficiency, typically
// with little or no increase in code size.
//     -felide-constructors
//     -std=c++0x

class __FlashStringHelper;
#define F(X) (X)

// An inherited class for holding the result of a concatenation.  These
// result objects are assumed to be writable by subsequent concatenations.
class StringSumHelper;


class String
{
    // use a function pointer to allow for "if (s)" without the
    // complications of an operator bool(). for more information, see:
    // http://www.artima.com/cppsource/safebool.html
    typedef void (String::*StringIfHelperType)() const;
    void StringIfHelper() const {}

public:
    // constructors
    // creates a copy of the initial value.
    // if the initial value is null or invalid, or if memory allocation
    // fails, the string will be marked as invalid (i.e. "if (s)" will
    // be false).

    String(const char *cstr = "");

    String(const char *cstr, unsigned int length);

    String(const String &str);

#ifndef DOXYGEN_DO_NOT_DOCUMENT
    String(const __FlashStringHelper *pstr);
#endif

        String(const Printable& printable);
    #ifdef __GXX_EXPERIMENTAL_CXX0X__
    String(String &&rval);
    String(StringSumHelper &&rval);
    #endif

    explicit String(char c);

    explicit String(unsigned char b, unsigned char base=10);

    explicit String(int value, unsigned char base=10);

    explicit String(unsigned int value, unsigned char base=10);

    explicit String(long value, unsigned char base=10);

    explicit String(unsigned long value, unsigned char base=10);

    explicit String(float value, int decimalPlaces=6);

    explicit String(double value, int decimalPlaces=6);

    ~String(void);

    // memory management
    // return true on success, false on failure (in which case, the string
    // is left unchanged).  reserve(0), if successful, will validate an
    // invalid string (i.e., "if (s)" will be true afterwards)

    unsigned char reserve(unsigned int size);

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

    // creates a copy of the assigned value.  if the value is null or
    // invalid, or if the memory allocation fails, the string will be
    // marked as invalid ("if (s)" will be false).

    String & operator = (const String &rhs);

    String & operator = (const char *cstr);

#ifndef DOXYGEN_DO_NOT_DOCUMENT
    String & operator = (const __FlashStringHelper *pstr);
#endif
    #ifdef __GXX_EXPERIMENTAL_CXX0X__
    String & operator = (String &&rval);
    String & operator = (StringSumHelper &&rval);
    #endif

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

    // concatenate (works w/ built-in types)

    // returns true on success, false on failure (in which case, the string
    // is left unchanged).  if the argument is null or invalid, the
    // concatenation is considered unsucessful.

    unsigned char concat(const String &str);

    unsigned char concat(const char *cstr);
#ifndef DOXYGEN_DO_NOT_DOCUMENT
    unsigned char concat(const __FlashStringHelper * str);
#endif

    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);

    // if there's not enough memory for the concatenated value, the string
    // will be left unchanged (but this isn't signalled in any way)

    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);}

    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);

#ifndef DOXYGEN_DO_NOT_DOCUMENT
    // comparison (only works w/ Strings and "strings")
    operator StringIfHelperType() const { return buffer ? &String::StringIfHelper : 0; }
#endif

    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;

    // character acccess


    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 buffer; }

    // search

    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 ) const;

    String substring( unsigned int beginIndex, unsigned int endIndex ) const;

    // modification

    String& replace(char find, char replace);

    String& replace(const String& find, const String& replace);

    String& remove(unsigned int index);

    String& remove(unsigned int index, unsigned int count);

    String& toLowerCase(void);

    String& toUpperCase(void);

    String& trim(void);

    // parsing/conversion
    long toInt(void) const;

    float toFloat(void) const;

    static String format(const char* format, ...);

protected:
    char *buffer;           
    unsigned int capacity;  
    unsigned int len;       
    unsigned char flags;    
protected:
#ifndef DOXYGEN_DO_NOT_DOCUMENT
    void init(void);
    void invalidate(void);
    unsigned char changeBuffer(unsigned int maxStrLen);
    unsigned char concat(const char *cstr, unsigned int length);

    // copy and move
    String & copy(const char *cstr, unsigned int length);
    String & copy(const __FlashStringHelper *pstr, unsigned int length);
#endif

    #ifdef __GXX_EXPERIMENTAL_CXX0X__
    void move(String &rhs);
    #endif

        friend class StringPrintableHelper;

};

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) {}
};

#ifndef DOXYGEN_DO_NOT_DOCUMENT
#include <ostream>
std::ostream& operator << ( std::ostream& os, const String& value );
#endif


//#endif  // __cplusplus
#endif  // String_class_h