chipKIT® Development Platform

Inspired by Arduino™

Last edit: 2021-03-21 22:34 by Majenko

WString

WString
Quick Look
Hardware (External hardware)
Core Wstring.h

WString is a String library for Wiring & Arduino

  1. Detailed Introduction

  2. Full library usage

    1. String

      1. Constructors

        1. String(const char *cstr = "")

        2. String(const String &str)

        3. String(char c)

        4. String(unsigned char, unsigned char base=10)

        5. String(int, unsigned char base=10)

        6. String(unsigned int, unsigned char base=10)

        7. String(long, unsigned char base=10)

        8. String(unsigned long, unsigned char base=10)

        9. String(float, unsigned char decimalPlaces=6)

        10. String(double, unsigned char decimalPlaces=6)

      2. Public Functions

        1. Memory Management

          1. reserve(unsigned int size)

          2. length(void)

        2. Concatenation

          1. concat(const String &str)

          2. concat(const char *cstr)

          3. concat(char c)

          4. concat(unsigned char c)

          5. concat(int num)

          6. concat(unsigned int num)

          7. concat(long num)

          8. concat(unsigned long num)

          9. concat(float num)

          10. concat(double num)

          11. operator +=

          12. operator +

        3. Comparison

          1. compareTo(const String &s)

          2. equals(const String &s)

          3. equals(const char *cstr)

          4. operator <nowiki>==</nowiki>

          5. operator <nowiki>!=</nowiki>

          6. operator <

          7. operator >

          8. operator <=

          9. operator >=

          10. equalsIgnoreCase(const String &s)

          11. startsWith( const String &prefix)

          12. startsWith(const String &prefix, unsigned int offset)

          13. endsWith(const String &suffix)

        4. Character Access

          1. charAt(unsigned int index)

          2. setCharAt(unsigned int index, char c)

          3. operator [] (unsigned int index)

          4. getBytes(unsigned char *buf, unsigned int bufsize, unsigned int index=0)

          5. toCharArray(char *buf, unsigned int bufsize, unsigned int index=0)

        5. Search

          1. indexOf( char ch )

          2. indexOf( char ch, unsigned int fromIndex )

          3. indexOf( const String &str )

          4. indexOf( const String &str, unsigned int fromIndex )

          5. lastIndexOf( char ch )

          6. lastIndexOf( char ch, unsigned int fromIndex )

          7. lastIndexOf( const String &str )

          8. lastIndexOf( const String &str, unsigned int fromIndex )

          9. substring( unsigned int beginIndex )

          10. substring( unsigned int beginIndex, unsigned int endIndex )

        6. Modification

          1. replace(char find, char replace)

          2. replace(const String& find, const String& replace)

          3. remove(unsigned int index)

          4. remove(unsigned int index, unsigned int count)

          5. toLowerCase(void)

          6. toUpperCase(void)

          7. trim(void)

        7. Conversion

          1. toInt(void)

          2. toFloat(void)

    2. StringSumHelper

      1. StringSumHelper(const String &s)

      2. StringSumHelper(const char *p)

      3. StringSumHelper(char c)

      4. StringSumHelper(unsigned char num)

      5. StringSumHelper(int num)

      6. StringSumHelper(unsigned int num)

      7. StringSumHelper(long num)

      8. StringSumHelper(unsigned long num)

  3. External Links

Detailed Introduction

The String Class in WString provides functions and operators for working with Strings.

Full library usage

String

Constructors

String(const char *cstr = "")

	String(const char *cstr = "");

String(const String &str)

	String(const String &str);

String(char c)

	explicit String(char c);

String(unsigned char, unsigned char base=10)

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

String(int, unsigned char base=10)

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

String(unsigned int, unsigned char base=10)

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

String(long, unsigned char base=10)

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

String(unsigned long, unsigned char base=10)

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

String(float, unsigned char decimalPlaces=6)

    explicit String(float, unsigned char decimalPlaces=6);

String(double, unsigned char decimalPlaces=6)

    explicit String(double, unsigned char decimalPlaces=6);

Public Functions

Memory Management

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

Concatenation

concat(const String &str)
	unsigned char concat(const String &str);
concat(const char *cstr)
	unsigned char concat(const char *cstr);
concat(char c)
	unsigned char concat(char c);
concat(unsigned char c)
	unsigned char concat(unsigned char c);
concat(int num)
	unsigned char concat(int num);
concat(unsigned int num)
	unsigned char concat(unsigned int num);
concat(long num)
	unsigned char concat(long num);
concat(unsigned long num)
	unsigned char concat(unsigned long num);
concat(float num)
	unsigned char concat(float num);
concat(double num)
	unsigned char concat(double num);
operator +=
	// 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);}
operator +
	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);

Comparison

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

Character Access

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

Search

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

Modification

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

Conversion

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

StringSumHelper

StringSumHelper(const String &s)

	StringSumHelper(const String &s) : String(s) {}

StringSumHelper(const char *p)

	StringSumHelper(const char *p) : String(p) {}

StringSumHelper(char c)

	StringSumHelper(char c) : String(c) {}

StringSumHelper(unsigned char num)

	StringSumHelper(unsigned char num) : String(num) {}

StringSumHelper(int num)

	StringSumHelper(int num) : String(num) {}

StringSumHelper(unsigned int num)

	StringSumHelper(unsigned int num) : String(num) {}

StringSumHelper(long num)

	StringSumHelper(long num) : String(num) {}

StringSumHelper(unsigned long num)

	StringSumHelper(unsigned long num) : String(num) {}

External Links