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 // ----------------------------------------------------------------------------
41 #if defined(__WXMAC__) || defined(__VISAGECPP__)
49 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
50 // problem in VACPP V4 with including stdlib.h multiple times
51 // strconv includes it anyway
65 #include <strings.h> // for strcasecmp()
68 #include "wx/defs.h" // everybody should include this
69 #include "wx/wxchar.h" // for wxChar
70 #include "wx/buffer.h" // for wxCharBuffer
71 #include "wx/strconv.h" // for wxConvertXXX() macros and wxMBConv classes
74 #ifdef WXSTRING_IS_WXOBJECT
75 #include "wx/object.h" // base class
79 // ---------------------------------------------------------------------------
81 // ---------------------------------------------------------------------------
84 #define WXSTRINGCAST (wxChar *)(const wxChar *)
85 #define wxCSTRINGCAST (wxChar *)(const wxChar *)
86 #define wxMBSTRINGCAST (char *)(const char *)
87 #define wxWCSTRINGCAST (wchar_t *)(const wchar_t *)
89 // implementation only
90 #define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
92 // ----------------------------------------------------------------------------
94 // ----------------------------------------------------------------------------
96 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
97 // must define this static for VA or else you get multiply defined symbols everywhere
98 extern const unsigned int wxSTRING_MAXLEN
;
101 // maximum possible length for a string means "take all string" everywhere
102 // (as sizeof(StringData) is unknown here, we substract 100)
103 const unsigned int wxSTRING_MAXLEN
= UINT_MAX
- 100;
107 // ----------------------------------------------------------------------------
109 // ----------------------------------------------------------------------------
111 // global pointer to empty string
112 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
114 // ---------------------------------------------------------------------------
115 // global functions complementing standard C string library replacements for
116 // strlen() and portable strcasecmp()
117 //---------------------------------------------------------------------------
119 // Use wxXXX() functions from wxchar.h instead! These functions are for
120 // backwards compatibility only.
122 // checks whether the passed in pointer is NULL and if the string is empty
123 inline bool IsEmpty(const char *p
) { return (!p
|| !*p
); }
125 // safe version of strlen() (returns 0 if passed NULL pointer)
126 inline size_t Strlen(const char *psz
)
127 { return psz
? strlen(psz
) : 0; }
129 // portable strcasecmp/_stricmp
130 inline int Stricmp(const char *psz1
, const char *psz2
)
132 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
133 return _stricmp(psz1
, psz2
);
134 #elif defined(__SC__)
135 return _stricmp(psz1
, psz2
);
136 #elif defined(__SALFORDC__)
137 return stricmp(psz1
, psz2
);
138 #elif defined(__BORLANDC__)
139 return stricmp(psz1
, psz2
);
140 #elif defined(__WATCOMC__)
141 return stricmp(psz1
, psz2
);
142 #elif defined(__EMX__)
143 return stricmp(psz1
, psz2
);
144 #elif defined(__WXPM__)
145 return stricmp(psz1
, psz2
);
146 #elif defined(__UNIX__) || defined(__GNUWIN32__)
147 return strcasecmp(psz1
, psz2
);
148 #elif defined(__MWERKS__) && !defined(__INTEL__)
149 register char c1
, c2
;
151 c1
= tolower(*psz1
++);
152 c2
= tolower(*psz2
++);
153 } while ( c1
&& (c1
== c2
) );
157 // almost all compilers/libraries provide this function (unfortunately under
158 // different names), that's why we don't implement our own which will surely
159 // be more efficient than this code (uncomment to use):
161 register char c1, c2;
163 c1 = tolower(*psz1++);
164 c2 = tolower(*psz2++);
165 } while ( c1 && (c1 == c2) );
170 #error "Please define string case-insensitive compare for your OS/compiler"
171 #endif // OS/compiler
174 // wxSnprintf() is like snprintf() if it's available and sprintf() (always
175 // available, but dangerous!) if not
176 extern int WXDLLEXPORT
wxSnprintf(wxChar
*buf
, size_t len
,
177 const wxChar
*format
, ...);
179 // and wxVsnprintf() is like vsnprintf() or vsprintf()
180 extern int WXDLLEXPORT
wxVsnprintf(wxChar
*buf
, size_t len
,
181 const wxChar
*format
, va_list argptr
);
183 // return an empty wxString
184 class WXDLLEXPORT wxString
; // not yet defined
185 inline const wxString
& wxGetEmptyString() { return *(wxString
*)&wxEmptyString
; }
187 // ---------------------------------------------------------------------------
188 // string data prepended with some housekeeping info (used by wxString class),
189 // is never used directly (but had to be put here to allow inlining)
190 // ---------------------------------------------------------------------------
192 struct WXDLLEXPORT wxStringData
194 int nRefs
; // reference count
195 size_t nDataLength
, // actual string length
196 nAllocLength
; // allocated memory size
198 // mimics declaration 'wxChar data[nAllocLength]'
199 wxChar
* data() const { return (wxChar
*)(this + 1); }
201 // empty string has a special ref count so it's never deleted
202 bool IsEmpty() const { return (nRefs
== -1); }
203 bool IsShared() const { return (nRefs
> 1); }
206 void Lock() { if ( !IsEmpty() ) nRefs
++; }
208 // VC++ will refuse to inline this function but profiling shows that it
210 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
213 void Unlock() { if ( !IsEmpty() && --nRefs
== 0) free(this); }
215 // if we had taken control over string memory (GetWriteBuf), it's
216 // intentionally put in invalid state
217 void Validate(bool b
) { nRefs
= (b
? 1 : 0); }
218 bool IsValid() const { return (nRefs
!= 0); }
221 // ---------------------------------------------------------------------------
222 // This is (yet another one) String class for C++ programmers. It doesn't use
223 // any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
224 // thus you should be able to compile it with practicaly any C++ compiler.
225 // This class uses copy-on-write technique, i.e. identical strings share the
226 // same memory as long as neither of them is changed.
228 // This class aims to be as compatible as possible with the new standard
229 // std::string class, but adds some additional functions and should be at
230 // least as efficient than the standard implementation.
232 // Performance note: it's more efficient to write functions which take "const
233 // String&" arguments than "const char *" if you assign the argument to
236 // It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
239 // - ressource support (string tables in ressources)
240 // - more wide character (UNICODE) support
241 // - regular expressions support
242 // ---------------------------------------------------------------------------
244 #ifdef WXSTRING_IS_WXOBJECT
245 class WXDLLEXPORT wxString
: public wxObject
247 DECLARE_DYNAMIC_CLASS(wxString
)
248 #else //WXSTRING_IS_WXOBJECT
249 class WXDLLEXPORT wxString
251 #endif //WXSTRING_IS_WXOBJECT
253 friend class WXDLLEXPORT wxArrayString
;
255 // NB: special care was taken in arranging the member functions in such order
256 // that all inline functions can be effectively inlined, verify that all
257 // performace critical functions are still inlined if you change order!
259 // points to data preceded by wxStringData structure with ref count info
262 // accessor to string data
263 wxStringData
* GetStringData() const { return (wxStringData
*)m_pchData
- 1; }
265 // string (re)initialization functions
266 // initializes the string to the empty value (must be called only from
267 // ctors, use Reinit() otherwise)
268 void Init() { m_pchData
= (wxChar
*)wxEmptyString
; }
269 // initializaes the string with (a part of) C-string
270 void InitWith(const wxChar
*psz
, size_t nPos
= 0, size_t nLen
= wxSTRING_MAXLEN
);
271 // as Init, but also frees old data
272 void Reinit() { GetStringData()->Unlock(); Init(); }
275 // allocates memory for string of lenght nLen
276 void AllocBuffer(size_t nLen
);
277 // copies data to another string
278 void AllocCopy(wxString
&, int, int) const;
279 // effectively copies data to string
280 void AssignCopy(size_t, const wxChar
*);
282 // append a (sub)string
283 void ConcatSelf(int nLen
, const wxChar
*src
);
285 // functions called before writing to the string: they copy it if there
286 // are other references to our data (should be the only owner when writing)
287 void CopyBeforeWrite();
288 void AllocBeforeWrite(size_t);
290 // this method is not implemented - there is _no_ conversion from int to
291 // string, you're doing something wrong if the compiler wants to call it!
293 // try `s << i' or `s.Printf("%d", i)' instead
295 wxString(unsigned int);
297 wxString(unsigned long);
300 // constructors and destructor
301 // ctor for an empty string
302 wxString() { Init(); }
304 wxString(const wxString
& stringSrc
)
306 wxASSERT( stringSrc
.GetStringData()->IsValid() );
308 if ( stringSrc
.IsEmpty() ) {
309 // nothing to do for an empty string
313 m_pchData
= stringSrc
.m_pchData
; // share same data
314 GetStringData()->Lock(); // => one more copy
317 // string containing nRepeat copies of ch
318 wxString(wxChar ch
, size_t nRepeat
= 1);
319 // ctor takes first nLength characters from C string
320 // (default value of wxSTRING_MAXLEN means take all the string)
321 wxString(const wxChar
*psz
, size_t nLength
= wxSTRING_MAXLEN
)
322 { InitWith(psz
, 0, nLength
); }
323 wxString(const wxChar
*psz
, wxMBConv
& WXUNUSED(conv
), size_t nLength
= wxSTRING_MAXLEN
)
324 { InitWith(psz
, 0, nLength
); }
327 // from multibyte string
328 // (NB: nLength is right now number of Unicode characters, not
329 // characters in psz! So try not to use it yet!)
330 wxString(const char *psz
, wxMBConv
& conv
= wxConvLibc
, size_t nLength
= wxSTRING_MAXLEN
);
331 // from wxWCharBuffer (i.e. return from wxGetString)
332 wxString(const wxWCharBuffer
& psz
)
333 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
335 // from C string (for compilers using unsigned char)
336 wxString(const unsigned char* psz
, size_t nLength
= wxSTRING_MAXLEN
)
337 { InitWith((const char*)psz
, 0, nLength
); }
340 // from wide (Unicode) string
341 wxString(const wchar_t *pwz
, wxMBConv
& conv
= wxConvLibc
);
342 #endif // !wxUSE_WCHAR_T
345 wxString(const wxCharBuffer
& psz
)
346 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
347 #endif // Unicode/ANSI
349 // dtor is not virtual, this class must not be inherited from!
350 ~wxString() { GetStringData()->Unlock(); }
352 // generic attributes & operations
353 // as standard strlen()
354 size_t Len() const { return GetStringData()->nDataLength
; }
355 // string contains any characters?
356 bool IsEmpty() const { return Len() == 0; }
357 // empty string is "FALSE", so !str will return TRUE
358 bool operator!() const { return IsEmpty(); }
359 // empty string contents
366 wxASSERT( GetStringData()->nDataLength
== 0 );
368 // empty the string and free memory
371 if ( !GetStringData()->IsEmpty() )
374 wxASSERT( GetStringData()->nDataLength
== 0 ); // should be empty
375 wxASSERT( GetStringData()->nAllocLength
== 0 ); // and not own any memory
380 bool IsAscii() const;
382 bool IsNumber() const;
386 // data access (all indexes are 0 based)
388 wxChar
GetChar(size_t n
) const
389 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
391 wxChar
& GetWritableChar(size_t n
)
392 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
394 void SetChar(size_t n
, wxChar ch
)
395 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); m_pchData
[n
] = ch
; }
397 // get last character
399 { wxASSERT( !IsEmpty() ); return m_pchData
[Len() - 1]; }
400 // get writable last character
402 { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData
[Len()-1]; }
405 So why do we have all these overloaded operator[]s? A bit of history:
406 initially there was only one of them, taking size_t. Then people
407 started complaining because they wanted to use ints as indices (I
408 wonder why) and compilers were giving warnings about it, so we had to
409 add the operator[](int). Then it became apparent that you couldn't
410 write str[0] any longer because there was ambiguity between two
411 overloads and so you now had to write str[0u] (or, of course, use the
412 explicit casts to either int or size_t but nobody did this).
414 Finally, someone decided to compile wxWin on an Alpha machine and got
415 a surprize: str[0u] didn't compile there because it is of type
416 unsigned int and size_t is unsigned _long_ on Alpha and so there was
417 ambiguity between converting uint to int or ulong. To fix this one we
418 now add operator[](uint) for the machines where size_t is not already
419 the same as unsigned int - hopefully this fixes the problem (for some
422 The only real fix is, of course, to remove all versions but the one
426 // operator version of GetChar
427 wxChar
operator[](size_t n
) const
428 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
430 // operator version of GetChar
431 wxChar
operator[](int n
) const
432 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
434 // operator version of GetWriteableChar
435 wxChar
& operator[](size_t n
)
436 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
438 #ifndef wxSIZE_T_IS_UINT
439 // operator version of GetChar
440 wxChar
operator[](unsigned int n
) const
441 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
443 // operator version of GetWriteableChar
444 wxChar
& operator[](unsigned int n
)
445 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
446 #endif // size_t != unsigned int
448 // implicit conversion to C string
449 operator const wxChar
*() const { return m_pchData
; }
450 // explicit conversion to C string (use this with printf()!)
451 const wxChar
* c_str() const { return m_pchData
; }
452 // identical to c_str()
453 const wxChar
* wx_str() const { return m_pchData
; }
454 // identical to c_str()
455 const wxChar
* GetData() const { return m_pchData
; }
457 // conversions with (possible) format convertions: have to return a
458 // buffer with temporary data
460 // the functions defined (in either Unicode or ANSI) mode are mb_str() to
461 // return an ANSI (multibyte) string, wc_str() to return a wide string and
462 // fn_str() to return a string which should be used with the OS APIs
463 // accepting the file names. The return value is always the same, but the
464 // type differs because a function may either return pointer to the buffer
465 // directly or have to use intermediate buffer for translation.
467 const wxCharBuffer
mb_str(wxMBConv
& conv
= wxConvLibc
) const
468 { return conv
.cWC2MB(m_pchData
); }
470 const wxWX2MBbuf
mbc_str() const { return mb_str(*wxConvCurrent
); }
472 const wxChar
* wc_str() const { return m_pchData
; }
474 // for compatibility with !wxUSE_UNICODE version
475 const wxChar
* wc_str(wxMBConv
& WXUNUSED(conv
)) const { return m_pchData
; }
478 const wxCharBuffer
fn_str() const { return mb_str(wxConvFile
); }
480 const wxChar
* fn_str() const { return m_pchData
; }
481 #endif // wxMBFILES/!wxMBFILES
483 const wxChar
* mb_str() const { return m_pchData
; }
485 // for compatibility with wxUSE_UNICODE version
486 const wxChar
* mb_str(wxMBConv
& WXUNUSED(conv
)) const { return m_pchData
; }
488 const wxWX2MBbuf
mbc_str() const { return mb_str(); }
491 const wxWCharBuffer
wc_str(wxMBConv
& conv
) const
492 { return conv
.cMB2WC(m_pchData
); }
493 #endif // wxUSE_WCHAR_T
495 const wxChar
* fn_str() const { return m_pchData
; }
496 #endif // Unicode/ANSI
498 // overloaded assignment
499 // from another wxString
500 wxString
& operator=(const wxString
& stringSrc
);
502 wxString
& operator=(wxChar ch
);
504 wxString
& operator=(const wxChar
*psz
);
506 // from wxWCharBuffer
507 wxString
& operator=(const wxWCharBuffer
& psz
) { return operator=((const wchar_t *)psz
); }
509 // from another kind of C string
510 wxString
& operator=(const unsigned char* psz
);
512 // from a wide string
513 wxString
& operator=(const wchar_t *pwz
);
516 wxString
& operator=(const wxCharBuffer
& psz
) { return operator=((const char *)psz
); }
517 #endif // Unicode/ANSI
519 // string concatenation
520 // in place concatenation
522 Concatenate and return the result. Note that the left to right
523 associativity of << allows to write things like "str << str1 << str2
524 << ..." (unlike with +=)
527 wxString
& operator<<(const wxString
& s
)
529 wxASSERT( s
.GetStringData()->IsValid() );
531 ConcatSelf(s
.Len(), s
);
534 // string += C string
535 wxString
& operator<<(const wxChar
*psz
)
536 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
538 wxString
& operator<<(wxChar ch
) { ConcatSelf(1, &ch
); return *this; }
541 void operator+=(const wxString
& s
) { (void)operator<<(s
); }
542 // string += C string
543 void operator+=(const wxChar
*psz
) { (void)operator<<(psz
); }
545 void operator+=(wxChar ch
) { (void)operator<<(ch
); }
547 // string += buffer (i.e. from wxGetString)
549 wxString
& operator<<(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); return *this; }
550 void operator+=(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); }
552 wxString
& operator<<(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); return *this; }
553 void operator+=(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); }
556 // string += C string
557 wxString
& Append(const wxChar
* psz
)
558 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
559 // append count copies of given character
560 wxString
& Append(wxChar ch
, size_t count
= 1u)
561 { wxString
str(ch
, count
); return *this << str
; }
562 wxString
& Append(const wxChar
* psz
, size_t nLen
)
563 { ConcatSelf(nLen
, psz
); return *this; }
565 // prepend a string, return the string itself
566 wxString
& Prepend(const wxString
& str
)
567 { *this = str
+ *this; return *this; }
569 // non-destructive concatenation
571 friend wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
573 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
575 friend wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
577 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
579 friend wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
581 // stream-like functions
582 // insert an int into string
583 wxString
& operator<<(int i
)
584 { return (*this) << Format(_T("%d"), i
); }
585 // insert an unsigned int into string
586 wxString
& operator<<(unsigned int ui
)
587 { return (*this) << Format(_T("%u"), ui
); }
588 // insert a long into string
589 wxString
& operator<<(long l
)
590 { return (*this) << Format(_T("%ld"), l
); }
591 // insert an unsigned long into string
592 wxString
& operator<<(unsigned long ul
)
593 { return (*this) << Format(_T("%lu"), ul
); }
594 // insert a float into string
595 wxString
& operator<<(float f
)
596 { return (*this) << Format(_T("%f"), f
); }
597 // insert a double into string
598 wxString
& operator<<(double d
)
599 { return (*this) << Format(_T("%g"), d
); }
602 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
603 int Cmp(const wxChar
*psz
) const { return wxStrcmp(c_str(), psz
); }
604 // same as Cmp() but not case-sensitive
605 int CmpNoCase(const wxChar
*psz
) const { return wxStricmp(c_str(), psz
); }
606 // test for the string equality, either considering case or not
607 // (if compareWithCase then the case matters)
608 bool IsSameAs(const wxChar
*psz
, bool compareWithCase
= TRUE
) const
609 { return (compareWithCase
? Cmp(psz
) : CmpNoCase(psz
)) == 0; }
610 // comparison with a signle character: returns TRUE if equal
611 bool IsSameAs(wxChar c
, bool compareWithCase
= TRUE
) const
613 return (Len() == 1) && (compareWithCase
? GetChar(0u) == c
614 : wxToupper(GetChar(0u)) == wxToupper(c
));
617 // simple sub-string extraction
618 // return substring starting at nFirst of length nCount (or till the end
619 // if nCount = default value)
620 wxString
Mid(size_t nFirst
, size_t nCount
= wxSTRING_MAXLEN
) const;
622 // operator version of Mid()
623 wxString
operator()(size_t start
, size_t len
) const
624 { return Mid(start
, len
); }
626 // check that the tring starts with prefix and return the rest of the
627 // string in the provided pointer if it is not NULL, otherwise return
629 bool StartsWith(const wxChar
*prefix
, wxString
*rest
= NULL
) const;
631 // get first nCount characters
632 wxString
Left(size_t nCount
) const;
633 // get last nCount characters
634 wxString
Right(size_t nCount
) const;
635 // get all characters before the first occurence of ch
636 // (returns the whole string if ch not found)
637 wxString
BeforeFirst(wxChar ch
) const;
638 // get all characters before the last occurence of ch
639 // (returns empty string if ch not found)
640 wxString
BeforeLast(wxChar ch
) const;
641 // get all characters after the first occurence of ch
642 // (returns empty string if ch not found)
643 wxString
AfterFirst(wxChar ch
) const;
644 // get all characters after the last occurence of ch
645 // (returns the whole string if ch not found)
646 wxString
AfterLast(wxChar ch
) const;
648 // for compatibility only, use more explicitly named functions above
649 wxString
Before(wxChar ch
) const { return BeforeLast(ch
); }
650 wxString
After(wxChar ch
) const { return AfterFirst(ch
); }
653 // convert to upper case in place, return the string itself
654 wxString
& MakeUpper();
655 // convert to upper case, return the copy of the string
656 // Here's something to remember: BC++ doesn't like returns in inlines.
657 wxString
Upper() const ;
658 // convert to lower case in place, return the string itself
659 wxString
& MakeLower();
660 // convert to lower case, return the copy of the string
661 wxString
Lower() const ;
663 // trimming/padding whitespace (either side) and truncating
664 // remove spaces from left or from right (default) side
665 wxString
& Trim(bool bFromRight
= TRUE
);
666 // add nCount copies chPad in the beginning or at the end (default)
667 wxString
& Pad(size_t nCount
, wxChar chPad
= wxT(' '), bool bFromRight
= TRUE
);
668 // truncate string to given length
669 wxString
& Truncate(size_t uiLen
);
671 // searching and replacing
672 // searching (return starting index, or -1 if not found)
673 int Find(wxChar ch
, bool bFromEnd
= FALSE
) const; // like strchr/strrchr
674 // searching (return starting index, or -1 if not found)
675 int Find(const wxChar
*pszSub
) const; // like strstr
676 // replace first (or all of bReplaceAll) occurences of substring with
677 // another string, returns the number of replacements made
678 size_t Replace(const wxChar
*szOld
,
680 bool bReplaceAll
= TRUE
);
682 // check if the string contents matches a mask containing '*' and '?'
683 bool Matches(const wxChar
*szMask
) const;
685 // conversion to numbers: all functions return TRUE only if the whole string
686 // is a number and put the value of this number into the pointer provided
687 // convert to a signed integer
688 bool ToLong(long *val
) const;
689 // convert to an unsigned integer
690 bool ToULong(unsigned long *val
) const;
691 // convert to a double
692 bool ToDouble(double *val
) const;
694 // formated input/output
695 // as sprintf(), returns the number of characters written or < 0 on error
696 int Printf(const wxChar
*pszFormat
, ...);
697 // as vprintf(), returns the number of characters written or < 0 on error
698 int PrintfV(const wxChar
* pszFormat
, va_list argptr
);
700 // returns the string containing the result of Printf() to it
701 static wxString
Format(const wxChar
*pszFormat
, ...);
702 // the same as above, but takes a va_list
703 static wxString
FormatV(const wxChar
*pszFormat
, va_list argptr
);
705 // raw access to string memory
706 // ensure that string has space for at least nLen characters
707 // only works if the data of this string is not shared
708 void Alloc(size_t nLen
);
709 // minimize the string's memory
710 // only works if the data of this string is not shared
712 // get writable buffer of at least nLen bytes. Unget() *must* be called
713 // a.s.a.p. to put string back in a reasonable state!
714 wxChar
*GetWriteBuf(size_t nLen
);
715 // call this immediately after GetWriteBuf() has been used
716 void UngetWriteBuf();
717 void UngetWriteBuf(size_t nLen
);
719 // wxWindows version 1 compatibility functions
722 wxString
SubString(size_t from
, size_t to
) const
723 { return Mid(from
, (to
- from
+ 1)); }
724 // values for second parameter of CompareTo function
725 enum caseCompare
{exact
, ignoreCase
};
726 // values for first parameter of Strip function
727 enum stripType
{leading
= 0x1, trailing
= 0x2, both
= 0x3};
730 int sprintf(const wxChar
*pszFormat
, ...);
733 inline int CompareTo(const wxChar
* psz
, caseCompare cmp
= exact
) const
734 { return cmp
== exact
? Cmp(psz
) : CmpNoCase(psz
); }
737 size_t Length() const { return Len(); }
738 // Count the number of characters
739 int Freq(wxChar ch
) const;
741 void LowerCase() { MakeLower(); }
743 void UpperCase() { MakeUpper(); }
744 // use Trim except that it doesn't change this string
745 wxString
Strip(stripType w
= trailing
) const;
747 // use Find (more general variants not yet supported)
748 size_t Index(const wxChar
* psz
) const { return Find(psz
); }
749 size_t Index(wxChar ch
) const { return Find(ch
); }
751 wxString
& Remove(size_t pos
) { return Truncate(pos
); }
752 wxString
& RemoveLast(size_t n
= 1) { return Truncate(Len() - n
); }
754 wxString
& Remove(size_t nStart
, size_t nLen
) { return erase( nStart
, nLen
); }
757 int First( const wxChar ch
) const { return Find(ch
); }
758 int First( const wxChar
* psz
) const { return Find(psz
); }
759 int First( const wxString
&str
) const { return Find(str
); }
760 int Last( const wxChar ch
) const { return Find(ch
, TRUE
); }
761 bool Contains(const wxString
& str
) const { return Find(str
) != -1; }
764 bool IsNull() const { return IsEmpty(); }
766 #ifdef wxSTD_STRING_COMPATIBILITY
767 // std::string compatibility functions
770 typedef wxChar value_type
;
771 typedef const value_type
*const_iterator
;
773 // an 'invalid' value for string index
774 static const size_t npos
;
777 // take nLen chars starting at nPos
778 wxString(const wxString
& str
, size_t nPos
, size_t nLen
)
780 wxASSERT( str
.GetStringData()->IsValid() );
781 InitWith(str
.c_str(), nPos
, nLen
== npos
? 0 : nLen
);
783 // take all characters from pStart to pEnd
784 wxString(const void *pStart
, const void *pEnd
);
786 // lib.string.capacity
787 // return the length of the string
788 size_t size() const { return Len(); }
789 // return the length of the string
790 size_t length() const { return Len(); }
791 // return the maximum size of the string
792 size_t max_size() const { return wxSTRING_MAXLEN
; }
793 // resize the string, filling the space with c if c != 0
794 void resize(size_t nSize
, wxChar ch
= wxT('\0'));
795 // delete the contents of the string
796 void clear() { Empty(); }
797 // returns true if the string is empty
798 bool empty() const { return IsEmpty(); }
799 // inform string about planned change in size
800 void reserve(size_t size
) { Alloc(size
); }
803 // return the character at position n
804 wxChar
at(size_t n
) const { return GetChar(n
); }
805 // returns the writable character at position n
806 wxChar
& at(size_t n
) { return GetWritableChar(n
); }
808 // first valid index position
809 const_iterator
begin() const { return wx_str(); }
810 // position one after the last valid one
811 const_iterator
end() const { return wx_str() + length(); }
813 // lib.string.modifiers
815 wxString
& append(const wxString
& str
)
816 { *this += str
; return *this; }
817 // append elements str[pos], ..., str[pos+n]
818 wxString
& append(const wxString
& str
, size_t pos
, size_t n
)
819 { ConcatSelf(n
, str
.c_str() + pos
); return *this; }
820 // append first n (or all if n == npos) characters of sz
821 wxString
& append(const wxChar
*sz
, size_t n
= npos
)
822 { ConcatSelf(n
== npos
? wxStrlen(sz
) : n
, sz
); return *this; }
824 // append n copies of ch
825 wxString
& append(size_t n
, wxChar ch
) { return Pad(n
, ch
); }
827 // same as `this_string = str'
828 wxString
& assign(const wxString
& str
) { return (*this) = str
; }
829 // same as ` = str[pos..pos + n]
830 wxString
& assign(const wxString
& str
, size_t pos
, size_t n
)
831 { return *this = wxString((const wxChar
*)str
+ pos
, n
); }
832 // same as `= first n (or all if n == npos) characters of sz'
833 wxString
& assign(const wxChar
*sz
, size_t n
= npos
)
834 { return *this = wxString(sz
, n
); }
835 // same as `= n copies of ch'
836 wxString
& assign(size_t n
, wxChar ch
)
837 { return *this = wxString(ch
, n
); }
839 // insert another string
840 wxString
& insert(size_t nPos
, const wxString
& str
);
841 // insert n chars of str starting at nStart (in str)
842 wxString
& insert(size_t nPos
, const wxString
& str
, size_t nStart
, size_t n
)
843 { return insert(nPos
, wxString((const wxChar
*)str
+ nStart
, n
)); }
845 // insert first n (or all if n == npos) characters of sz
846 wxString
& insert(size_t nPos
, const wxChar
*sz
, size_t n
= npos
)
847 { return insert(nPos
, wxString(sz
, n
)); }
848 // insert n copies of ch
849 wxString
& insert(size_t nPos
, size_t n
, wxChar ch
)
850 { return insert(nPos
, wxString(ch
, n
)); }
852 // delete characters from nStart to nStart + nLen
853 wxString
& erase(size_t nStart
= 0, size_t nLen
= npos
);
855 // replaces the substring of length nLen starting at nStart
856 wxString
& replace(size_t nStart
, size_t nLen
, const wxChar
* sz
);
857 // replaces the substring with nCount copies of ch
858 wxString
& replace(size_t nStart
, size_t nLen
, size_t nCount
, wxChar ch
);
859 // replaces a substring with another substring
860 wxString
& replace(size_t nStart
, size_t nLen
,
861 const wxString
& str
, size_t nStart2
, size_t nLen2
);
862 // replaces the substring with first nCount chars of sz
863 wxString
& replace(size_t nStart
, size_t nLen
,
864 const wxChar
* sz
, size_t nCount
);
867 void swap(wxString
& str
);
869 // All find() functions take the nStart argument which specifies the
870 // position to start the search on, the default value is 0. All functions
871 // return npos if there were no match.
874 size_t find(const wxString
& str
, size_t nStart
= 0) const;
876 // VC++ 1.5 can't cope with this syntax.
877 #if !defined(__VISUALC__) || defined(__WIN32__)
878 // find first n characters of sz
879 size_t find(const wxChar
* sz
, size_t nStart
= 0, size_t n
= npos
) const;
882 // Gives a duplicate symbol (presumably a case-insensitivity problem)
883 #if !defined(__BORLANDC__)
884 // find the first occurence of character ch after nStart
885 size_t find(wxChar ch
, size_t nStart
= 0) const;
887 // rfind() family is exactly like find() but works right to left
889 // as find, but from the end
890 size_t rfind(const wxString
& str
, size_t nStart
= npos
) const;
892 // VC++ 1.5 can't cope with this syntax.
893 #if !defined(__VISUALC__) || defined(__WIN32__)
894 // as find, but from the end
895 size_t rfind(const wxChar
* sz
, size_t nStart
= npos
,
896 size_t n
= npos
) const;
897 // as find, but from the end
898 size_t rfind(wxChar ch
, size_t nStart
= npos
) const;
901 // find first/last occurence of any character in the set
903 // as strpbrk() but starts at nStart, returns npos if not found
904 size_t find_first_of(const wxString
& str
, size_t nStart
= 0) const
905 { return find_first_of(str
.c_str(), nStart
); }
907 size_t find_first_of(const wxChar
* sz
, size_t nStart
= 0) const;
908 // same as find(char, size_t)
909 size_t find_first_of(wxChar c
, size_t nStart
= 0) const
910 { return find(c
, nStart
); }
911 // find the last (starting from nStart) char from str in this string
912 size_t find_last_of (const wxString
& str
, size_t nStart
= npos
) const
913 { return find_last_of(str
.c_str(), nStart
); }
915 size_t find_last_of (const wxChar
* sz
, size_t nStart
= npos
) const;
917 size_t find_last_of(wxChar c
, size_t nStart
= npos
) const
918 { return rfind(c
, nStart
); }
920 // find first/last occurence of any character not in the set
922 // as strspn() (starting from nStart), returns npos on failure
923 size_t find_first_not_of(const wxString
& str
, size_t nStart
= 0) const
924 { return find_first_not_of(str
.c_str(), nStart
); }
926 size_t find_first_not_of(const wxChar
* sz
, size_t nStart
= 0) const;
928 size_t find_first_not_of(wxChar ch
, size_t nStart
= 0) const;
930 size_t find_last_not_of(const wxString
& str
, size_t nStart
= npos
) const
931 { return find_first_not_of(str
.c_str(), nStart
); }
933 size_t find_last_not_of(const wxChar
* sz
, size_t nStart
= npos
) const;
935 size_t find_last_not_of(wxChar ch
, size_t nStart
= npos
) const;
937 // All compare functions return -1, 0 or 1 if the [sub]string is less,
938 // equal or greater than the compare() argument.
940 // just like strcmp()
941 int compare(const wxString
& str
) const { return Cmp(str
); }
942 // comparison with a substring
943 int compare(size_t nStart
, size_t nLen
, const wxString
& str
) const
944 { return Mid(nStart
, nLen
).Cmp(str
); }
945 // comparison of 2 substrings
946 int compare(size_t nStart
, size_t nLen
,
947 const wxString
& str
, size_t nStart2
, size_t nLen2
) const
948 { return Mid(nStart
, nLen
).Cmp(str
.Mid(nStart2
, nLen2
)); }
949 // just like strcmp()
950 int compare(const wxChar
* sz
) const { return Cmp(sz
); }
951 // substring comparison with first nCount characters of sz
952 int compare(size_t nStart
, size_t nLen
,
953 const wxChar
* sz
, size_t nCount
= npos
) const
954 { return Mid(nStart
, nLen
).Cmp(wxString(sz
, nCount
)); }
956 // substring extraction
957 wxString
substr(size_t nStart
= 0, size_t nLen
= npos
) const
958 { return Mid(nStart
, nLen
); }
959 #endif // wxSTD_STRING_COMPATIBILITY
962 // ----------------------------------------------------------------------------
963 // The string array uses it's knowledge of internal structure of the wxString
964 // class to optimize string storage. Normally, we would store pointers to
965 // string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
966 // sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
967 // really all we need to turn such pointer into a string!
969 // Of course, it can be called a dirty hack, but we use twice less memory and
970 // this approach is also more speed efficient, so it's probably worth it.
972 // Usage notes: when a string is added/inserted, a new copy of it is created,
973 // so the original string may be safely deleted. When a string is retrieved
974 // from the array (operator[] or Item() method), a reference is returned.
975 // ----------------------------------------------------------------------------
977 class WXDLLEXPORT wxArrayString
980 // type of function used by wxArrayString::Sort()
981 typedef int (*CompareFunction
)(const wxString
& first
,
982 const wxString
& second
);
984 // constructors and destructor
985 // default ctor: if autoSort is TRUE, the array is always sorted (in
986 // alphabetical order)
987 wxArrayString(bool autoSort
= FALSE
);
989 wxArrayString(const wxArrayString
& array
);
990 // assignment operator
991 wxArrayString
& operator=(const wxArrayString
& src
);
992 // not virtual, this class should not be derived from
996 // empties the list, but doesn't release memory
998 // empties the list and releases memory
1000 // preallocates memory for given number of items
1001 void Alloc(size_t nCount
);
1002 // minimzes the memory usage (by freeing all extra memory)
1006 // number of elements in the array
1007 size_t GetCount() const { return m_nCount
; }
1009 bool IsEmpty() const { return m_nCount
== 0; }
1010 // number of elements in the array (GetCount is preferred API)
1011 size_t Count() const { return m_nCount
; }
1013 // items access (range checking is done in debug version)
1014 // get item at position uiIndex
1015 wxString
& Item(size_t nIndex
) const
1016 { wxASSERT( nIndex
< m_nCount
); return *(wxString
*)&(m_pItems
[nIndex
]); }
1018 wxString
& operator[](size_t nIndex
) const { return Item(nIndex
); }
1020 wxString
& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
1023 // Search the element in the array, starting from the beginning if
1024 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
1025 // sensitive (default). Returns index of the first item matched or
1027 int Index (const wxChar
*sz
, bool bCase
= TRUE
, bool bFromEnd
= FALSE
) const;
1028 // add new element at the end (if the array is not sorted), return its
1030 size_t Add(const wxString
& str
);
1031 // add new element at given position
1032 void Insert(const wxString
& str
, size_t uiIndex
);
1033 // remove first item matching this value
1034 void Remove(const wxChar
*sz
);
1035 // remove item by index
1036 void Remove(size_t nIndex
);
1037 void RemoveAt(size_t nIndex
) { Remove(nIndex
); }
1040 // sort array elements in alphabetical order (or reversed alphabetical
1041 // order if reverseOrder parameter is TRUE)
1042 void Sort(bool reverseOrder
= FALSE
);
1043 // sort array elements using specified comparaison function
1044 void Sort(CompareFunction compareFunction
);
1047 // compare two arrays case sensitively
1048 bool operator==(const wxArrayString
& a
) const;
1049 // compare two arrays case sensitively
1050 bool operator!=(const wxArrayString
& a
) const { return !(*this == a
); }
1053 void Copy(const wxArrayString
& src
); // copies the contents of another array
1056 void Grow(); // makes array bigger if needed
1057 void Free(); // free all the strings stored
1059 void DoSort(); // common part of all Sort() variants
1061 size_t m_nSize
, // current size of the array
1062 m_nCount
; // current number of elements
1064 wxChar
**m_pItems
; // pointer to data
1066 bool m_autoSort
; // if TRUE, keep the array always sorted
1069 class WXDLLEXPORT wxSortedArrayString
: public wxArrayString
1072 wxSortedArrayString() : wxArrayString(TRUE
)
1074 wxSortedArrayString(const wxArrayString
& array
) : wxArrayString(TRUE
)
1078 // ---------------------------------------------------------------------------
1079 // wxString comparison functions: operator versions are always case sensitive
1080 // ---------------------------------------------------------------------------
1082 inline bool operator==(const wxString
& s1
, const wxString
& s2
)
1083 { return (s1
.Len() == s2
.Len()) && (s1
.Cmp(s2
) == 0); }
1084 inline bool operator==(const wxString
& s1
, const wxChar
* s2
)
1085 { return s1
.Cmp(s2
) == 0; }
1086 inline bool operator==(const wxChar
* s1
, const wxString
& s2
)
1087 { return s2
.Cmp(s1
) == 0; }
1088 inline bool operator!=(const wxString
& s1
, const wxString
& s2
)
1089 { return (s1
.Len() != s2
.Len()) || (s1
.Cmp(s2
) != 0); }
1090 inline bool operator!=(const wxString
& s1
, const wxChar
* s2
)
1091 { return s1
.Cmp(s2
) != 0; }
1092 inline bool operator!=(const wxChar
* s1
, const wxString
& s2
)
1093 { return s2
.Cmp(s1
) != 0; }
1094 inline bool operator< (const wxString
& s1
, const wxString
& s2
)
1095 { return s1
.Cmp(s2
) < 0; }
1096 inline bool operator< (const wxString
& s1
, const wxChar
* s2
)
1097 { return s1
.Cmp(s2
) < 0; }
1098 inline bool operator< (const wxChar
* s1
, const wxString
& s2
)
1099 { return s2
.Cmp(s1
) > 0; }
1100 inline bool operator> (const wxString
& s1
, const wxString
& s2
)
1101 { return s1
.Cmp(s2
) > 0; }
1102 inline bool operator> (const wxString
& s1
, const wxChar
* s2
)
1103 { return s1
.Cmp(s2
) > 0; }
1104 inline bool operator> (const wxChar
* s1
, const wxString
& s2
)
1105 { return s2
.Cmp(s1
) < 0; }
1106 inline bool operator<=(const wxString
& s1
, const wxString
& s2
)
1107 { return s1
.Cmp(s2
) <= 0; }
1108 inline bool operator<=(const wxString
& s1
, const wxChar
* s2
)
1109 { return s1
.Cmp(s2
) <= 0; }
1110 inline bool operator<=(const wxChar
* s1
, const wxString
& s2
)
1111 { return s2
.Cmp(s1
) >= 0; }
1112 inline bool operator>=(const wxString
& s1
, const wxString
& s2
)
1113 { return s1
.Cmp(s2
) >= 0; }
1114 inline bool operator>=(const wxString
& s1
, const wxChar
* s2
)
1115 { return s1
.Cmp(s2
) >= 0; }
1116 inline bool operator>=(const wxChar
* s1
, const wxString
& s2
)
1117 { return s2
.Cmp(s1
) <= 0; }
1119 // comparison with char
1120 inline bool operator==(wxChar c
, const wxString
& s
) { return s
.IsSameAs(c
); }
1121 inline bool operator==(const wxString
& s
, wxChar c
) { return s
.IsSameAs(c
); }
1122 inline bool operator!=(wxChar c
, const wxString
& s
) { return !s
.IsSameAs(c
); }
1123 inline bool operator!=(const wxString
& s
, wxChar c
) { return !s
.IsSameAs(c
); }
1126 inline bool operator==(const wxString
& s1
, const wxWCharBuffer
& s2
)
1127 { return (s1
.Cmp((const wchar_t *)s2
) == 0); }
1128 inline bool operator==(const wxWCharBuffer
& s1
, const wxString
& s2
)
1129 { return (s2
.Cmp((const wchar_t *)s1
) == 0); }
1130 inline bool operator!=(const wxString
& s1
, const wxWCharBuffer
& s2
)
1131 { return (s1
.Cmp((const wchar_t *)s2
) != 0); }
1132 inline bool operator!=(const wxWCharBuffer
& s1
, const wxString
& s2
)
1133 { return (s2
.Cmp((const wchar_t *)s1
) != 0); }
1134 #else // !wxUSE_UNICODE
1135 inline bool operator==(const wxString
& s1
, const wxCharBuffer
& s2
)
1136 { return (s1
.Cmp((const char *)s2
) == 0); }
1137 inline bool operator==(const wxCharBuffer
& s1
, const wxString
& s2
)
1138 { return (s2
.Cmp((const char *)s1
) == 0); }
1139 inline bool operator!=(const wxString
& s1
, const wxCharBuffer
& s2
)
1140 { return (s1
.Cmp((const char *)s2
) != 0); }
1141 inline bool operator!=(const wxCharBuffer
& s1
, const wxString
& s2
)
1142 { return (s2
.Cmp((const char *)s1
) != 0); }
1143 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1145 wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
1146 wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
1147 wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
1148 wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
1149 wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
1151 inline wxString
operator+(const wxString
& string
, const wxWCharBuffer
& buf
)
1152 { return string
+ (const wchar_t *)buf
; }
1153 inline wxString
operator+(const wxWCharBuffer
& buf
, const wxString
& string
)
1154 { return (const wchar_t *)buf
+ string
; }
1155 #else // !wxUSE_UNICODE
1156 inline wxString
operator+(const wxString
& string
, const wxCharBuffer
& buf
)
1157 { return string
+ (const char *)buf
; }
1158 inline wxString
operator+(const wxCharBuffer
& buf
, const wxString
& string
)
1159 { return (const char *)buf
+ string
; }
1160 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1162 // ---------------------------------------------------------------------------
1163 // Implementation only from here until the end of file
1164 // ---------------------------------------------------------------------------
1166 // don't pollute the library user's name space
1167 #undef ASSERT_VALID_INDEX
1169 #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
1171 #include "wx/ioswrap.h"
1173 WXDLLEXPORT wxSTD istream
& operator>>(wxSTD istream
&, wxString
&);
1174 WXDLLEXPORT wxSTD ostream
& operator<<(wxSTD ostream
&, const wxString
&);
1176 #endif // wxSTD_STRING_COMPATIBILITY
1178 #endif // _WX_WXSTRINGH__