-/////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
// Name: string.h
-// Purpose: wxString class
+// Purpose: wxString and wxArrayString classes
// Author: Vadim Zeitlin
// Modified by:
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows license
-/////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_WXSTRINGH__
#define _WX_WXSTRINGH__
#include "wx/debug.h"
-/** @name wxString library
- @memo Efficient wxString class [more or less] compatible with MFC CString,
- wxWindows wxString and std::string and some handy functions
- missing from string.h.
- */
-//@{
+/*
+ Efficient string class [more or less] compatible with MFC CString,
+ wxWindows version 1 wxString and std::string and some handy functions
+ missing from string.h.
+*/
// ---------------------------------------------------------------------------
// macros
// ---------------------------------------------------------------------------
-/** @name Macros
- @memo You can switch off wxString/std::string compatibility if desired
- */
-/// compile the std::string compatibility functions
-#define STD_STRING_COMPATIBILITY
+// compile the std::string compatibility functions if defined
+#define wxSTD_STRING_COMPATIBILITY
-/// define to derive wxString from wxObject
+// define to derive wxString from wxObject
#undef WXSTRING_IS_WXOBJECT
-/// maximum possible length for a string means "take all string" everywhere
+// maximum possible length for a string means "take all string" everywhere
// (as sizeof(StringData) is unknown here we substract 100)
#define STRING_MAXLEN (UINT_MAX - 100)
// 'naughty' cast
#define WXSTRINGCAST (char *)(const char *)
-// NB: works only inside wxString class
+// implementation only
#define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) < Len() )
// ---------------------------------------------------------------------------
-/** @name Global functions complementing standard C string library
- @memo replacements for strlen() and portable strcasecmp()
- */
-// ---------------------------------------------------------------------------
-
-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+// Global functions complementing standard C string library replacements for
+// strlen() and portable strcasecmp()
+//---------------------------------------------------------------------------
-/// checks whether the passed in pointer is NULL and if the string is empty
+// checks whether the passed in pointer is NULL and if the string is empty
inline bool WXDLLEXPORT IsEmpty(const char *p) { return !p || !*p; }
-/// safe version of strlen() (returns 0 if passed NULL pointer)
-inline size_t WXDLLEXPORT Strlen(const char *psz)
+// safe version of strlen() (returns 0 if passed NULL pointer)
+inline size_t WXDLLEXPORT Strlen(const char *psz)
{ return psz ? strlen(psz) : 0; }
-/// portable strcasecmp/_stricmp
+// portable strcasecmp/_stricmp
inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2)
{
#if defined(_MSC_VER)
// global data
// ----------------------------------------------------------------------------
+WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
+
// global pointer to empty string
WXDLLEXPORT_DATA(extern const char*) g_szNul;
};
// ---------------------------------------------------------------------------
-/**
- This is (yet another one) String class for C++ programmers. It doesn't use
- any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
- thus you should be able to compile it with practicaly any C++ compiler.
- This class uses copy-on-write technique, i.e. identical strings share the
- same memory as long as neither of them is changed.
-
- This class aims to be as compatible as possible with the new standard
- std::string class, but adds some additional functions and should be
- at least as efficient than the standard implementation.
-
- Performance note: it's more efficient to write functions which take
- "const String&" arguments than "const char *" if you assign the argument
- to another string.
-
- It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
-
- To do:
- - ressource support (string tables in ressources)
- - more wide character (UNICODE) support
- - regular expressions support
-
-@memo A non-template portable wxString class implementing copy-on-write.
-@author VZ
-@version 1.3
-*/
+// This is (yet another one) String class for C++ programmers. It doesn't use
+// any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
+// thus you should be able to compile it with practicaly any C++ compiler.
+// This class uses copy-on-write technique, i.e. identical strings share the
+// same memory as long as neither of them is changed.
+//
+// This class aims to be as compatible as possible with the new standard
+// std::string class, but adds some additional functions and should be at
+// least as efficient than the standard implementation.
+//
+// Performance note: it's more efficient to write functions which take "const
+// String&" arguments than "const char *" if you assign the argument to
+// another string.
+//
+// It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
+//
+// To do:
+// - ressource support (string tables in ressources)
+// - more wide character (UNICODE) support
+// - regular expressions support
// ---------------------------------------------------------------------------
+
#ifdef WXSTRING_IS_WXOBJECT
- class WXDLLEXPORT wxString : public wxObject
- {
+class WXDLLEXPORT wxString : public wxObject
+{
DECLARE_DYNAMIC_CLASS(wxString)
#else //WXSTRING_IS_WXOBJECT
- class WXDLLEXPORT wxString
- {
+class WXDLLEXPORT wxString
+{
#endif //WXSTRING_IS_WXOBJECT
friend class WXDLLEXPORT wxArrayString;
- // NB: special care was taken in arrangin the member functions in such order
- // that all inline functions can be effectively inlined
+ // NB: special care was taken in arranging the member functions in such order
+ // that all inline functions can be effectively inlined, verify that all
+ // performace critical functions are still inlined if you change order!
private:
// points to data preceded by wxStringData structure with ref count info
char *m_pchData;
void AllocBeforeWrite(size_t);
public:
- /** @name constructors & dtor */
- //@{
- /// ctor for an empty string
+ // constructors and destructor
+ // ctor for an empty string
wxString() { Init(); }
- /// copy ctor
+ // copy ctor
wxString(const wxString& stringSrc)
{
wxASSERT( stringSrc.GetStringData()->IsValid() );
GetStringData()->Lock(); // => one more copy
}
}
- /// string containing nRepeat copies of ch
+ // string containing nRepeat copies of ch
wxString(char ch, size_t nRepeat = 1);
- /// ctor takes first nLength characters from C string
+ // ctor takes first nLength characters from C string
// (default value of STRING_MAXLEN means take all the string)
wxString(const char *psz, size_t nLength = STRING_MAXLEN)
{ InitWith(psz, 0, nLength); }
- /// from C string (for compilers using unsigned char)
+ // from C string (for compilers using unsigned char)
wxString(const unsigned char* psz, size_t nLength = STRING_MAXLEN);
- /// from wide (UNICODE) string
+ // from wide (UNICODE) string
wxString(const wchar_t *pwz);
- /// dtor is not virtual, this class must not be inherited from!
+ // dtor is not virtual, this class must not be inherited from!
~wxString() { GetStringData()->Unlock(); }
- //@}
- /** @name generic attributes & operations */
- //@{
- /// as standard strlen()
+ // generic attributes & operations
+ // as standard strlen()
size_t Len() const { return GetStringData()->nDataLength; }
- /// string contains any characters?
+ // string contains any characters?
bool IsEmpty() const { return Len() == 0; }
- /// empty string contents
+ // empty string contents
void Empty()
{
if ( !IsEmpty() )
// should be empty
wxASSERT( GetStringData()->nDataLength == 0 );
}
- /// empty the string and free memory
+ // empty the string and free memory
void Clear()
{
if ( !GetStringData()->IsEmpty() )
wxASSERT( GetStringData()->nAllocLength == 0 ); // and not own any memory
}
- /// Is an ascii value
+ // contents test
+ // Is an ascii value
bool IsAscii() const;
- /// Is a number
+ // Is a number
bool IsNumber() const;
- /// Is a word
+ // Is a word
bool IsWord() const;
- //@}
- /** @name data access (all indexes are 0 based) */
- //@{
- /// read access
+ // data access (all indexes are 0 based)
+ // read access
char GetChar(size_t n) const
{ ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
- /// read/write access
+ // read/write access
char& GetWritableChar(size_t n)
{ ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
- /// write access
+ // write access
void SetChar(size_t n, char ch)
{ ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; }
- /// get last character
+ // get last character
char Last() const
{ wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; }
- /// get writable last character
+ // get writable last character
char& Last()
{ wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; }
// on alpha-linux this gives overload problems:
// Also on Solaris, so removing for now (JACS)
#if ! defined(__ALPHA__)
- /// operator version of GetChar
+ // operator version of GetChar
char operator[](size_t n) const
{ ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
#endif
- /// operator version of GetChar
+ // operator version of GetChar
char operator[](int n) const
{ ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
- /// operator version of GetWritableChar
+ // operator version of GetWritableChar
char& operator[](size_t n)
{ ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
- /// implicit conversion to C string
+ // implicit conversion to C string
operator const char*() const { return m_pchData; }
- /// explicit conversion to C string (use this with printf()!)
+ // explicit conversion to C string (use this with printf()!)
const char* c_str() const { return m_pchData; }
- ///
+ //
const char* GetData() const { return m_pchData; }
- //@}
- /** @name overloaded assignment */
- //@{
- ///
+ // overloaded assignment
+ // from another wxString
wxString& operator=(const wxString& stringSrc);
- ///
+ // from a character
wxString& operator=(char ch);
- ///
+ // from a C string
wxString& operator=(const char *psz);
- ///
+ // from another kind of C string
wxString& operator=(const unsigned char* psz);
- ///
+ // from a wide string
wxString& operator=(const wchar_t *pwz);
- //@}
-
- /** @name string concatenation */
- //@{
- /** @name in place concatenation */
- /** @name concatenate and return the result
- left to right associativity of << allows to write
- things like "str << str1 << str2 << ..." */
- //@{
- /// as +=
+
+ // string concatenation
+ // in place concatenation
+ /*
+ Concatenate and return the result. Note that the left to right
+ associativity of << allows to write things like "str << str1 << str2
+ << ..." (unlike with +=)
+ */
+ // string += string
wxString& operator<<(const wxString& s)
{
wxASSERT( s.GetStringData()->IsValid() );
ConcatSelf(s.Len(), s);
return *this;
}
- /// as +=
+ // string += C string
wxString& operator<<(const char *psz)
{ ConcatSelf(Strlen(psz), psz); return *this; }
- /// as +=
+ // string += char
wxString& operator<<(char ch) { ConcatSelf(1, &ch); return *this; }
- //@}
- //@{
- /// string += string
+ // string += string
void operator+=(const wxString& s) { (void)operator<<(s); }
- /// string += C string
+ // string += C string
void operator+=(const char *psz) { (void)operator<<(psz); }
- /// string += char
+ // string += char
void operator+=(char ch) { (void)operator<<(ch); }
- //@}
- /** @name return resulting string */
- //@{
- ///
+ // string += C string
+ wxString& Append(const char* psz)
+ { ConcatSelf(Strlen(psz), psz); return *this; }
+ // append count copies of given character
+ wxString& Append(char ch, size_t count = 1u)
+ { wxString str(ch, count); return *this << str; }
+
+ // prepend a string, return the string itself
+ wxString& Prepend(const wxString& str)
+ { *this = str + *this; return *this; }
+
+ // non-destructive concatenation
+ //
friend wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2);
- ///
+ //
friend wxString WXDLLEXPORT operator+(const wxString& string, char ch);
- ///
+ //
friend wxString WXDLLEXPORT operator+(char ch, const wxString& string);
- ///
+ //
friend wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
- ///
+ //
friend wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
- //@}
- //@}
-
- /** @name stream-like functions */
- //@{
- /// insert an int into string
- wxString& operator<<(int i);
- /// insert a float into string
- wxString& operator<<(float f);
- /// insert a double into string
- wxString& operator<<(double d);
- //@}
+
+ // stream-like functions
+ // insert an int into string
+ wxString& operator<<(int i);
+ // insert a float into string
+ wxString& operator<<(float f);
+ // insert a double into string
+ wxString& operator<<(double d);
- /** @name string comparison */
- //@{
- /**
- case-sensitive comparison
- @return 0 if equal, +1 if greater or -1 if less
- @see CmpNoCase, IsSameAs
- */
+ // string comparison
+ // case-sensitive comparison: return 0 if =, +1 if > or -1 if <
int Cmp(const char *psz) const { return strcmp(c_str(), psz); }
- /**
- case-insensitive comparison, return code as for wxString::Cmp()
- @see: Cmp, IsSameAs
- */
+ // same as Cmp() but not case-sensitive
int CmpNoCase(const char *psz) const { return Stricmp(c_str(), psz); }
- /**
- test for string equality, case-sensitive (default) or not
- @param bCase is TRUE by default (case matters)
- @return TRUE if strings are equal, FALSE otherwise
- @see Cmp, CmpNoCase
- */
- bool IsSameAs(const char *psz, bool bCase = TRUE) const
- { return !(bCase ? Cmp(psz) : CmpNoCase(psz)); }
- //@}
-
- /** @name other standard string operations */
- //@{
- /** @name simple sub-string extraction
- */
- //@{
- /**
- return substring starting at nFirst of length
- nCount (or till the end if nCount = default value)
- */
+ // test for the string equality, either considering case or not
+ // (if compareWithCase then the case matters)
+ bool IsSameAs(const char *psz, bool compareWithCase = TRUE) const
+ { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
+
+ // simple sub-string extraction
+ // return substring starting at nFirst of length nCount (or till the end
+ // if nCount = default value)
wxString Mid(size_t nFirst, size_t nCount = STRING_MAXLEN) const;
- /// Compatibility with wxWindows 1.xx
- wxString SubString(size_t from, size_t to) const
- {
- return Mid(from, (to - from + 1));
- }
- /// get first nCount characters
+
+ // operator version of Mid()
+ wxString operator()(size_t start, size_t len) const
+ { return Mid(start, len); }
+
+ // get first nCount characters
wxString Left(size_t nCount) const;
- /// get all characters before the first occurence of ch
- /// (returns the whole string if ch not found)
- wxString Left(char ch) const;
- /// get all characters before the last occurence of ch
- /// (returns empty string if ch not found)
- wxString Before(char ch) const;
- /// get all characters after the first occurence of ch
- /// (returns empty string if ch not found)
- wxString After(char ch) const;
- /// get last nCount characters
+ // get last nCount characters
wxString Right(size_t nCount) const;
- /// get all characters after the last occurence of ch
- /// (returns the whole string if ch not found)
- wxString Right(char ch) const;
- //@}
-
- /** @name case conversion */
- //@{
- ///
+ // get all characters before the first occurence of ch
+ // (returns the whole string if ch not found)
+ wxString BeforeFirst(char ch) const;
+ // get all characters before the last occurence of ch
+ // (returns empty string if ch not found)
+ wxString BeforeLast(char ch) const;
+ // get all characters after the first occurence of ch
+ // (returns empty string if ch not found)
+ wxString AfterFirst(char ch) const;
+ // get all characters after the last occurence of ch
+ // (returns the whole string if ch not found)
+ wxString AfterLast(char ch) const;
+
+ // for compatibility only, use more explicitly named functions above
+ wxString Before(char ch) const { return BeforeLast(ch); }
+ wxString After(char ch) const { return AfterFirst(ch); }
+
+ // case conversion
+ // convert to upper case, return the string itself
wxString& MakeUpper();
- ///
+ // convert to lower case, return the string itself
wxString& MakeLower();
- //@}
- /** @name trimming/padding whitespace (either side) and truncating */
- //@{
- /// remove spaces from left or from right (default) side
+ // trimming/padding whitespace (either side) and truncating
+ // remove spaces from left or from right (default) side
wxString& Trim(bool bFromRight = TRUE);
- /// add nCount copies chPad in the beginning or at the end (default)
+ // add nCount copies chPad in the beginning or at the end (default)
wxString& Pad(size_t nCount, char chPad = ' ', bool bFromRight = TRUE);
- /// truncate string to given length
+ // truncate string to given length
wxString& Truncate(size_t uiLen);
- //@}
- /** @name searching and replacing */
- //@{
- /// searching (return starting index, or -1 if not found)
+ // searching and replacing
+ // searching (return starting index, or -1 if not found)
int Find(char ch, bool bFromEnd = FALSE) const; // like strchr/strrchr
- /// searching (return starting index, or -1 if not found)
+ // searching (return starting index, or -1 if not found)
int Find(const char *pszSub) const; // like strstr
- /**
- replace first (or all) occurences of substring with another one
- @param bReplaceAll: global replace (default) or only the first occurence
- @return the number of replacements made
- */
- size_t Replace(const char *szOld, const char *szNew, bool bReplaceAll = TRUE);
- //@}
-
- /// check if the string contents matches a mask containing '*' and '?'
+ // replace first (or all of bReplaceAll) occurences of substring with
+ // another string, returns the number of replacements made
+ size_t Replace(const char *szOld,
+ const char *szNew,
+ bool bReplaceAll = TRUE);
+
+ // check if the string contents matches a mask containing '*' and '?'
bool Matches(const char *szMask) const;
- //@}
- /** @name formated input/output */
- //@{
- /// as sprintf(), returns the number of characters written or < 0 on error
+ // formated input/output
+ // as sprintf(), returns the number of characters written or < 0 on error
int Printf(const char *pszFormat, ...);
- /// as vprintf(), returns the number of characters written or < 0 on error
+ // as vprintf(), returns the number of characters written or < 0 on error
int PrintfV(const char* pszFormat, va_list argptr);
- //@}
- /** @name raw access to string memory */
- //@{
- /// ensure that string has space for at least nLen characters
+ // raw access to string memory
+ // ensure that string has space for at least nLen characters
// only works if the data of this string is not shared
void Alloc(size_t nLen);
- /// minimize the string's memory
+ // minimize the string's memory
// only works if the data of this string is not shared
void Shrink();
- /**
- get writable buffer of at least nLen bytes.
- Unget() *must* be called a.s.a.p. to put string back in a reasonable
- state!
- */
+ // get writable buffer of at least nLen bytes. Unget() *must* be called
+ // a.s.a.p. to put string back in a reasonable state!
char *GetWriteBuf(size_t nLen);
- /// call this immediately after GetWriteBuf() has been used
+ // call this immediately after GetWriteBuf() has been used
void UngetWriteBuf();
- //@}
- /** @name wxWindows compatibility functions */
- //@{
- /// values for second parameter of CompareTo function
+ // wxWindows version 1 compatibility functions
+
+ // use Mid()
+ wxString SubString(size_t from, size_t to) const
+ { return Mid(from, (to - from + 1)); }
+ // values for second parameter of CompareTo function
enum caseCompare {exact, ignoreCase};
- /// values for first parameter of Strip function
+ // values for first parameter of Strip function
enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
- /// same as Printf()
+ // use Printf()
inline int sprintf(const char *pszFormat, ...)
{
va_list argptr;
return iLen;
}
- /// same as Cmp
+ // use Cmp()
inline int CompareTo(const char* psz, caseCompare cmp = exact) const
{ return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
- /// same as Mid (substring extraction)
- inline wxString operator()(size_t start, size_t len) const
- { return Mid(start, len); }
-
- /// same as += or <<
- inline wxString& Append(const char* psz) { return *this << psz; }
- inline wxString& Append(char ch, int count = 1)
- { wxString str(ch, count); (*this) += str; return *this; }
-
- ///
- wxString& Prepend(const wxString& str)
- { *this = str + *this; return *this; }
- /// same as Len
+ // use Len
size_t Length() const { return Len(); }
- /// Count the number of characters
+ // Count the number of characters
int Freq(char ch) const;
- /// same as MakeLower
+ // use MakeLower
void LowerCase() { MakeLower(); }
- /// same as MakeUpper
+ // use MakeUpper
void UpperCase() { MakeUpper(); }
- /// same as Trim except that it doesn't change this string
+ // use Trim except that it doesn't change this string
wxString Strip(stripType w = trailing) const;
- /// same as Find (more general variants not yet supported)
+ // use Find (more general variants not yet supported)
size_t Index(const char* psz) const { return Find(psz); }
size_t Index(char ch) const { return Find(ch); }
- /// same as Truncate
+ // use Truncate
wxString& Remove(size_t pos) { return Truncate(pos); }
wxString& RemoveLast() { return Truncate(Len() - 1); }
wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); }
+ // use Find()
int First( const char ch ) const { return Find(ch); }
int First( const char* psz ) const { return Find(psz); }
int First( const wxString &str ) const { return Find(str); }
-
int Last( const char ch ) const { return Find(ch, TRUE); }
+ bool Contains(const wxString& str) const { return Find(str) != -1; }
- /// same as IsEmpty
+ // use IsEmpty()
bool IsNull() const { return IsEmpty(); }
- //@}
-#ifdef STD_STRING_COMPATIBILITY
- /** @name std::string compatibility functions */
+#ifdef wxSTD_STRING_COMPATIBILITY
+ // std::string compatibility functions
- /// an 'invalid' value for string index
+ // an 'invalid' value for string index
static const size_t npos;
- //@{
- /** @name constructors */
- //@{
- /// take nLen chars starting at nPos
- wxString(const wxString& str, size_t nPos, size_t nLen)
- {
- wxASSERT( str.GetStringData()->IsValid() );
- InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
- }
- /// take all characters from pStart to pEnd
- wxString(const void *pStart, const void *pEnd);
- //@}
- /** @name lib.string.capacity */
- //@{
- /// return the length of the string
- size_t size() const { return Len(); }
- /// return the length of the string
- size_t length() const { return Len(); }
- /// return the maximum size of the string
- size_t max_size() const { return STRING_MAXLEN; }
- /// resize the string, filling the space with c if c != 0
- void resize(size_t nSize, char ch = '\0');
- /// delete the contents of the string
- void clear() { Empty(); }
- /// returns true if the string is empty
- bool empty() const { return IsEmpty(); }
- //@}
- /** @name lib.string.access */
- //@{
- /// return the character at position n
- char at(size_t n) const { return GetChar(n); }
- /// returns the writable character at position n
- char& at(size_t n) { return GetWritableChar(n); }
- //@}
- /** @name lib.string.modifiers */
- //@{
- /** @name append something to the end of this one */
- //@{
- /// append a string
- wxString& append(const wxString& str)
- { *this += str; return *this; }
- /// append elements str[pos], ..., str[pos+n]
- wxString& append(const wxString& str, size_t pos, size_t n)
- { ConcatSelf(n, str.c_str() + pos); return *this; }
- /// append first n (or all if n == npos) characters of sz
- wxString& append(const char *sz, size_t n = npos)
- { ConcatSelf(n == npos ? Strlen(sz) : n, sz); return *this; }
-
- /// append n copies of ch
- wxString& append(size_t n, char ch) { return Pad(n, ch); }
- //@}
-
- /** @name replaces the contents of this string with another one */
- //@{
- /// same as `this_string = str'
- wxString& assign(const wxString& str) { return (*this) = str; }
- /// same as ` = str[pos..pos + n]
- wxString& assign(const wxString& str, size_t pos, size_t n)
- { return *this = wxString((const char *)str + pos, n); }
- /// same as `= first n (or all if n == npos) characters of sz'
- wxString& assign(const char *sz, size_t n = npos)
- { return *this = wxString(sz, n); }
- /// same as `= n copies of ch'
- wxString& assign(size_t n, char ch)
- { return *this = wxString(ch, n); }
-
- //@}
-
- /** @name inserts something at position nPos into this one */
- //@{
- /// insert another string
- wxString& insert(size_t nPos, const wxString& str);
- /// insert n chars of str starting at nStart (in str)
- wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
- { return insert(nPos, wxString((const char *)str + nStart, n)); }
-
- /// insert first n (or all if n == npos) characters of sz
- wxString& insert(size_t nPos, const char *sz, size_t n = npos)
- { return insert(nPos, wxString(sz, n)); }
- /// insert n copies of ch
- wxString& insert(size_t nPos, size_t n, char ch)
- { return insert(nPos, wxString(ch, n)); }
-
- //@}
-
- /** @name deletes a part of the string */
- //@{
- /// delete characters from nStart to nStart + nLen
- wxString& erase(size_t nStart = 0, size_t nLen = npos);
- //@}
-
- /** @name replaces a substring of this string with another one */
- //@{
- /// replaces the substring of length nLen starting at nStart
- wxString& replace(size_t nStart, size_t nLen, const char* sz);
- /// replaces the substring with nCount copies of ch
- wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
- /// replaces a substring with another substring
- wxString& replace(size_t nStart, size_t nLen,
- const wxString& str, size_t nStart2, size_t nLen2);
- /// replaces the substring with first nCount chars of sz
- wxString& replace(size_t nStart, size_t nLen,
- const char* sz, size_t nCount);
- //@}
- //@}
-
- /// swap two strings
- void swap(wxString& str);
-
- /** @name string operations */
- //@{
- /** All find() functions take the nStart argument which specifies
- the position to start the search on, the default value is 0.
-
- All functions return npos if there were no match.
-
- @name string search
- */
- //@{
- /**
- @name find a match for the string/character in this string
- */
- //@{
- /// find a substring
- size_t find(const wxString& str, size_t nStart = 0) const;
-
- // VC++ 1.5 can't cope with this syntax.
-#if ! (defined(_MSC_VER) && !defined(__WIN32__))
- /// find first n characters of sz
- size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
+ // constructors
+ // take nLen chars starting at nPos
+ wxString(const wxString& str, size_t nPos, size_t nLen)
+ {
+ wxASSERT( str.GetStringData()->IsValid() );
+ InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
+ }
+ // take all characters from pStart to pEnd
+ wxString(const void *pStart, const void *pEnd);
+
+ // lib.string.capacity
+ // return the length of the string
+ size_t size() const { return Len(); }
+ // return the length of the string
+ size_t length() const { return Len(); }
+ // return the maximum size of the string
+ size_t max_size() const { return STRING_MAXLEN; }
+ // resize the string, filling the space with c if c != 0
+ void resize(size_t nSize, char ch = '\0');
+ // delete the contents of the string
+ void clear() { Empty(); }
+ // returns true if the string is empty
+ bool empty() const { return IsEmpty(); }
+
+ // lib.string.access
+ // return the character at position n
+ char at(size_t n) const { return GetChar(n); }
+ // returns the writable character at position n
+ char& at(size_t n) { return GetWritableChar(n); }
+
+ // lib.string.modifiers
+ // append a string
+ wxString& append(const wxString& str)
+ { *this += str; return *this; }
+ // append elements str[pos], ..., str[pos+n]
+ wxString& append(const wxString& str, size_t pos, size_t n)
+ { ConcatSelf(n, str.c_str() + pos); return *this; }
+ // append first n (or all if n == npos) characters of sz
+ wxString& append(const char *sz, size_t n = npos)
+ { ConcatSelf(n == npos ? Strlen(sz) : n, sz); return *this; }
+
+ // append n copies of ch
+ wxString& append(size_t n, char ch) { return Pad(n, ch); }
+
+ // same as `this_string = str'
+ wxString& assign(const wxString& str) { return (*this) = str; }
+ // same as ` = str[pos..pos + n]
+ wxString& assign(const wxString& str, size_t pos, size_t n)
+ { return *this = wxString((const char *)str + pos, n); }
+ // same as `= first n (or all if n == npos) characters of sz'
+ wxString& assign(const char *sz, size_t n = npos)
+ { return *this = wxString(sz, n); }
+ // same as `= n copies of ch'
+ wxString& assign(size_t n, char ch)
+ { return *this = wxString(ch, n); }
+
+ // insert another string
+ wxString& insert(size_t nPos, const wxString& str);
+ // insert n chars of str starting at nStart (in str)
+ wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
+ { return insert(nPos, wxString((const char *)str + nStart, n)); }
+
+ // insert first n (or all if n == npos) characters of sz
+ wxString& insert(size_t nPos, const char *sz, size_t n = npos)
+ { return insert(nPos, wxString(sz, n)); }
+ // insert n copies of ch
+ wxString& insert(size_t nPos, size_t n, char ch)
+ { return insert(nPos, wxString(ch, n)); }
+
+ // delete characters from nStart to nStart + nLen
+ wxString& erase(size_t nStart = 0, size_t nLen = npos);
+
+ // replaces the substring of length nLen starting at nStart
+ wxString& replace(size_t nStart, size_t nLen, const char* sz);
+ // replaces the substring with nCount copies of ch
+ wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
+ // replaces a substring with another substring
+ wxString& replace(size_t nStart, size_t nLen,
+ const wxString& str, size_t nStart2, size_t nLen2);
+ // replaces the substring with first nCount chars of sz
+ wxString& replace(size_t nStart, size_t nLen,
+ const char* sz, size_t nCount);
+
+ // swap two strings
+ void swap(wxString& str);
+
+ // All find() functions take the nStart argument which specifies the
+ // position to start the search on, the default value is 0. All functions
+ // return npos if there were no match.
+
+ // find a substring
+ size_t find(const wxString& str, size_t nStart = 0) const;
+
+ // VC++ 1.5 can't cope with this syntax.
+#if !(defined(_MSC_VER) && !defined(__WIN32__))
+ // find first n characters of sz
+ size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
#endif
- // Gives a duplicate symbol (presumably a case-insensitivity problem)
+
+ // Gives a duplicate symbol (presumably a case-insensitivity problem)
#if !defined(__BORLANDC__)
- /// find the first occurence of character ch after nStart
- size_t find(char ch, size_t nStart = 0) const;
+ // find the first occurence of character ch after nStart
+ size_t find(char ch, size_t nStart = 0) const;
#endif
- // wxWin compatibility
- inline bool Contains(const wxString& str) const { return Find(str) != -1; }
-
- //@}
-
- /**
- @name rfind() family is exactly like find() but works right to left
- */
- //@{
- /// as find, but from the end
- size_t rfind(const wxString& str, size_t nStart = npos) const;
- /// as find, but from the end
- // VC++ 1.5 can't cope with this syntax.
+ // rfind() family is exactly like find() but works right to left
+
+ // as find, but from the end
+ size_t rfind(const wxString& str, size_t nStart = npos) const;
+
+ // VC++ 1.5 can't cope with this syntax.
#if ! (defined(_MSC_VER) && !defined(__WIN32__))
- size_t rfind(const char* sz, size_t nStart = npos,
- size_t n = npos) const;
- /// as find, but from the end
- size_t rfind(char ch, size_t nStart = npos) const;
-#endif
- //@}
-
- /**
- @name find first/last occurence of any character in the set
- */
- //@{
- ///
- size_t find_first_of(const wxString& str, size_t nStart = 0) const;
- ///
- size_t find_first_of(const char* sz, size_t nStart = 0) const;
- /// same as find(char, size_t)
- size_t find_first_of(char c, size_t nStart = 0) const;
-
- ///
- size_t find_last_of (const wxString& str, size_t nStart = npos) const;
- ///
- size_t find_last_of (const char* s, size_t nStart = npos) const;
- /// same as rfind(char, size_t)
- size_t find_last_of (char c, size_t nStart = npos) const;
- //@}
-
- /**
- @name find first/last occurence of any character not in the set
- */
- //@{
- ///
- size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
- ///
- size_t find_first_not_of(const char* s, size_t nStart = 0) const;
- ///
- size_t find_first_not_of(char ch, size_t nStart = 0) const;
-
- ///
- size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
- ///
- size_t find_last_not_of(const char* s, size_t nStart = npos) const;
- ///
- size_t find_last_not_of(char ch, size_t nStart = npos) const;
- //@}
- //@}
-
- /**
- All compare functions return -1, 0 or 1 if the [sub]string
- is less, equal or greater than the compare() argument.
-
- @name comparison
- */
- //@{
- /// just like strcmp()
- int compare(const wxString& str) const { return Cmp(str); }
- /// comparison with a substring
- int compare(size_t nStart, size_t nLen, const wxString& str) const;
- /// comparison of 2 substrings
- int compare(size_t nStart, size_t nLen,
- const wxString& str, size_t nStart2, size_t nLen2) const;
- /// just like strcmp()
- int compare(const char* sz) const { return Cmp(sz); }
- /// substring comparison with first nCount characters of sz
- int compare(size_t nStart, size_t nLen,
- const char* sz, size_t nCount = npos) const;
- //@}
- wxString substr(size_t nStart = 0, size_t nLen = npos) const;
- //@}
+ // as find, but from the end
+ size_t rfind(const char* sz, size_t nStart = npos,
+ size_t n = npos) const;
+ // as find, but from the end
+ size_t rfind(char ch, size_t nStart = npos) const;
#endif
+
+ // find first/last occurence of any character in the set
+
+ //
+ size_t find_first_of(const wxString& str, size_t nStart = 0) const;
+ //
+ size_t find_first_of(const char* sz, size_t nStart = 0) const;
+ // same as find(char, size_t)
+ size_t find_first_of(char c, size_t nStart = 0) const;
+ //
+ size_t find_last_of (const wxString& str, size_t nStart = npos) const;
+ //
+ size_t find_last_of (const char* s, size_t nStart = npos) const;
+ // same as rfind(char, size_t)
+ size_t find_last_of (char c, size_t nStart = npos) const;
+
+ // find first/last occurence of any character not in the set
+
+ //
+ size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
+ //
+ size_t find_first_not_of(const char* s, size_t nStart = 0) const;
+ //
+ size_t find_first_not_of(char ch, size_t nStart = 0) const;
+ //
+ size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
+ //
+ size_t find_last_not_of(const char* s, size_t nStart = npos) const;
+ //
+ size_t find_last_not_of(char ch, size_t nStart = npos) const;
+
+ // All compare functions return -1, 0 or 1 if the [sub]string is less,
+ // equal or greater than the compare() argument.
+
+ // just like strcmp()
+ int compare(const wxString& str) const { return Cmp(str); }
+ // comparison with a substring
+ int compare(size_t nStart, size_t nLen, const wxString& str) const;
+ // comparison of 2 substrings
+ int compare(size_t nStart, size_t nLen,
+ const wxString& str, size_t nStart2, size_t nLen2) const;
+ // just like strcmp()
+ int compare(const char* sz) const { return Cmp(sz); }
+ // substring comparison with first nCount characters of sz
+ int compare(size_t nStart, size_t nLen,
+ const char* sz, size_t nCount = npos) const;
+
+ // substring extraction
+ wxString substr(size_t nStart = 0, size_t nLen = npos) const;
+#endif // wxSTD_STRING_COMPATIBILITY
};
// ----------------------------------------------------------------------------
-/** The string array uses it's knowledge of internal structure of the String
- class to optimize string storage. Normally, we would store pointers to
- string, but as String is, in fact, itself a pointer (sizeof(String) is
- sizeof(char *)) we store these pointers instead. The cast to "String *"
- is really all we need to turn such pointer into a string!
-
- Of course, it can be called a dirty hack, but we use twice less memory
- and this approach is also more speed efficient, so it's probably worth it.
-
- Usage notes: when a string is added/inserted, a new copy of it is created,
- so the original string may be safely deleted. When a string is retrieved
- from the array (operator[] or Item() method), a reference is returned.
-
- @name wxArrayString
- @memo probably the most commonly used array type - array of strings
- */
+// The string array uses it's knowledge of internal structure of the wxString
+// class to optimize string storage. Normally, we would store pointers to
+// string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
+// sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
+// really all we need to turn such pointer into a string!
+//
+// Of course, it can be called a dirty hack, but we use twice less memory and
+// this approach is also more speed efficient, so it's probably worth it.
+//
+// Usage notes: when a string is added/inserted, a new copy of it is created,
+// so the original string may be safely deleted. When a string is retrieved
+// from the array (operator[] or Item() method), a reference is returned.
// ----------------------------------------------------------------------------
class WXDLLEXPORT wxArrayString
{
public:
- /** @name ctors and dtor */
- //@{
- /// default ctor
+ // constructors and destructor
+ // default ctor
wxArrayString();
- /// copy ctor
+ // copy ctor
wxArrayString(const wxArrayString& array);
- /// assignment operator
+ // assignment operator
wxArrayString& operator=(const wxArrayString& src);
- /// not virtual, this class can't be derived from
+ // not virtual, this class should not be derived from
~wxArrayString();
- //@}
- /** @name memory management */
- //@{
- /// empties the list, but doesn't release memory
+ // memory management
+ // empties the list, but doesn't release memory
void Empty();
- /// empties the list and releases memory
+ // empties the list and releases memory
void Clear();
- /// preallocates memory for given number of items
+ // preallocates memory for given number of items
void Alloc(size_t nCount);
- /// minimzes the memory usage (by freeing all extra memory)
+ // minimzes the memory usage (by freeing all extra memory)
void Shrink();
- //@}
-
- /** @name simple accessors */
- //@{
- /// number of elements in the array
- size_t Count() const { return m_nCount; }
- /// is it empty?
- bool IsEmpty() const { return m_nCount == 0; }
- //@}
-
- /** @name items access (range checking is done in debug version) */
- //@{
- /// get item at position uiIndex
+
+ // simple accessors
+ // number of elements in the array
+ size_t GetCount() const { return m_nCount; }
+ // is it empty?
+ bool IsEmpty() const { return m_nCount == 0; }
+ // number of elements in the array (GetCount is preferred API)
+ size_t Count() const { return m_nCount; }
+
+ // items access (range checking is done in debug version)
+ // get item at position uiIndex
wxString& Item(size_t nIndex) const
{ wxASSERT( nIndex < m_nCount ); return *(wxString *)&(m_pItems[nIndex]); }
- /// same as Item()
+ // same as Item()
wxString& operator[](size_t nIndex) const { return Item(nIndex); }
- /// get last item
+ // get last item
wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
- //@}
-
- /** @name item management */
- //@{
- /**
- Search the element in the array, starting from the either side
- @param if bFromEnd reverse search direction
- @param if bCase, comparison is case sensitive (default)
- @return index of the first item matched or NOT_FOUND
- @see NOT_FOUND
- */
+
+ // item management
+ // Search the element in the array, starting from the beginning if
+ // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
+ // sensitive (default). Returns index of the first item matched or
+ // wxNOT_FOUND
int Index (const char *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
- /// add new element at the end
- void Add (const wxString& str);
- /// add new element at given position
+ // add new element at the end
+ void Add(const wxString& str);
+ // add new element at given position
void Insert(const wxString& str, size_t uiIndex);
- /// remove first item matching this value
+ // remove first item matching this value
void Remove(const char *sz);
- /// remove item by index
+ // remove item by index
void Remove(size_t nIndex);
- //@}
- /// sort array elements
+ // sort array elements
void Sort(bool bCase = TRUE, bool bReverse = FALSE);
private:
void Grow(); // makes array bigger if needed
void Free(); // free the string stored
- size_t m_nSize, // current size of the array
+ size_t m_nSize, // current size of the array
m_nCount; // current number of elements
char **m_pItems; // pointer to data
};
// ---------------------------------------------------------------------------
-/** @name wxString comparison functions
- @memo Comparisons are case sensitive
- */
+// wxString comparison functions: operator versions are always case sensitive
// ---------------------------------------------------------------------------
-//@{
+//
inline bool operator==(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) == 0; }
-///
+//
inline bool operator==(const wxString& s1, const char * s2) { return s1.Cmp(s2) == 0; }
-///
+//
inline bool operator==(const char * s1, const wxString& s2) { return s2.Cmp(s1) == 0; }
-///
+//
inline bool operator!=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) != 0; }
-///
+//
inline bool operator!=(const wxString& s1, const char * s2) { return s1.Cmp(s2) != 0; }
-///
+//
inline bool operator!=(const char * s1, const wxString& s2) { return s2.Cmp(s1) != 0; }
-///
+//
inline bool operator< (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) < 0; }
-///
+//
inline bool operator< (const wxString& s1, const char * s2) { return s1.Cmp(s2) < 0; }
-///
+//
inline bool operator< (const char * s1, const wxString& s2) { return s2.Cmp(s1) > 0; }
-///
+//
inline bool operator> (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) > 0; }
-///
+//
inline bool operator> (const wxString& s1, const char * s2) { return s1.Cmp(s2) > 0; }
-///
+//
inline bool operator> (const char * s1, const wxString& s2) { return s2.Cmp(s1) < 0; }
-///
+//
inline bool operator<=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) <= 0; }
-///
+//
inline bool operator<=(const wxString& s1, const char * s2) { return s1.Cmp(s2) <= 0; }
-///
+//
inline bool operator<=(const char * s1, const wxString& s2) { return s2.Cmp(s1) >= 0; }
-///
+//
inline bool operator>=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) >= 0; }
-///
+//
inline bool operator>=(const wxString& s1, const char * s2) { return s1.Cmp(s2) >= 0; }
-///
+//
inline bool operator>=(const char * s1, const wxString& s2) { return s2.Cmp(s1) <= 0; }
-//@}
+
wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2);
wxString WXDLLEXPORT operator+(const wxString& string, char ch);
wxString WXDLLEXPORT operator+(char ch, const wxString& string);
wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
// ---------------------------------------------------------------------------
-/** @name Global functions complementing standard C string library
- @memo replacements for strlen() and portable strcasecmp()
- */
+// Implementation only from here until the end of file
// ---------------------------------------------------------------------------
-#ifdef STD_STRING_COMPATIBILITY
+#ifdef wxSTD_STRING_COMPATIBILITY
-// fwd decl
+// forward declare iostream
// Known not to work with wxUSE_IOSTREAMH set to 0, so
// replacing with includes (on advice of ungod@pasdex.com.au)
// class WXDLLEXPORT istream;
WXDLLEXPORT istream& operator>>(istream& is, wxString& str);
-#endif //std::string compatibility
+#endif // wxSTD_STRING_COMPATIBILITY
#endif // _WX_WXSTRINGH__
-
-//@}
projects / wxWidgets.git / commitdiff
