1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxString and wxArrayString classes
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
13 Efficient string class [more or less] compatible with MFC CString,
14 wxWindows version 1 wxString and std::string and some handy functions
15 missing from string.h.
18 #ifndef _WX_WXSTRINGH__
19 #define _WX_WXSTRINGH__
22 #pragma interface "string.h"
25 // ----------------------------------------------------------------------------
26 // conditinal compilation
27 // ----------------------------------------------------------------------------
29 // compile the std::string compatibility functions if defined
30 #define wxSTD_STRING_COMPATIBILITY
32 // define to derive wxString from wxObject (deprecated!)
33 #ifdef WXSTRING_IS_WXOBJECT
34 #undef WXSTRING_IS_WXOBJECT
37 // ----------------------------------------------------------------------------
39 // ----------------------------------------------------------------------------
56 #include <strings.h> // for strcasecmp()
59 #include "wx/defs.h" // everybody should include this
60 #include "wx/debug.h" // for wxASSERT()
61 #include "wx/wxchar.h" // for wxChar
62 #include "wx/buffer.h" // for wxCharBuffer
63 #include "wx/strconv.h" // for wxConvertXXX() macros and wxMBConv classes
66 #ifdef WXSTRING_IS_WXOBJECT
67 #include "wx/object.h" // base class
71 // ---------------------------------------------------------------------------
73 // ---------------------------------------------------------------------------
76 #define WXSTRINGCAST (wxChar *)(const wxChar *)
77 #define wxCSTRINGCAST (wxChar *)(const wxChar *)
78 #define wxMBSTRINGCAST (char *)(const char *)
79 #define wxWCSTRINGCAST (wchar_t *)(const wchar_t *)
81 // implementation only
82 #define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
84 // ----------------------------------------------------------------------------
86 // ----------------------------------------------------------------------------
88 // maximum possible length for a string means "take all string" everywhere
89 // (as sizeof(StringData) is unknown here, we substract 100)
90 const unsigned int wxSTRING_MAXLEN
= UINT_MAX
- 100;
92 // ----------------------------------------------------------------------------
94 // ----------------------------------------------------------------------------
96 // global pointer to empty string
97 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
99 // ---------------------------------------------------------------------------
100 // global functions complementing standard C string library replacements for
101 // strlen() and portable strcasecmp()
102 //---------------------------------------------------------------------------
104 // Use wxXXX() functions from wxchar.h instead! These functions are for
105 // backwards compatibility only.
107 // checks whether the passed in pointer is NULL and if the string is empty
108 inline bool WXDLLEXPORT
IsEmpty(const char *p
) { return (!p
|| !*p
); }
110 // safe version of strlen() (returns 0 if passed NULL pointer)
111 inline size_t WXDLLEXPORT
Strlen(const char *psz
)
112 { return psz
? strlen(psz
) : 0; }
114 // portable strcasecmp/_stricmp
115 inline int WXDLLEXPORT
Stricmp(const char *psz1
, const char *psz2
)
117 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
118 return _stricmp(psz1
, psz2
);
119 #elif defined(__SC__)
120 return _stricmp(psz1
, psz2
);
121 #elif defined(__SALFORDC__)
122 return stricmp(psz1
, psz2
);
123 #elif defined(__BORLANDC__)
124 return stricmp(psz1
, psz2
);
125 #elif defined(__WATCOMC__)
126 return stricmp(psz1
, psz2
);
127 #elif defined(__EMX__)
128 return stricmp(psz1
, psz2
);
129 #elif defined(__WXPM__)
130 return stricmp(psz1
, psz2
);
131 #elif defined(__UNIX__) || defined(__GNUWIN32__)
132 return strcasecmp(psz1
, psz2
);
133 #elif defined(__MWERKS__) && !defined(__INTEL__)
134 register char c1
, c2
;
136 c1
= tolower(*psz1
++);
137 c2
= tolower(*psz2
++);
138 } while ( c1
&& (c1
== c2
) );
142 // almost all compilers/libraries provide this function (unfortunately under
143 // different names), that's why we don't implement our own which will surely
144 // be more efficient than this code (uncomment to use):
146 register char c1, c2;
148 c1 = tolower(*psz1++);
149 c2 = tolower(*psz2++);
150 } while ( c1 && (c1 == c2) );
155 #error "Please define string case-insensitive compare for your OS/compiler"
156 #endif // OS/compiler
159 // return an empty wxString
160 class WXDLLEXPORT wxString
; // not yet defined
161 inline const wxString
& wxGetEmptyString() { return *(wxString
*)&wxEmptyString
; }
163 // ---------------------------------------------------------------------------
164 // string data prepended with some housekeeping info (used by wxString class),
165 // is never used directly (but had to be put here to allow inlining)
166 // ---------------------------------------------------------------------------
168 struct WXDLLEXPORT wxStringData
170 int nRefs
; // reference count
171 size_t nDataLength
, // actual string length
172 nAllocLength
; // allocated memory size
174 // mimics declaration 'wxChar data[nAllocLength]'
175 wxChar
* data() const { return (wxChar
*)(this + 1); }
177 // empty string has a special ref count so it's never deleted
178 bool IsEmpty() const { return (nRefs
== -1); }
179 bool IsShared() const { return (nRefs
> 1); }
182 void Lock() { if ( !IsEmpty() ) nRefs
++; }
183 void Unlock() { if ( !IsEmpty() && --nRefs
== 0) free(this); }
185 // if we had taken control over string memory (GetWriteBuf), it's
186 // intentionally put in invalid state
187 void Validate(bool b
) { nRefs
= (b
? 1 : 0); }
188 bool IsValid() const { return (nRefs
!= 0); }
191 // ---------------------------------------------------------------------------
192 // This is (yet another one) String class for C++ programmers. It doesn't use
193 // any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
194 // thus you should be able to compile it with practicaly any C++ compiler.
195 // This class uses copy-on-write technique, i.e. identical strings share the
196 // same memory as long as neither of them is changed.
198 // This class aims to be as compatible as possible with the new standard
199 // std::string class, but adds some additional functions and should be at
200 // least as efficient than the standard implementation.
202 // Performance note: it's more efficient to write functions which take "const
203 // String&" arguments than "const char *" if you assign the argument to
206 // It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
209 // - ressource support (string tables in ressources)
210 // - more wide character (UNICODE) support
211 // - regular expressions support
212 // ---------------------------------------------------------------------------
214 #ifdef WXSTRING_IS_WXOBJECT
215 class WXDLLEXPORT wxString
: public wxObject
217 DECLARE_DYNAMIC_CLASS(wxString
)
218 #else //WXSTRING_IS_WXOBJECT
219 class WXDLLEXPORT wxString
221 #endif //WXSTRING_IS_WXOBJECT
223 friend class WXDLLEXPORT wxArrayString
;
225 // NB: special care was taken in arranging the member functions in such order
226 // that all inline functions can be effectively inlined, verify that all
227 // performace critical functions are still inlined if you change order!
229 // points to data preceded by wxStringData structure with ref count info
232 // accessor to string data
233 wxStringData
* GetStringData() const { return (wxStringData
*)m_pchData
- 1; }
235 // string (re)initialization functions
236 // initializes the string to the empty value (must be called only from
237 // ctors, use Reinit() otherwise)
238 void Init() { m_pchData
= (wxChar
*)wxEmptyString
; }
239 // initializaes the string with (a part of) C-string
240 void InitWith(const wxChar
*psz
, size_t nPos
= 0, size_t nLen
= wxSTRING_MAXLEN
);
241 // as Init, but also frees old data
242 void Reinit() { GetStringData()->Unlock(); Init(); }
245 // allocates memory for string of lenght nLen
246 void AllocBuffer(size_t nLen
);
247 // copies data to another string
248 void AllocCopy(wxString
&, int, int) const;
249 // effectively copies data to string
250 void AssignCopy(size_t, const wxChar
*);
252 // append a (sub)string
253 void ConcatSelf(int nLen
, const wxChar
*src
);
255 // functions called before writing to the string: they copy it if there
256 // are other references to our data (should be the only owner when writing)
257 void CopyBeforeWrite();
258 void AllocBeforeWrite(size_t);
260 // this method is not implemented - there is _no_ conversion from int to
261 // string, you're doing something wrong if the compiler wants to call it!
263 // try `s << i' or `s.Printf("%d", i)' instead
268 // constructors and destructor
269 // ctor for an empty string
270 wxString() { Init(); }
272 wxString(const wxString
& stringSrc
)
274 wxASSERT( stringSrc
.GetStringData()->IsValid() );
276 if ( stringSrc
.IsEmpty() ) {
277 // nothing to do for an empty string
281 m_pchData
= stringSrc
.m_pchData
; // share same data
282 GetStringData()->Lock(); // => one more copy
285 // string containing nRepeat copies of ch
286 wxString(wxChar ch
, size_t nRepeat
= 1);
287 // ctor takes first nLength characters from C string
288 // (default value of wxSTRING_MAXLEN means take all the string)
289 wxString(const wxChar
*psz
, size_t nLength
= wxSTRING_MAXLEN
)
290 { InitWith(psz
, 0, nLength
); }
293 // from multibyte string
294 // (NB: nLength is right now number of Unicode characters, not
295 // characters in psz! So try not to use it yet!)
296 wxString(const char *psz
, wxMBConv
& conv
= wxConvLibc
, size_t nLength
= wxSTRING_MAXLEN
);
297 // from wxWCharBuffer (i.e. return from wxGetString)
298 wxString(const wxWCharBuffer
& psz
)
299 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
301 // from C string (for compilers using unsigned char)
302 wxString(const unsigned char* psz
, size_t nLength
= wxSTRING_MAXLEN
)
303 { InitWith((const char*)psz
, 0, nLength
); }
304 // from multibyte string
305 wxString(const char *psz
, wxMBConv
& WXUNUSED(conv
), size_t nLength
= wxSTRING_MAXLEN
)
306 { InitWith(psz
, 0, nLength
); }
309 // from wide (Unicode) string
310 wxString(const wchar_t *pwz
);
311 #endif // !wxUSE_WCHAR_T
314 wxString(const wxCharBuffer
& psz
)
315 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
316 #endif // Unicode/ANSI
318 // dtor is not virtual, this class must not be inherited from!
319 ~wxString() { GetStringData()->Unlock(); }
321 // generic attributes & operations
322 // as standard strlen()
323 size_t Len() const { return GetStringData()->nDataLength
; }
324 // string contains any characters?
325 bool IsEmpty() const { return Len() == 0; }
326 // empty string is "FALSE", so !str will return TRUE
327 bool operator!() const { return IsEmpty(); }
328 // empty string contents
335 wxASSERT( GetStringData()->nDataLength
== 0 );
337 // empty the string and free memory
340 if ( !GetStringData()->IsEmpty() )
343 wxASSERT( GetStringData()->nDataLength
== 0 ); // should be empty
344 wxASSERT( GetStringData()->nAllocLength
== 0 ); // and not own any memory
349 bool IsAscii() const;
351 bool IsNumber() const;
355 // data access (all indexes are 0 based)
357 wxChar
GetChar(size_t n
) const
358 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
360 wxChar
& GetWritableChar(size_t n
)
361 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
363 void SetChar(size_t n
, wxChar ch
)
364 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); m_pchData
[n
] = ch
; }
366 // get last character
368 { wxASSERT( !IsEmpty() ); return m_pchData
[Len() - 1]; }
369 // get writable last character
371 { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData
[Len()-1]; }
373 // operator version of GetChar
374 wxChar
operator[](size_t n
) const
375 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
377 // operator version of GetChar
378 wxChar
operator[](int n
) const
379 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
381 // operator version of GetWriteableChar
382 wxChar
& operator[](size_t n
)
383 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
385 // operator version of GetWriteableChar
386 wxChar
& operator[](unsigned int n
)
387 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
390 // implicit conversion to C string
391 operator const wxChar
*() const { return m_pchData
; }
392 // explicit conversion to C string (use this with printf()!)
393 const wxChar
* c_str() const { return m_pchData
; }
394 // (and this with [wx]Printf()!)
395 const wxChar
* wx_str() const { return m_pchData
; }
396 // identical to c_str()
397 const wxChar
* GetData() const { return m_pchData
; }
399 // conversions with (possible) format convertions: have to return a
400 // buffer with temporary data
402 const wxCharBuffer
mb_str(wxMBConv
& conv
= wxConvLibc
) const { return conv
.cWC2MB(m_pchData
); }
403 const wxWX2MBbuf
mbc_str() const { return mb_str(*wxConvCurrent
); }
405 const wxChar
* wc_str(wxMBConv
& WXUNUSED(conv
) = wxConvLibc
) const { return m_pchData
; }
408 const wxCharBuffer
fn_str() const { return mb_str(wxConvFile
); }
410 const wxChar
* fn_str() const { return m_pchData
; }
411 #endif // wxMBFILES/!wxMBFILES
414 const wxChar
* mb_str(wxMBConv
& WXUNUSED(conv
) = wxConvLibc
) const
415 { return m_pchData
; }
416 const wxWX2MBbuf
mbc_str() const { return mb_str(*wxConvCurrent
); }
418 const wxChar
* mb_str() const { return m_pchData
; }
419 const wxWX2MBbuf
mbc_str() const { return mb_str(); }
420 #endif // multibyte/!multibyte
422 const wxWCharBuffer
wc_str(wxMBConv
& conv
) const { return conv
.cMB2WC(m_pchData
); }
423 #endif // wxUSE_WCHAR_T
424 const wxChar
* fn_str() const { return m_pchData
; }
425 #endif // Unicode/ANSI
427 // overloaded assignment
428 // from another wxString
429 wxString
& operator=(const wxString
& stringSrc
);
431 wxString
& operator=(wxChar ch
);
433 wxString
& operator=(const wxChar
*psz
);
435 // from wxWCharBuffer
436 wxString
& operator=(const wxWCharBuffer
& psz
) { return operator=((const wchar_t *)psz
); }
438 // from another kind of C string
439 wxString
& operator=(const unsigned char* psz
);
441 // from a wide string
442 wxString
& operator=(const wchar_t *pwz
);
445 wxString
& operator=(const wxCharBuffer
& psz
) { return operator=((const char *)psz
); }
446 #endif // Unicode/ANSI
448 // string concatenation
449 // in place concatenation
451 Concatenate and return the result. Note that the left to right
452 associativity of << allows to write things like "str << str1 << str2
453 << ..." (unlike with +=)
456 wxString
& operator<<(const wxString
& s
)
458 wxASSERT( s
.GetStringData()->IsValid() );
460 ConcatSelf(s
.Len(), s
);
463 // string += C string
464 wxString
& operator<<(const wxChar
*psz
)
465 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
467 wxString
& operator<<(wxChar ch
) { ConcatSelf(1, &ch
); return *this; }
470 void operator+=(const wxString
& s
) { (void)operator<<(s
); }
471 // string += C string
472 void operator+=(const wxChar
*psz
) { (void)operator<<(psz
); }
474 void operator+=(wxChar ch
) { (void)operator<<(ch
); }
476 // string += buffer (i.e. from wxGetString)
478 wxString
& operator<<(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); return *this; }
479 void operator+=(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); }
481 wxString
& operator<<(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); return *this; }
482 void operator+=(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); }
485 // string += C string
486 wxString
& Append(const wxChar
* psz
)
487 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
488 // append count copies of given character
489 wxString
& Append(wxChar ch
, size_t count
= 1u)
490 { wxString
str(ch
, count
); return *this << str
; }
492 // prepend a string, return the string itself
493 wxString
& Prepend(const wxString
& str
)
494 { *this = str
+ *this; return *this; }
496 // non-destructive concatenation
498 friend wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
500 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
502 friend wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
504 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
506 friend wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
508 // stream-like functions
509 // insert an int into string
510 wxString
& operator<<(int i
);
511 // insert a float into string
512 wxString
& operator<<(float f
);
513 // insert a double into string
514 wxString
& operator<<(double d
);
517 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
518 int Cmp(const wxChar
*psz
) const { return wxStrcmp(c_str(), psz
); }
519 // same as Cmp() but not case-sensitive
520 int CmpNoCase(const wxChar
*psz
) const { return wxStricmp(c_str(), psz
); }
521 // test for the string equality, either considering case or not
522 // (if compareWithCase then the case matters)
523 bool IsSameAs(const wxChar
*psz
, bool compareWithCase
= TRUE
) const
524 { return (compareWithCase
? Cmp(psz
) : CmpNoCase(psz
)) == 0; }
525 // comparison with a signle character: returns TRUE if equal
526 bool IsSameAs(wxChar c
, bool compareWithCase
= TRUE
) const
528 return (Len() == 1) && (compareWithCase
? GetChar(0u) == c
529 : wxToupper(GetChar(0u)) == wxToupper(c
));
532 // simple sub-string extraction
533 // return substring starting at nFirst of length nCount (or till the end
534 // if nCount = default value)
535 wxString
Mid(size_t nFirst
, size_t nCount
= wxSTRING_MAXLEN
) const;
537 // operator version of Mid()
538 wxString
operator()(size_t start
, size_t len
) const
539 { return Mid(start
, len
); }
541 // get first nCount characters
542 wxString
Left(size_t nCount
) const;
543 // get last nCount characters
544 wxString
Right(size_t nCount
) const;
545 // get all characters before the first occurence of ch
546 // (returns the whole string if ch not found)
547 wxString
BeforeFirst(wxChar ch
) const;
548 // get all characters before the last occurence of ch
549 // (returns empty string if ch not found)
550 wxString
BeforeLast(wxChar ch
) const;
551 // get all characters after the first occurence of ch
552 // (returns empty string if ch not found)
553 wxString
AfterFirst(wxChar ch
) const;
554 // get all characters after the last occurence of ch
555 // (returns the whole string if ch not found)
556 wxString
AfterLast(wxChar ch
) const;
558 // for compatibility only, use more explicitly named functions above
559 wxString
Before(wxChar ch
) const { return BeforeLast(ch
); }
560 wxString
After(wxChar ch
) const { return AfterFirst(ch
); }
563 // convert to upper case in place, return the string itself
564 wxString
& MakeUpper();
565 // convert to upper case, return the copy of the string
566 // Here's something to remember: BC++ doesn't like returns in inlines.
567 wxString
Upper() const ;
568 // convert to lower case in place, return the string itself
569 wxString
& MakeLower();
570 // convert to lower case, return the copy of the string
571 wxString
Lower() const ;
573 // trimming/padding whitespace (either side) and truncating
574 // remove spaces from left or from right (default) side
575 wxString
& Trim(bool bFromRight
= TRUE
);
576 // add nCount copies chPad in the beginning or at the end (default)
577 wxString
& Pad(size_t nCount
, wxChar chPad
= wxT(' '), bool bFromRight
= TRUE
);
578 // truncate string to given length
579 wxString
& Truncate(size_t uiLen
);
581 // searching and replacing
582 // searching (return starting index, or -1 if not found)
583 int Find(wxChar ch
, bool bFromEnd
= FALSE
) const; // like strchr/strrchr
584 // searching (return starting index, or -1 if not found)
585 int Find(const wxChar
*pszSub
) const; // like strstr
586 // replace first (or all of bReplaceAll) occurences of substring with
587 // another string, returns the number of replacements made
588 size_t Replace(const wxChar
*szOld
,
590 bool bReplaceAll
= TRUE
);
592 // check if the string contents matches a mask containing '*' and '?'
593 bool Matches(const wxChar
*szMask
) const;
595 // formated input/output
596 // as sprintf(), returns the number of characters written or < 0 on error
597 int Printf(const wxChar
*pszFormat
, ...);
598 // as vprintf(), returns the number of characters written or < 0 on error
599 int PrintfV(const wxChar
* pszFormat
, va_list argptr
);
601 // raw access to string memory
602 // ensure that string has space for at least nLen characters
603 // only works if the data of this string is not shared
604 void Alloc(size_t nLen
);
605 // minimize the string's memory
606 // only works if the data of this string is not shared
608 // get writable buffer of at least nLen bytes. Unget() *must* be called
609 // a.s.a.p. to put string back in a reasonable state!
610 wxChar
*GetWriteBuf(size_t nLen
);
611 // call this immediately after GetWriteBuf() has been used
612 void UngetWriteBuf();
614 // wxWindows version 1 compatibility functions
617 wxString
SubString(size_t from
, size_t to
) const
618 { return Mid(from
, (to
- from
+ 1)); }
619 // values for second parameter of CompareTo function
620 enum caseCompare
{exact
, ignoreCase
};
621 // values for first parameter of Strip function
622 enum stripType
{leading
= 0x1, trailing
= 0x2, both
= 0x3};
625 int sprintf(const wxChar
*pszFormat
, ...);
628 inline int CompareTo(const wxChar
* psz
, caseCompare cmp
= exact
) const
629 { return cmp
== exact
? Cmp(psz
) : CmpNoCase(psz
); }
632 size_t Length() const { return Len(); }
633 // Count the number of characters
634 int Freq(wxChar ch
) const;
636 void LowerCase() { MakeLower(); }
638 void UpperCase() { MakeUpper(); }
639 // use Trim except that it doesn't change this string
640 wxString
Strip(stripType w
= trailing
) const;
642 // use Find (more general variants not yet supported)
643 size_t Index(const wxChar
* psz
) const { return Find(psz
); }
644 size_t Index(wxChar ch
) const { return Find(ch
); }
646 wxString
& Remove(size_t pos
) { return Truncate(pos
); }
647 wxString
& RemoveLast() { return Truncate(Len() - 1); }
649 wxString
& Remove(size_t nStart
, size_t nLen
) { return erase( nStart
, nLen
); }
652 int First( const wxChar ch
) const { return Find(ch
); }
653 int First( const wxChar
* psz
) const { return Find(psz
); }
654 int First( const wxString
&str
) const { return Find(str
); }
655 int Last( const wxChar ch
) const { return Find(ch
, TRUE
); }
656 bool Contains(const wxString
& str
) const { return Find(str
) != -1; }
659 bool IsNull() const { return IsEmpty(); }
661 #ifdef wxSTD_STRING_COMPATIBILITY
662 // std::string compatibility functions
665 typedef wxChar value_type
;
666 typedef const value_type
*const_iterator
;
668 // an 'invalid' value for string index
669 static const size_t npos
;
672 // take nLen chars starting at nPos
673 wxString(const wxString
& str
, size_t nPos
, size_t nLen
)
675 wxASSERT( str
.GetStringData()->IsValid() );
676 InitWith(str
.c_str(), nPos
, nLen
== npos
? 0 : nLen
);
678 // take all characters from pStart to pEnd
679 wxString(const void *pStart
, const void *pEnd
);
681 // lib.string.capacity
682 // return the length of the string
683 size_t size() const { return Len(); }
684 // return the length of the string
685 size_t length() const { return Len(); }
686 // return the maximum size of the string
687 size_t max_size() const { return wxSTRING_MAXLEN
; }
688 // resize the string, filling the space with c if c != 0
689 void resize(size_t nSize
, wxChar ch
= wxT('\0'));
690 // delete the contents of the string
691 void clear() { Empty(); }
692 // returns true if the string is empty
693 bool empty() const { return IsEmpty(); }
696 // return the character at position n
697 wxChar
at(size_t n
) const { return GetChar(n
); }
698 // returns the writable character at position n
699 wxChar
& at(size_t n
) { return GetWritableChar(n
); }
701 // first valid index position
702 const_iterator
begin() const { return wx_str(); }
703 // position one after the last valid one
704 const_iterator
end() const { return wx_str() + length(); }
706 // lib.string.modifiers
708 wxString
& append(const wxString
& str
)
709 { *this += str
; return *this; }
710 // append elements str[pos], ..., str[pos+n]
711 wxString
& append(const wxString
& str
, size_t pos
, size_t n
)
712 { ConcatSelf(n
, str
.c_str() + pos
); return *this; }
713 // append first n (or all if n == npos) characters of sz
714 wxString
& append(const wxChar
*sz
, size_t n
= npos
)
715 { ConcatSelf(n
== npos
? wxStrlen(sz
) : n
, sz
); return *this; }
717 // append n copies of ch
718 wxString
& append(size_t n
, wxChar ch
) { return Pad(n
, ch
); }
720 // same as `this_string = str'
721 wxString
& assign(const wxString
& str
) { return (*this) = str
; }
722 // same as ` = str[pos..pos + n]
723 wxString
& assign(const wxString
& str
, size_t pos
, size_t n
)
724 { return *this = wxString((const wxChar
*)str
+ pos
, n
); }
725 // same as `= first n (or all if n == npos) characters of sz'
726 wxString
& assign(const wxChar
*sz
, size_t n
= npos
)
727 { return *this = wxString(sz
, n
); }
728 // same as `= n copies of ch'
729 wxString
& assign(size_t n
, wxChar ch
)
730 { return *this = wxString(ch
, n
); }
732 // insert another string
733 wxString
& insert(size_t nPos
, const wxString
& str
);
734 // insert n chars of str starting at nStart (in str)
735 wxString
& insert(size_t nPos
, const wxString
& str
, size_t nStart
, size_t n
)
736 { return insert(nPos
, wxString((const wxChar
*)str
+ nStart
, n
)); }
738 // insert first n (or all if n == npos) characters of sz
739 wxString
& insert(size_t nPos
, const wxChar
*sz
, size_t n
= npos
)
740 { return insert(nPos
, wxString(sz
, n
)); }
741 // insert n copies of ch
742 wxString
& insert(size_t nPos
, size_t n
, wxChar ch
)
743 { return insert(nPos
, wxString(ch
, n
)); }
745 // delete characters from nStart to nStart + nLen
746 wxString
& erase(size_t nStart
= 0, size_t nLen
= npos
);
748 // replaces the substring of length nLen starting at nStart
749 wxString
& replace(size_t nStart
, size_t nLen
, const wxChar
* sz
);
750 // replaces the substring with nCount copies of ch
751 wxString
& replace(size_t nStart
, size_t nLen
, size_t nCount
, wxChar ch
);
752 // replaces a substring with another substring
753 wxString
& replace(size_t nStart
, size_t nLen
,
754 const wxString
& str
, size_t nStart2
, size_t nLen2
);
755 // replaces the substring with first nCount chars of sz
756 wxString
& replace(size_t nStart
, size_t nLen
,
757 const wxChar
* sz
, size_t nCount
);
760 void swap(wxString
& str
);
762 // All find() functions take the nStart argument which specifies the
763 // position to start the search on, the default value is 0. All functions
764 // return npos if there were no match.
767 size_t find(const wxString
& str
, size_t nStart
= 0) const;
769 // VC++ 1.5 can't cope with this syntax.
770 #if !defined(__VISUALC__) || defined(__WIN32__)
771 // find first n characters of sz
772 size_t find(const wxChar
* sz
, size_t nStart
= 0, size_t n
= npos
) const;
775 // Gives a duplicate symbol (presumably a case-insensitivity problem)
776 #if !defined(__BORLANDC__)
777 // find the first occurence of character ch after nStart
778 size_t find(wxChar ch
, size_t nStart
= 0) const;
780 // rfind() family is exactly like find() but works right to left
782 // as find, but from the end
783 size_t rfind(const wxString
& str
, size_t nStart
= npos
) const;
785 // VC++ 1.5 can't cope with this syntax.
786 #if !defined(__VISUALC__) || defined(__WIN32__)
787 // as find, but from the end
788 size_t rfind(const wxChar
* sz
, size_t nStart
= npos
,
789 size_t n
= npos
) const;
790 // as find, but from the end
791 size_t rfind(wxChar ch
, size_t nStart
= npos
) const;
794 // find first/last occurence of any character in the set
796 // as strpbrk() but starts at nStart, returns npos if not found
797 size_t find_first_of(const wxString
& str
, size_t nStart
= 0) const
798 { return find_first_of(str
.c_str(), nStart
); }
800 size_t find_first_of(const wxChar
* sz
, size_t nStart
= 0) const;
801 // same as find(char, size_t)
802 size_t find_first_of(wxChar c
, size_t nStart
= 0) const
803 { return find(c
, nStart
); }
804 // find the last (starting from nStart) char from str in this string
805 size_t find_last_of (const wxString
& str
, size_t nStart
= npos
) const
806 { return find_last_of(str
.c_str(), nStart
); }
808 size_t find_last_of (const wxChar
* sz
, size_t nStart
= npos
) const;
810 size_t find_last_of(wxChar c
, size_t nStart
= npos
) const
811 { return rfind(c
, nStart
); }
813 // find first/last occurence of any character not in the set
815 // as strspn() (starting from nStart), returns npos on failure
816 size_t find_first_not_of(const wxString
& str
, size_t nStart
= 0) const
817 { return find_first_not_of(str
.c_str(), nStart
); }
819 size_t find_first_not_of(const wxChar
* sz
, size_t nStart
= 0) const;
821 size_t find_first_not_of(wxChar ch
, size_t nStart
= 0) const;
823 size_t find_last_not_of(const wxString
& str
, size_t nStart
=npos
) const;
825 size_t find_last_not_of(const wxChar
* sz
, size_t nStart
= npos
) const;
827 size_t find_last_not_of(wxChar ch
, size_t nStart
= npos
) const;
829 // All compare functions return -1, 0 or 1 if the [sub]string is less,
830 // equal or greater than the compare() argument.
832 // just like strcmp()
833 int compare(const wxString
& str
) const { return Cmp(str
); }
834 // comparison with a substring
835 int compare(size_t nStart
, size_t nLen
, const wxString
& str
) const;
836 // comparison of 2 substrings
837 int compare(size_t nStart
, size_t nLen
,
838 const wxString
& str
, size_t nStart2
, size_t nLen2
) const;
839 // just like strcmp()
840 int compare(const wxChar
* sz
) const { return Cmp(sz
); }
841 // substring comparison with first nCount characters of sz
842 int compare(size_t nStart
, size_t nLen
,
843 const wxChar
* sz
, size_t nCount
= npos
) const;
845 // substring extraction
846 wxString
substr(size_t nStart
= 0, size_t nLen
= npos
) const;
847 #endif // wxSTD_STRING_COMPATIBILITY
850 // ----------------------------------------------------------------------------
851 // The string array uses it's knowledge of internal structure of the wxString
852 // class to optimize string storage. Normally, we would store pointers to
853 // string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
854 // sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
855 // really all we need to turn such pointer into a string!
857 // Of course, it can be called a dirty hack, but we use twice less memory and
858 // this approach is also more speed efficient, so it's probably worth it.
860 // Usage notes: when a string is added/inserted, a new copy of it is created,
861 // so the original string may be safely deleted. When a string is retrieved
862 // from the array (operator[] or Item() method), a reference is returned.
863 // ----------------------------------------------------------------------------
865 class WXDLLEXPORT wxArrayString
868 // type of function used by wxArrayString::Sort()
869 typedef int (*CompareFunction
)(const wxString
& first
,
870 const wxString
& second
);
872 // constructors and destructor
873 // default ctor: if autoSort is TRUE, the array is always sorted (in
874 // alphabetical order)
875 wxArrayString(bool autoSort
= FALSE
);
877 wxArrayString(const wxArrayString
& array
);
878 // assignment operator
879 wxArrayString
& operator=(const wxArrayString
& src
);
880 // not virtual, this class should not be derived from
884 // empties the list, but doesn't release memory
886 // empties the list and releases memory
888 // preallocates memory for given number of items
889 void Alloc(size_t nCount
);
890 // minimzes the memory usage (by freeing all extra memory)
894 // number of elements in the array
895 size_t GetCount() const { return m_nCount
; }
897 bool IsEmpty() const { return m_nCount
== 0; }
898 // number of elements in the array (GetCount is preferred API)
899 size_t Count() const { return m_nCount
; }
901 // items access (range checking is done in debug version)
902 // get item at position uiIndex
903 wxString
& Item(size_t nIndex
) const
904 { wxASSERT( nIndex
< m_nCount
); return *(wxString
*)&(m_pItems
[nIndex
]); }
906 wxString
& operator[](size_t nIndex
) const { return Item(nIndex
); }
908 wxString
& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
911 // Search the element in the array, starting from the beginning if
912 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
913 // sensitive (default). Returns index of the first item matched or
915 int Index (const wxChar
*sz
, bool bCase
= TRUE
, bool bFromEnd
= FALSE
) const;
916 // add new element at the end (if the array is not sorted), return its
918 size_t Add(const wxString
& str
);
919 // add new element at given position
920 void Insert(const wxString
& str
, size_t uiIndex
);
921 // remove first item matching this value
922 void Remove(const wxChar
*sz
);
923 // remove item by index
924 void Remove(size_t nIndex
);
927 // sort array elements in alphabetical order (or reversed alphabetical
928 // order if reverseOrder parameter is TRUE)
929 void Sort(bool reverseOrder
= FALSE
);
930 // sort array elements using specified comparaison function
931 void Sort(CompareFunction compareFunction
);
934 void Copy(const wxArrayString
& src
); // copies the contents of another array
937 void Grow(); // makes array bigger if needed
938 void Free(); // free all the strings stored
940 void DoSort(); // common part of all Sort() variants
942 size_t m_nSize
, // current size of the array
943 m_nCount
; // current number of elements
945 wxChar
**m_pItems
; // pointer to data
947 bool m_autoSort
; // if TRUE, keep the array always sorted
950 class WXDLLEXPORT wxSortedArrayString
: public wxArrayString
953 wxSortedArrayString() : wxArrayString(TRUE
)
955 wxSortedArrayString(const wxArrayString
& array
) : wxArrayString(TRUE
)
959 // ---------------------------------------------------------------------------
960 // wxString comparison functions: operator versions are always case sensitive
961 // ---------------------------------------------------------------------------
964 inline bool operator==(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) == 0); }
966 inline bool operator==(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) == 0); }
968 inline bool operator==(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) == 0); }
970 inline bool operator!=(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) != 0); }
972 inline bool operator!=(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) != 0); }
974 inline bool operator!=(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) != 0); }
976 inline bool operator< (const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) < 0); }
978 inline bool operator< (const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) < 0); }
980 inline bool operator< (const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) > 0); }
982 inline bool operator> (const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) > 0); }
984 inline bool operator> (const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) > 0); }
986 inline bool operator> (const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) < 0); }
988 inline bool operator<=(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) <= 0); }
990 inline bool operator<=(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) <= 0); }
992 inline bool operator<=(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) >= 0); }
994 inline bool operator>=(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) >= 0); }
996 inline bool operator>=(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) >= 0); }
998 inline bool operator>=(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) <= 0); }
1000 // comparison with char
1001 inline bool operator==(wxChar c
, const wxString
& s
) { return s
.IsSameAs(c
); }
1002 inline bool operator==(const wxString
& s
, wxChar c
) { return s
.IsSameAs(c
); }
1003 inline bool operator!=(wxChar c
, const wxString
& s
) { return !s
.IsSameAs(c
); }
1004 inline bool operator!=(const wxString
& s
, wxChar c
) { return !s
.IsSameAs(c
); }
1007 inline bool operator==(const wxString
& s1
, const wxWCharBuffer
& s2
)
1008 { return (s1
.Cmp((const wchar_t *)s2
) == 0); }
1009 inline bool operator==(const wxWCharBuffer
& s1
, const wxString
& s2
)
1010 { return (s2
.Cmp((const wchar_t *)s1
) == 0); }
1012 inline bool operator==(const wxString
& s1
, const wxCharBuffer
& s2
)
1013 { return (s1
.Cmp((const char *)s2
) == 0); }
1014 inline bool operator==(const wxCharBuffer
& s1
, const wxString
& s2
)
1015 { return (s2
.Cmp((const char *)s1
) == 0); }
1018 wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
1019 wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
1020 wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
1021 wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
1022 wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
1024 inline wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxWCharBuffer
& buf
)
1025 { return string
+ (const wchar_t *)buf
; }
1026 inline wxString WXDLLEXPORT
operator+(const wxWCharBuffer
& buf
, const wxString
& string
)
1027 { return (const wchar_t *)buf
+ string
; }
1029 inline wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxCharBuffer
& buf
)
1030 { return string
+ (const char *)buf
; }
1031 inline wxString WXDLLEXPORT
operator+(const wxCharBuffer
& buf
, const wxString
& string
)
1032 { return (const char *)buf
+ string
; }
1035 // ---------------------------------------------------------------------------
1036 // Implementation only from here until the end of file
1037 // ---------------------------------------------------------------------------
1039 // don't pollute the library user's name space
1040 #undef ASSERT_VALID_INDEX
1042 #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
1044 #include "wx/ioswrap.h"
1046 WXDLLEXPORT istream
& operator>>(istream
&, wxString
&);
1047 WXDLLEXPORT ostream
& operator<<(ostream
&, const wxString
&);
1049 #endif // wxSTD_STRING_COMPATIBILITY
1051 #endif // _WX_WXSTRINGH__