|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216 |
- /*
- WString.h - String library for Wiring & Arduino
- ...mostly rewritten by Paul Stoffregen...
- Copyright (c) 2009-10 Hernando Barragan. All right reserved.
- Copyright 2011, Paul Stoffregen, paul@pjrc.com
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2.1 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; if not, write to the Free Software
- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- */
-
- #ifndef String_class_h
- #define String_class_h
- #ifdef __cplusplus
-
- #include <stdlib.h>
- #include <string.h>
- #include <ctype.h>
- #include "avr_functions.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
-
- // Brian Cook's "no overhead" Flash String type (message on Dec 14, 2010)
- // modified by Mikal Hart for his FlashString library
- class __FlashStringHelper;
- #ifndef F
- #define F(string_literal) ((const __FlashStringHelper *)(string_literal))
- #endif
-
- // An inherited class for holding the result of a concatenation. These
- // result objects are assumed to be writable by subsequent concatenations.
- class StringSumHelper;
-
- // The string class
- class String
- {
- public:
- // constructors
- String(const char *cstr = (const char *)NULL);
- String(const __FlashStringHelper *pgmstr);
- String(const String &str);
- #if __cplusplus >= 201103L || defined(__GXX_EXPERIMENTAL_CXX0X__)
- String(String &&rval);
- String(StringSumHelper &&rval);
- #endif
- String(char c);
- String(unsigned char c);
- String(int, unsigned char base=10);
- String(unsigned int, unsigned char base=10);
- String(long, unsigned char base=10);
- String(unsigned long, unsigned char base=10);
- String(float num, unsigned char digits=2);
- String(double num, unsigned char digits=2) : String((float)num, digits) {}
- ~String(void);
-
- // memory management
- unsigned char reserve(unsigned int size);
- inline unsigned int length(void) const {return len;}
-
- // copy and move
- String & copy(const char *cstr, unsigned int length);
- String & copy(const __FlashStringHelper *s) { return copy((const char *)s, strlen((const char *)s)); }
- void move(String &rhs);
- String & operator = (const String &rhs);
- String & operator = (const char *cstr);
- String & operator = (const __FlashStringHelper *pgmstr);
- #if __cplusplus >= 201103L || defined(__GXX_EXPERIMENTAL_CXX0X__)
- String & operator = (String &&rval);
- String & operator = (StringSumHelper &&rval);
- #endif
- String & operator = (char c);
-
- // append
- String & append(const String &str);
- String & append(const char *cstr);
- String & append(const __FlashStringHelper *s) {return append((const char *)s, strlen((const char *)s)); }
- String & append(char c);
- String & append(unsigned char c) {return append((int)c);}
- String & append(int num);
- String & append(unsigned int num);
- String & append(long num);
- String & append(unsigned long num);
- String & append(float num);
- String & append(double num) {return append((float)num);}
- String & operator += (const String &rhs) {return append(rhs);}
- String & operator += (const char *cstr) {return append(cstr);}
- String & operator += (const __FlashStringHelper *pgmstr) {return append(pgmstr);}
- String & operator += (char c) {return append(c);}
- String & operator += (unsigned char c) {return append((int)c);}
- String & operator += (int num) {return append(num);}
- String & operator += (unsigned int num) {return append(num);}
- String & operator += (long num) {return append(num);}
- String & operator += (unsigned long num) {return append(num);}
- String & operator += (float num) {return append(num);}
- String & operator += (double num) {return append(num);}
-
- // concatenate
- friend StringSumHelper & operator + (const StringSumHelper &lhs, const String &rhs);
- friend StringSumHelper & operator + (const StringSumHelper &lhs, const char *cstr);
- friend StringSumHelper & operator + (const StringSumHelper &lhs, const __FlashStringHelper *pgmstr);
- friend StringSumHelper & operator + (const StringSumHelper &lhs, char c);
- friend StringSumHelper & operator + (const StringSumHelper &lhs, unsigned char c);
- 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);
- String & concat(const String &str) {return append(str);}
- String & concat(const char *cstr) {return append(cstr);}
- String & concat(const __FlashStringHelper *pgmstr) {return append(pgmstr);}
- String & concat(char c) {return append(c);}
- String & concat(unsigned char c) {return append((int)c);}
- String & concat(int num) {return append(num);}
- String & concat(unsigned int num) {return append(num);}
- String & concat(long num) {return append(num);}
- String & concat(unsigned long num) {return append(num);}
- String & concat(float num) {return append(num);}
- String & concat(double num) {return append(num);}
-
- // comparison
- int compareTo(const String &s) const;
- unsigned char equals(const String &s) const;
- unsigned char equals(const char *cstr) const;
- //unsigned char equals(const __FlashStringHelper *pgmstr) 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 __FlashStringHelper *s) const {return equals((const char *)s);}
- unsigned char operator != (const String &rhs) const {return !equals(rhs);}
- unsigned char operator != (const char *cstr) const {return !equals(cstr);}
- unsigned char operator != (const __FlashStringHelper *s) const {return !equals(s);}
- 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;
-
- protected:
- char *buffer; // the actual char array
- unsigned int capacity; // the array length minus one (for the '\0')
- unsigned int len; // the String length (not counting the '\0')
- unsigned char flags; // unused, for future features
- protected:
- void init(void);
- unsigned char changeBuffer(unsigned int maxStrLen);
- String & append(const char *cstr, unsigned int length);
- };
-
- class StringSumHelper : public String
- {
- public:
- StringSumHelper(const String &s) : String(s) {}
- StringSumHelper(const char *p) : String(p) {}
- StringSumHelper(const __FlashStringHelper *pgmstr) : String(pgmstr) {}
- StringSumHelper(char c) : String(c) {}
- StringSumHelper(unsigned char c) : String(c) {}
- StringSumHelper(int num) : String(num, 10) {}
- StringSumHelper(unsigned int num) : String(num, 10) {}
- StringSumHelper(long num) : String(num, 10) {}
- StringSumHelper(unsigned long num) : String(num, 10) {}
- };
-
- #endif // __cplusplus
- #endif // String_class_h
|