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 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_WXSTRINGH__
13 #define _WX_WXSTRINGH__
16 #pragma interface "string.h"
30 #include <strings.h> // for strcasecmp()
36 #ifdef WXSTRING_IS_WXOBJECT
37 #include "wx/object.h"
42 #include "wx/wxchar.h"
43 #include "wx/buffer.h"
46 Efficient string class [more or less] compatible with MFC CString,
47 wxWindows version 1 wxString and std::string and some handy functions
48 missing from string.h.
51 // ---------------------------------------------------------------------------
53 // ---------------------------------------------------------------------------
55 // compile the std::string compatibility functions if defined
56 #define wxSTD_STRING_COMPATIBILITY
58 // define to derive wxString from wxObject
59 #ifdef WXSTRING_IS_WXOBJECT
60 #undef WXSTRING_IS_WXOBJECT
63 // maximum possible length for a string means "take all string" everywhere
64 // (as sizeof(StringData) is unknown here we substract 100)
65 const unsigned int wxSTRING_MAXLEN
= UINT_MAX
- 100;
68 #define WXSTRINGCAST (wxChar *)(const wxChar *)
69 #define WXCSTRINGCAST (wxChar *)(const wxChar *)
70 #define MBSTRINGCAST (char *)(const char *)
71 #define WCSTRINGCAST (wchar_t *)(const wchar_t *)
73 // implementation only
74 #define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
76 // ---------------------------------------------------------------------------
77 // Global functions complementing standard C string library replacements for
78 // strlen() and portable strcasecmp()
79 //---------------------------------------------------------------------------
80 // USE wx* FUNCTIONS IN wx/wxchar.h INSTEAD - THIS IS ONLY FOR BINARY COMPATIBILITY
82 // checks whether the passed in pointer is NULL and if the string is empty
83 inline bool WXDLLEXPORT
IsEmpty(const char *p
) { return (!p
|| !*p
); }
85 // safe version of strlen() (returns 0 if passed NULL pointer)
86 inline size_t WXDLLEXPORT
Strlen(const char *psz
)
87 { return psz
? strlen(psz
) : 0; }
89 // portable strcasecmp/_stricmp
90 inline int WXDLLEXPORT
Stricmp(const char *psz1
, const char *psz2
)
92 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
93 return _stricmp(psz1
, psz2
);
95 return _stricmp(psz1
, psz2
);
96 #elif defined(__SALFORDC__)
97 return stricmp(psz1
, psz2
);
98 #elif defined(__BORLANDC__)
99 return stricmp(psz1
, psz2
);
100 #elif defined(__WATCOMC__)
101 return stricmp(psz1
, psz2
);
102 #elif defined(__UNIX__) || defined(__GNUWIN32__)
103 return strcasecmp(psz1
, psz2
);
104 #elif defined(__MWERKS__) && !defined(__INTEL__)
105 register char c1
, c2
;
107 c1
= tolower(*psz1
++);
108 c2
= tolower(*psz2
++);
109 } while ( c1
&& (c1
== c2
) );
113 // almost all compilers/libraries provide this function (unfortunately under
114 // different names), that's why we don't implement our own which will surely
115 // be more efficient than this code (uncomment to use):
117 register char c1, c2;
119 c1 = tolower(*psz1++);
120 c2 = tolower(*psz2++);
121 } while ( c1 && (c1 == c2) );
126 #error "Please define string case-insensitive compare for your OS/compiler"
127 #endif // OS/compiler
130 // ----------------------------------------------------------------------------
132 // ----------------------------------------------------------------------------
134 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
136 // global pointer to empty string
137 WXDLLEXPORT_DATA(extern const wxChar
*) g_szNul
;
139 // return an empty wxString
140 class WXDLLEXPORT wxString
; // not yet defined
141 inline const wxString
& wxGetEmptyString() { return *(wxString
*)&g_szNul
; }
143 // ---------------------------------------------------------------------------
144 // string data prepended with some housekeeping info (used by wxString class),
145 // is never used directly (but had to be put here to allow inlining)
146 // ---------------------------------------------------------------------------
147 struct WXDLLEXPORT wxStringData
149 int nRefs
; // reference count
150 size_t nDataLength
, // actual string length
151 nAllocLength
; // allocated memory size
153 // mimics declaration 'wxChar data[nAllocLength]'
154 wxChar
* data() const { return (wxChar
*)(this + 1); }
156 // empty string has a special ref count so it's never deleted
157 bool IsEmpty() const { return (nRefs
== -1); }
158 bool IsShared() const { return (nRefs
> 1); }
161 void Lock() { if ( !IsEmpty() ) nRefs
++; }
162 void Unlock() { if ( !IsEmpty() && --nRefs
== 0) free(this); }
164 // if we had taken control over string memory (GetWriteBuf), it's
165 // intentionally put in invalid state
166 void Validate(bool b
) { nRefs
= (b
? 1 : 0); }
167 bool IsValid() const { return (nRefs
!= 0); }
170 // ---------------------------------------------------------------------------
171 // types of multibyte<->Unicode conversions
172 // ---------------------------------------------------------------------------
174 class WXDLLEXPORT wxMBConv
177 virtual size_t MB2WC(wchar_t *buf
, const char *psz
, size_t n
) const;
178 virtual size_t WC2MB(char *buf
, const wchar_t *psz
, size_t n
) const;
179 const wxWCharBuffer
cMB2WC(const char *psz
) const
182 size_t nLen
= MB2WC((wchar_t *) NULL
, psz
, 0);
183 wxWCharBuffer
buf(nLen
);
184 MB2WC(WCSTRINGCAST buf
, psz
, nLen
);
186 } else return wxWCharBuffer((wchar_t *) NULL
);
188 const wxCharBuffer
cWC2MB(const wchar_t *psz
) const
191 size_t nLen
= WC2MB((char *) NULL
, psz
, 0);
192 wxCharBuffer
buf(nLen
);
193 WC2MB(MBSTRINGCAST buf
, psz
, nLen
);
195 } else return wxCharBuffer((char *) NULL
);
198 const wxWCharBuffer
cMB2WX(const char *psz
) const { return cMB2WC(psz
); }
199 const wxCharBuffer
cWX2MB(const wchar_t *psz
) const { return cWC2MB(psz
); }
200 const wchar_t* cWC2WX(const wchar_t *psz
) const { return psz
; }
201 const wchar_t* cMB2WC(const wchar_t *psz
) const { return psz
; }
203 const char* cMB2WX(const char *psz
) const { return psz
; }
204 const char* cWX2MB(const char *psz
) const { return psz
; }
205 const wxCharBuffer
cWC2WX(const wchar_t *psz
) const { return cWC2MB(psz
); }
206 const wxWCharBuffer
cWX2WC(const char *psz
) const { return cMB2WC(psz
); }
209 WXDLLEXPORT_DATA(extern wxMBConv
) wxConvLibc
;
210 #define wxConv_libc wxConvLibc
212 #define wxANOTHER_MBCONV(type) \
213 class type : public wxMBConv { \
215 virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const; \
216 virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const; \
219 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvFile
)) wxConvFile
;
220 #define wxConv_file wxConvFile
221 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvUTF7
)) wxConvUTF7
;
222 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvUTF8
)) wxConvUTF8
;
223 #define wxConv_UTF8 wxConvUTF8
224 #if defined(__WXGTK12__)
225 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvGdk
)) wxConvGdk
;
226 #define wxConv_gdk wxConvGdk
229 class wxCharacterSet
;
230 class WXDLLEXPORT wxCSConv
: public wxMBConv
234 wxCharacterSet
*m_cset
;
236 void SetName(const wxChar
*charset
);
238 wxCSConv(const wxChar
*charset
);
241 virtual size_t MB2WC(wchar_t *buf
, const char *psz
, size_t n
) const;
242 virtual size_t WC2MB(char *buf
, const wchar_t *psz
, size_t n
) const;
245 WXDLLEXPORT_DATA(extern wxCSConv
) wxConvLocal
;
246 #define wxConv_local wxConvLocal
248 WXDLLEXPORT_DATA(extern wxMBConv
*) wxConvCurrent
;
249 #define wxConv_current wxConvCurrent
251 // filenames are multibyte on Unix and probably widechar on Windows?
252 #if defined(__UNIX__) || defined(__BORLANDC__)
259 #define wxFNCONV(name) wxConvFile.cWX2MB(name)
260 #define FNSTRINGCAST MBSTRINGCAST
262 #define wxFNCONV(name) name
263 #define FNSTRINGCAST WXSTRINGCAST
265 #else//!wxUSE_WCHAR_T
266 class WXDLLEXPORT wxMBConv
{
267 const char* cMB2WX(const char *psz
) const { return psz
; }
268 const char* cWX2MB(const char *psz
) const { return psz
; }
270 WXDLLEXPORT_DATA(extern wxMBConv
) wxConvLibc
, wxConvFile
;
271 #define wxConv_libc wxConvLibc
272 #define wxConv_file wxConvFile
273 WXDLLEXPORT_DATA(extern wxMBConv
*) wxConvCurrent
;
274 #define wxConv_current wxConvCurrent
275 #define wxFNCONV(name) name
276 #define FNSTRINGCAST WXSTRINGCAST
277 #endif//wxUSE_WCHAR_T
279 // ---------------------------------------------------------------------------
280 // This is (yet another one) String class for C++ programmers. It doesn't use
281 // any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
282 // thus you should be able to compile it with practicaly any C++ compiler.
283 // This class uses copy-on-write technique, i.e. identical strings share the
284 // same memory as long as neither of them is changed.
286 // This class aims to be as compatible as possible with the new standard
287 // std::string class, but adds some additional functions and should be at
288 // least as efficient than the standard implementation.
290 // Performance note: it's more efficient to write functions which take "const
291 // String&" arguments than "const char *" if you assign the argument to
294 // It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
297 // - ressource support (string tables in ressources)
298 // - more wide character (UNICODE) support
299 // - regular expressions support
300 // ---------------------------------------------------------------------------
302 #ifdef WXSTRING_IS_WXOBJECT
303 class WXDLLEXPORT wxString
: public wxObject
305 DECLARE_DYNAMIC_CLASS(wxString
)
306 #else //WXSTRING_IS_WXOBJECT
307 class WXDLLEXPORT wxString
309 #endif //WXSTRING_IS_WXOBJECT
311 friend class WXDLLEXPORT wxArrayString
;
313 // NB: special care was taken in arranging the member functions in such order
314 // that all inline functions can be effectively inlined, verify that all
315 // performace critical functions are still inlined if you change order!
317 // points to data preceded by wxStringData structure with ref count info
320 // accessor to string data
321 wxStringData
* GetStringData() const { return (wxStringData
*)m_pchData
- 1; }
323 // string (re)initialization functions
324 // initializes the string to the empty value (must be called only from
325 // ctors, use Reinit() otherwise)
326 void Init() { m_pchData
= (wxChar
*)g_szNul
; }
327 // initializaes the string with (a part of) C-string
328 void InitWith(const wxChar
*psz
, size_t nPos
= 0, size_t nLen
= wxSTRING_MAXLEN
);
329 // as Init, but also frees old data
330 void Reinit() { GetStringData()->Unlock(); Init(); }
333 // allocates memory for string of lenght nLen
334 void AllocBuffer(size_t nLen
);
335 // copies data to another string
336 void AllocCopy(wxString
&, int, int) const;
337 // effectively copies data to string
338 void AssignCopy(size_t, const wxChar
*);
340 // append a (sub)string
341 void ConcatSelf(int nLen
, const wxChar
*src
);
343 // functions called before writing to the string: they copy it if there
344 // are other references to our data (should be the only owner when writing)
345 void CopyBeforeWrite();
346 void AllocBeforeWrite(size_t);
348 // this method is not implemented - there is _no_ conversion from int to
349 // string, you're doing something wrong if the compiler wants to call it!
351 // try `s << i' or `s.Printf("%d", i)' instead
356 // constructors and destructor
357 // ctor for an empty string
358 wxString() { Init(); }
360 wxString(const wxString
& stringSrc
)
362 wxASSERT( stringSrc
.GetStringData()->IsValid() );
364 if ( stringSrc
.IsEmpty() ) {
365 // nothing to do for an empty string
369 m_pchData
= stringSrc
.m_pchData
; // share same data
370 GetStringData()->Lock(); // => one more copy
373 // string containing nRepeat copies of ch
374 wxString(wxChar ch
, size_t nRepeat
= 1);
375 // ctor takes first nLength characters from C string
376 // (default value of wxSTRING_MAXLEN means take all the string)
377 wxString(const wxChar
*psz
, size_t nLength
= wxSTRING_MAXLEN
)
378 { InitWith(psz
, 0, nLength
); }
380 // from multibyte string
381 // (NB: nLength is right now number of Unicode characters, not
382 // characters in psz! So try not to use it yet!)
383 wxString(const char *psz
, wxMBConv
& conv
= wxConvLibc
, size_t nLength
= wxSTRING_MAXLEN
);
384 // from wxWCharBuffer (i.e. return from wxGetString)
385 wxString(const wxWCharBuffer
& psz
)
386 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
388 // from C string (for compilers using unsigned char)
389 wxString(const unsigned char* psz
, size_t nLength
= wxSTRING_MAXLEN
)
390 { InitWith((const char*)psz
, 0, nLength
); }
391 // from multibyte string
392 wxString(const char *psz
, wxMBConv
& WXUNUSED(conv
), size_t nLength
= wxSTRING_MAXLEN
)
393 { InitWith(psz
, 0, nLength
); }
395 // from wide (Unicode) string
396 wxString(const wchar_t *pwz
);
399 wxString(const wxCharBuffer
& psz
)
400 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
402 // dtor is not virtual, this class must not be inherited from!
403 ~wxString() { GetStringData()->Unlock(); }
405 // generic attributes & operations
406 // as standard strlen()
407 size_t Len() const { return GetStringData()->nDataLength
; }
408 // string contains any characters?
409 bool IsEmpty() const { return Len() == 0; }
410 // empty string is "FALSE", so !str will return TRUE
411 bool operator!() const { return IsEmpty(); }
412 // empty string contents
419 wxASSERT( GetStringData()->nDataLength
== 0 );
421 // empty the string and free memory
424 if ( !GetStringData()->IsEmpty() )
427 wxASSERT( GetStringData()->nDataLength
== 0 ); // should be empty
428 wxASSERT( GetStringData()->nAllocLength
== 0 ); // and not own any memory
433 bool IsAscii() const;
435 bool IsNumber() const;
439 // data access (all indexes are 0 based)
441 wxChar
GetChar(size_t n
) const
442 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
444 wxChar
& GetWritableChar(size_t n
)
445 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
447 void SetChar(size_t n
, wxChar ch
)
448 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); m_pchData
[n
] = ch
; }
450 // get last character
452 { wxASSERT( !IsEmpty() ); return m_pchData
[Len() - 1]; }
453 // get writable last character
455 { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData
[Len()-1]; }
457 // under Unix it is tested with configure, assume it works on other
458 // platforms (there might be overloading problems if size_t and int are
460 #if !defined(__UNIX__) || wxUSE_SIZE_T_STRING_OPERATOR
461 // operator version of GetChar
462 wxChar
operator[](size_t n
) const
463 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
466 // operator version of GetChar
467 wxChar
operator[](int n
) const
468 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
469 // operator version of GetWritableChar
470 wxChar
& operator[](size_t n
)
471 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
473 // implicit conversion to C string
474 operator const wxChar
*() const { return m_pchData
; }
475 // explicit conversion to C string (use this with printf()!)
476 const wxChar
* c_str() const { return m_pchData
; }
477 // (and this with [wx]Printf()!)
478 const wxChar
* wx_str() const { return m_pchData
; }
480 const wxChar
* GetData() const { return m_pchData
; }
482 const wxCharBuffer
mb_str(wxMBConv
& conv
= wxConvLibc
) const { return conv
.cWC2MB(m_pchData
); }
483 const wxChar
* wc_str(wxMBConv
& WXUNUSED(conv
) = wxConvLibc
) const { return m_pchData
; }
485 const wxCharBuffer
fn_str() const { return mb_str(wxConvFile
); }
487 const wxChar
* fn_str() const { return m_pchData
; }
490 const wxChar
* mb_str(wxMBConv
& WXUNUSED(conv
) = wxConvLibc
) const { return m_pchData
; }
492 const wxWCharBuffer
wc_str(wxMBConv
& conv
) const { return conv
.cMB2WC(m_pchData
); }
494 const wxChar
* fn_str() const { return m_pchData
; }
497 const wxWX2MBbuf
mbc_str() const { return mb_str(*wxConvCurrent
); }
499 // overloaded assignment
500 // from another wxString
501 wxString
& operator=(const wxString
& stringSrc
);
503 wxString
& operator=(wxChar ch
);
505 wxString
& operator=(const wxChar
*psz
);
507 // from wxWCharBuffer
508 wxString
& operator=(const wxWCharBuffer
& psz
) { return operator=((const wchar_t *)psz
); }
510 // from another kind of C string
511 wxString
& operator=(const unsigned char* psz
);
513 // from a wide string
514 wxString
& operator=(const wchar_t *pwz
);
517 wxString
& operator=(const wxCharBuffer
& psz
) { return operator=((const char *)psz
); }
520 // string concatenation
521 // in place concatenation
523 Concatenate and return the result. Note that the left to right
524 associativity of << allows to write things like "str << str1 << str2
525 << ..." (unlike with +=)
528 wxString
& operator<<(const wxString
& s
)
530 wxASSERT( s
.GetStringData()->IsValid() );
532 ConcatSelf(s
.Len(), s
);
535 // string += C string
536 wxString
& operator<<(const wxChar
*psz
)
537 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
539 wxString
& operator<<(wxChar ch
) { ConcatSelf(1, &ch
); return *this; }
542 void operator+=(const wxString
& s
) { (void)operator<<(s
); }
543 // string += C string
544 void operator+=(const wxChar
*psz
) { (void)operator<<(psz
); }
546 void operator+=(wxChar ch
) { (void)operator<<(ch
); }
548 // string += buffer (i.e. from wxGetString)
550 wxString
& operator<<(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); return *this; }
551 void operator+=(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); }
553 wxString
& operator<<(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); return *this; }
554 void operator+=(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); }
557 // string += C string
558 wxString
& Append(const wxChar
* psz
)
559 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
560 // append count copies of given character
561 wxString
& Append(wxChar ch
, size_t count
= 1u)
562 { wxString
str(ch
, count
); return *this << str
; }
564 // prepend a string, return the string itself
565 wxString
& Prepend(const wxString
& str
)
566 { *this = str
+ *this; return *this; }
568 // non-destructive concatenation
570 friend wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
572 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
574 friend wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
576 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
578 friend wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
580 // stream-like functions
581 // insert an int into string
582 wxString
& operator<<(int i
);
583 // insert a float into string
584 wxString
& operator<<(float f
);
585 // insert a double into string
586 wxString
& operator<<(double d
);
589 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
590 int Cmp(const wxChar
*psz
) const { return wxStrcmp(c_str(), psz
); }
591 // same as Cmp() but not case-sensitive
592 int CmpNoCase(const wxChar
*psz
) const { return wxStricmp(c_str(), psz
); }
593 // test for the string equality, either considering case or not
594 // (if compareWithCase then the case matters)
595 bool IsSameAs(const wxChar
*psz
, bool compareWithCase
= TRUE
) const
596 { return (compareWithCase
? Cmp(psz
) : CmpNoCase(psz
)) == 0; }
598 // simple sub-string extraction
599 // return substring starting at nFirst of length nCount (or till the end
600 // if nCount = default value)
601 wxString
Mid(size_t nFirst
, size_t nCount
= wxSTRING_MAXLEN
) const;
603 // operator version of Mid()
604 wxString
operator()(size_t start
, size_t len
) const
605 { return Mid(start
, len
); }
607 // get first nCount characters
608 wxString
Left(size_t nCount
) const;
609 // get last nCount characters
610 wxString
Right(size_t nCount
) const;
611 // get all characters before the first occurence of ch
612 // (returns the whole string if ch not found)
613 wxString
BeforeFirst(wxChar ch
) const;
614 // get all characters before the last occurence of ch
615 // (returns empty string if ch not found)
616 wxString
BeforeLast(wxChar ch
) const;
617 // get all characters after the first occurence of ch
618 // (returns empty string if ch not found)
619 wxString
AfterFirst(wxChar ch
) const;
620 // get all characters after the last occurence of ch
621 // (returns the whole string if ch not found)
622 wxString
AfterLast(wxChar ch
) const;
624 // for compatibility only, use more explicitly named functions above
625 wxString
Before(wxChar ch
) const { return BeforeLast(ch
); }
626 wxString
After(wxChar ch
) const { return AfterFirst(ch
); }
629 // convert to upper case in place, return the string itself
630 wxString
& MakeUpper();
631 // convert to upper case, return the copy of the string
632 // Here's something to remember: BC++ doesn't like returns in inlines.
633 wxString
Upper() const ;
634 // convert to lower case in place, return the string itself
635 wxString
& MakeLower();
636 // convert to lower case, return the copy of the string
637 wxString
Lower() const ;
639 // trimming/padding whitespace (either side) and truncating
640 // remove spaces from left or from right (default) side
641 wxString
& Trim(bool bFromRight
= TRUE
);
642 // add nCount copies chPad in the beginning or at the end (default)
643 wxString
& Pad(size_t nCount
, wxChar chPad
= _T(' '), bool bFromRight
= TRUE
);
644 // truncate string to given length
645 wxString
& Truncate(size_t uiLen
);
647 // searching and replacing
648 // searching (return starting index, or -1 if not found)
649 int Find(wxChar ch
, bool bFromEnd
= FALSE
) const; // like strchr/strrchr
650 // searching (return starting index, or -1 if not found)
651 int Find(const wxChar
*pszSub
) const; // like strstr
652 // replace first (or all of bReplaceAll) occurences of substring with
653 // another string, returns the number of replacements made
654 size_t Replace(const wxChar
*szOld
,
656 bool bReplaceAll
= TRUE
);
658 // check if the string contents matches a mask containing '*' and '?'
659 bool Matches(const wxChar
*szMask
) const;
661 // formated input/output
662 // as sprintf(), returns the number of characters written or < 0 on error
663 int Printf(const wxChar
*pszFormat
, ...);
664 // as vprintf(), returns the number of characters written or < 0 on error
665 int PrintfV(const wxChar
* pszFormat
, va_list argptr
);
667 // raw access to string memory
668 // ensure that string has space for at least nLen characters
669 // only works if the data of this string is not shared
670 void Alloc(size_t nLen
);
671 // minimize the string's memory
672 // only works if the data of this string is not shared
674 // get writable buffer of at least nLen bytes. Unget() *must* be called
675 // a.s.a.p. to put string back in a reasonable state!
676 wxChar
*GetWriteBuf(size_t nLen
);
677 // call this immediately after GetWriteBuf() has been used
678 void UngetWriteBuf();
680 // wxWindows version 1 compatibility functions
683 wxString
SubString(size_t from
, size_t to
) const
684 { return Mid(from
, (to
- from
+ 1)); }
685 // values for second parameter of CompareTo function
686 enum caseCompare
{exact
, ignoreCase
};
687 // values for first parameter of Strip function
688 enum stripType
{leading
= 0x1, trailing
= 0x2, both
= 0x3};
691 int sprintf(const wxChar
*pszFormat
, ...);
694 inline int CompareTo(const wxChar
* psz
, caseCompare cmp
= exact
) const
695 { return cmp
== exact
? Cmp(psz
) : CmpNoCase(psz
); }
698 size_t Length() const { return Len(); }
699 // Count the number of characters
700 int Freq(wxChar ch
) const;
702 void LowerCase() { MakeLower(); }
704 void UpperCase() { MakeUpper(); }
705 // use Trim except that it doesn't change this string
706 wxString
Strip(stripType w
= trailing
) const;
708 // use Find (more general variants not yet supported)
709 size_t Index(const wxChar
* psz
) const { return Find(psz
); }
710 size_t Index(wxChar ch
) const { return Find(ch
); }
712 wxString
& Remove(size_t pos
) { return Truncate(pos
); }
713 wxString
& RemoveLast() { return Truncate(Len() - 1); }
715 wxString
& Remove(size_t nStart
, size_t nLen
) { return erase( nStart
, nLen
); }
718 int First( const wxChar ch
) const { return Find(ch
); }
719 int First( const wxChar
* psz
) const { return Find(psz
); }
720 int First( const wxString
&str
) const { return Find(str
); }
721 int Last( const wxChar ch
) const { return Find(ch
, TRUE
); }
722 bool Contains(const wxString
& str
) const { return Find(str
) != -1; }
725 bool IsNull() const { return IsEmpty(); }
727 #ifdef wxSTD_STRING_COMPATIBILITY
728 // std::string compatibility functions
730 // an 'invalid' value for string index
731 static const size_t npos
;
734 // take nLen chars starting at nPos
735 wxString(const wxString
& str
, size_t nPos
, size_t nLen
)
737 wxASSERT( str
.GetStringData()->IsValid() );
738 InitWith(str
.c_str(), nPos
, nLen
== npos
? 0 : nLen
);
740 // take all characters from pStart to pEnd
741 wxString(const void *pStart
, const void *pEnd
);
743 // lib.string.capacity
744 // return the length of the string
745 size_t size() const { return Len(); }
746 // return the length of the string
747 size_t length() const { return Len(); }
748 // return the maximum size of the string
749 size_t max_size() const { return wxSTRING_MAXLEN
; }
750 // resize the string, filling the space with c if c != 0
751 void resize(size_t nSize
, wxChar ch
= _T('\0'));
752 // delete the contents of the string
753 void clear() { Empty(); }
754 // returns true if the string is empty
755 bool empty() const { return IsEmpty(); }
758 // return the character at position n
759 wxChar
at(size_t n
) const { return GetChar(n
); }
760 // returns the writable character at position n
761 wxChar
& at(size_t n
) { return GetWritableChar(n
); }
763 // lib.string.modifiers
765 wxString
& append(const wxString
& str
)
766 { *this += str
; return *this; }
767 // append elements str[pos], ..., str[pos+n]
768 wxString
& append(const wxString
& str
, size_t pos
, size_t n
)
769 { ConcatSelf(n
, str
.c_str() + pos
); return *this; }
770 // append first n (or all if n == npos) characters of sz
771 wxString
& append(const wxChar
*sz
, size_t n
= npos
)
772 { ConcatSelf(n
== npos
? wxStrlen(sz
) : n
, sz
); return *this; }
774 // append n copies of ch
775 wxString
& append(size_t n
, wxChar ch
) { return Pad(n
, ch
); }
777 // same as `this_string = str'
778 wxString
& assign(const wxString
& str
) { return (*this) = str
; }
779 // same as ` = str[pos..pos + n]
780 wxString
& assign(const wxString
& str
, size_t pos
, size_t n
)
781 { return *this = wxString((const wxChar
*)str
+ pos
, n
); }
782 // same as `= first n (or all if n == npos) characters of sz'
783 wxString
& assign(const wxChar
*sz
, size_t n
= npos
)
784 { return *this = wxString(sz
, n
); }
785 // same as `= n copies of ch'
786 wxString
& assign(size_t n
, wxChar ch
)
787 { return *this = wxString(ch
, n
); }
789 // insert another string
790 wxString
& insert(size_t nPos
, const wxString
& str
);
791 // insert n chars of str starting at nStart (in str)
792 wxString
& insert(size_t nPos
, const wxString
& str
, size_t nStart
, size_t n
)
793 { return insert(nPos
, wxString((const wxChar
*)str
+ nStart
, n
)); }
795 // insert first n (or all if n == npos) characters of sz
796 wxString
& insert(size_t nPos
, const wxChar
*sz
, size_t n
= npos
)
797 { return insert(nPos
, wxString(sz
, n
)); }
798 // insert n copies of ch
799 wxString
& insert(size_t nPos
, size_t n
, wxChar ch
)
800 { return insert(nPos
, wxString(ch
, n
)); }
802 // delete characters from nStart to nStart + nLen
803 wxString
& erase(size_t nStart
= 0, size_t nLen
= npos
);
805 // replaces the substring of length nLen starting at nStart
806 wxString
& replace(size_t nStart
, size_t nLen
, const wxChar
* sz
);
807 // replaces the substring with nCount copies of ch
808 wxString
& replace(size_t nStart
, size_t nLen
, size_t nCount
, wxChar ch
);
809 // replaces a substring with another substring
810 wxString
& replace(size_t nStart
, size_t nLen
,
811 const wxString
& str
, size_t nStart2
, size_t nLen2
);
812 // replaces the substring with first nCount chars of sz
813 wxString
& replace(size_t nStart
, size_t nLen
,
814 const wxChar
* sz
, size_t nCount
);
817 void swap(wxString
& str
);
819 // All find() functions take the nStart argument which specifies the
820 // position to start the search on, the default value is 0. All functions
821 // return npos if there were no match.
824 size_t find(const wxString
& str
, size_t nStart
= 0) const;
826 // VC++ 1.5 can't cope with this syntax.
827 #if !defined(__VISUALC__) || defined(__WIN32__)
828 // find first n characters of sz
829 size_t find(const wxChar
* sz
, size_t nStart
= 0, size_t n
= npos
) const;
832 // Gives a duplicate symbol (presumably a case-insensitivity problem)
833 #if !defined(__BORLANDC__)
834 // find the first occurence of character ch after nStart
835 size_t find(wxChar ch
, size_t nStart
= 0) const;
837 // rfind() family is exactly like find() but works right to left
839 // as find, but from the end
840 size_t rfind(const wxString
& str
, size_t nStart
= npos
) const;
842 // VC++ 1.5 can't cope with this syntax.
843 #if !defined(__VISUALC__) || defined(__WIN32__)
844 // as find, but from the end
845 size_t rfind(const wxChar
* sz
, size_t nStart
= npos
,
846 size_t n
= npos
) const;
847 // as find, but from the end
848 size_t rfind(wxChar ch
, size_t nStart
= npos
) const;
851 // find first/last occurence of any character in the set
854 size_t find_first_of(const wxString
& str
, size_t nStart
= 0) const;
856 size_t find_first_of(const wxChar
* sz
, size_t nStart
= 0) const;
857 // same as find(char, size_t)
858 size_t find_first_of(wxChar c
, size_t nStart
= 0) const;
860 size_t find_last_of (const wxString
& str
, size_t nStart
= npos
) const;
862 size_t find_last_of (const wxChar
* s
, size_t nStart
= npos
) const;
863 // same as rfind(char, size_t)
864 size_t find_last_of (wxChar c
, size_t nStart
= npos
) const;
866 // find first/last occurence of any character not in the set
869 size_t find_first_not_of(const wxString
& str
, size_t nStart
= 0) const;
871 size_t find_first_not_of(const wxChar
* s
, size_t nStart
= 0) const;
873 size_t find_first_not_of(wxChar ch
, size_t nStart
= 0) const;
875 size_t find_last_not_of(const wxString
& str
, size_t nStart
=npos
) const;
877 size_t find_last_not_of(const wxChar
* s
, size_t nStart
= npos
) const;
879 size_t find_last_not_of(wxChar ch
, size_t nStart
= npos
) const;
881 // All compare functions return -1, 0 or 1 if the [sub]string is less,
882 // equal or greater than the compare() argument.
884 // just like strcmp()
885 int compare(const wxString
& str
) const { return Cmp(str
); }
886 // comparison with a substring
887 int compare(size_t nStart
, size_t nLen
, const wxString
& str
) const;
888 // comparison of 2 substrings
889 int compare(size_t nStart
, size_t nLen
,
890 const wxString
& str
, size_t nStart2
, size_t nLen2
) const;
891 // just like strcmp()
892 int compare(const wxChar
* sz
) const { return Cmp(sz
); }
893 // substring comparison with first nCount characters of sz
894 int compare(size_t nStart
, size_t nLen
,
895 const wxChar
* sz
, size_t nCount
= npos
) const;
897 // substring extraction
898 wxString
substr(size_t nStart
= 0, size_t nLen
= npos
) const;
899 #endif // wxSTD_STRING_COMPATIBILITY
902 // ----------------------------------------------------------------------------
903 // The string array uses it's knowledge of internal structure of the wxString
904 // class to optimize string storage. Normally, we would store pointers to
905 // string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
906 // sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
907 // really all we need to turn such pointer into a string!
909 // Of course, it can be called a dirty hack, but we use twice less memory and
910 // this approach is also more speed efficient, so it's probably worth it.
912 // Usage notes: when a string is added/inserted, a new copy of it is created,
913 // so the original string may be safely deleted. When a string is retrieved
914 // from the array (operator[] or Item() method), a reference is returned.
915 // ----------------------------------------------------------------------------
916 class WXDLLEXPORT wxArrayString
919 // type of function used by wxArrayString::Sort()
920 typedef int (*CompareFunction
)(const wxString
& first
,
921 const wxString
& second
);
923 // constructors and destructor
927 wxArrayString(const wxArrayString
& array
);
928 // assignment operator
929 wxArrayString
& operator=(const wxArrayString
& src
);
930 // not virtual, this class should not be derived from
934 // empties the list, but doesn't release memory
936 // empties the list and releases memory
938 // preallocates memory for given number of items
939 void Alloc(size_t nCount
);
940 // minimzes the memory usage (by freeing all extra memory)
944 // number of elements in the array
945 size_t GetCount() const { return m_nCount
; }
947 bool IsEmpty() const { return m_nCount
== 0; }
948 // number of elements in the array (GetCount is preferred API)
949 size_t Count() const { return m_nCount
; }
951 // items access (range checking is done in debug version)
952 // get item at position uiIndex
953 wxString
& Item(size_t nIndex
) const
954 { wxASSERT( nIndex
< m_nCount
); return *(wxString
*)&(m_pItems
[nIndex
]); }
956 wxString
& operator[](size_t nIndex
) const { return Item(nIndex
); }
958 wxString
& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
961 // Search the element in the array, starting from the beginning if
962 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
963 // sensitive (default). Returns index of the first item matched or
965 int Index (const wxChar
*sz
, bool bCase
= TRUE
, bool bFromEnd
= FALSE
) const;
966 // add new element at the end
967 void Add(const wxString
& str
);
968 // add new element at given position
969 void Insert(const wxString
& str
, size_t uiIndex
);
970 // remove first item matching this value
971 void Remove(const wxChar
*sz
);
972 // remove item by index
973 void Remove(size_t nIndex
);
976 // sort array elements in alphabetical order (or reversed alphabetical
977 // order if reverseOrder parameter is TRUE)
978 void Sort(bool reverseOrder
= FALSE
);
979 // sort array elements using specified comparaison function
980 void Sort(CompareFunction compareFunction
);
983 void Grow(); // makes array bigger if needed
984 void Free(); // free the string stored
986 void DoSort(); // common part of all Sort() variants
988 size_t m_nSize
, // current size of the array
989 m_nCount
; // current number of elements
991 wxChar
**m_pItems
; // pointer to data
994 // ---------------------------------------------------------------------------
995 // wxString comparison functions: operator versions are always case sensitive
996 // ---------------------------------------------------------------------------
998 inline bool operator==(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) == 0); }
1000 inline bool operator==(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) == 0); }
1002 inline bool operator==(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) == 0); }
1004 inline bool operator!=(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) != 0); }
1006 inline bool operator!=(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) != 0); }
1008 inline bool operator!=(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) != 0); }
1010 inline bool operator< (const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) < 0); }
1012 inline bool operator< (const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) < 0); }
1014 inline bool operator< (const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) > 0); }
1016 inline bool operator> (const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) > 0); }
1018 inline bool operator> (const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) > 0); }
1020 inline bool operator> (const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) < 0); }
1022 inline bool operator<=(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) <= 0); }
1024 inline bool operator<=(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) <= 0); }
1026 inline bool operator<=(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) >= 0); }
1028 inline bool operator>=(const wxString
& s1
, const wxString
& s2
) { return (s1
.Cmp(s2
) >= 0); }
1030 inline bool operator>=(const wxString
& s1
, const wxChar
* s2
) { return (s1
.Cmp(s2
) >= 0); }
1032 inline bool operator>=(const wxChar
* s1
, const wxString
& s2
) { return (s2
.Cmp(s1
) <= 0); }
1034 wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
1035 wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
1036 wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
1037 wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
1038 wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
1040 inline wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxWCharBuffer
& buf
)
1041 { return string
+ (const wchar_t *)buf
; }
1042 inline wxString WXDLLEXPORT
operator+(const wxWCharBuffer
& buf
, const wxString
& string
)
1043 { return (const wchar_t *)buf
+ string
; }
1045 inline wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxCharBuffer
& buf
)
1046 { return string
+ (const char *)buf
; }
1047 inline wxString WXDLLEXPORT
operator+(const wxCharBuffer
& buf
, const wxString
& string
)
1048 { return (const char *)buf
+ string
; }
1051 // ---------------------------------------------------------------------------
1052 // Implementation only from here until the end of file
1053 // ---------------------------------------------------------------------------
1055 #ifdef wxSTD_STRING_COMPATIBILITY
1057 #include "wx/ioswrap.h"
1059 WXDLLEXPORT istream
& operator>>(istream
& is
, wxString
& str
);
1061 #endif // wxSTD_STRING_COMPATIBILITY
1063 #endif // _WX_WXSTRINGH__