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 WXDLLEXPORT
IsEmpty(const char *p
) { return (!p
|| !*p
); }
125 // safe version of strlen() (returns 0 if passed NULL pointer)
126 inline size_t WXDLLEXPORT
Strlen(const char *psz
)
127 { return psz
? strlen(psz
) : 0; }
129 // portable strcasecmp/_stricmp
130 inline int WXDLLEXPORT
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]; }
404 // operator version of GetChar
405 wxChar
operator[](size_t n
) const
406 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
408 // operator version of GetChar
409 wxChar
operator[](int n
) const
410 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
412 // operator version of GetChar
413 wxChar
operator[](unsigned int n
) const
414 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
417 // operator version of GetWriteableChar
418 wxChar
& operator[](size_t n
)
419 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
421 // operator version of GetWriteableChar
422 wxChar
& operator[](unsigned int n
)
423 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
426 // implicit conversion to C string
427 operator const wxChar
*() const { return m_pchData
; }
428 // explicit conversion to C string (use this with printf()!)
429 const wxChar
* c_str() const { return m_pchData
; }
430 // identical to c_str()
431 const wxChar
* wx_str() const { return m_pchData
; }
432 // identical to c_str()
433 const wxChar
* GetData() const { return m_pchData
; }
435 // conversions with (possible) format convertions: have to return a
436 // buffer with temporary data
438 // the functions defined (in either Unicode or ANSI) mode are mb_str() to
439 // return an ANSI (multibyte) string, wc_str() to return a wide string and
440 // fn_str() to return a string which should be used with the OS APIs
441 // accepting the file names. The return value is always the same, but the
442 // type differs because a function may either return pointer to the buffer
443 // directly or have to use intermediate buffer for translation.
445 const wxCharBuffer
mb_str(wxMBConv
& conv
= wxConvLibc
) const
446 { return conv
.cWC2MB(m_pchData
); }
448 const wxWX2MBbuf
mbc_str() const { return mb_str(*wxConvCurrent
); }
450 const wxChar
* wc_str() const { return m_pchData
; }
452 // for compatibility with !wxUSE_UNICODE version
453 const wxChar
* wc_str(wxMBConv
& WXUNUSED(conv
)) const { return m_pchData
; }
456 const wxCharBuffer
fn_str() const { return mb_str(wxConvFile
); }
458 const wxChar
* fn_str() const { return m_pchData
; }
459 #endif // wxMBFILES/!wxMBFILES
461 const wxChar
* mb_str() const { return m_pchData
; }
463 // for compatibility with wxUSE_UNICODE version
464 const wxChar
* mb_str(wxMBConv
& WXUNUSED(conv
)) const { return m_pchData
; }
466 const wxWX2MBbuf
mbc_str() const { return mb_str(); }
469 const wxWCharBuffer
wc_str(wxMBConv
& conv
) const
470 { return conv
.cMB2WC(m_pchData
); }
471 #endif // wxUSE_WCHAR_T
473 const wxChar
* fn_str() const { return m_pchData
; }
474 #endif // Unicode/ANSI
476 // overloaded assignment
477 // from another wxString
478 wxString
& operator=(const wxString
& stringSrc
);
480 wxString
& operator=(wxChar ch
);
482 wxString
& operator=(const wxChar
*psz
);
484 // from wxWCharBuffer
485 wxString
& operator=(const wxWCharBuffer
& psz
) { return operator=((const wchar_t *)psz
); }
487 // from another kind of C string
488 wxString
& operator=(const unsigned char* psz
);
490 // from a wide string
491 wxString
& operator=(const wchar_t *pwz
);
494 wxString
& operator=(const wxCharBuffer
& psz
) { return operator=((const char *)psz
); }
495 #endif // Unicode/ANSI
497 // string concatenation
498 // in place concatenation
500 Concatenate and return the result. Note that the left to right
501 associativity of << allows to write things like "str << str1 << str2
502 << ..." (unlike with +=)
505 wxString
& operator<<(const wxString
& s
)
507 wxASSERT( s
.GetStringData()->IsValid() );
509 ConcatSelf(s
.Len(), s
);
512 // string += C string
513 wxString
& operator<<(const wxChar
*psz
)
514 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
516 wxString
& operator<<(wxChar ch
) { ConcatSelf(1, &ch
); return *this; }
519 void operator+=(const wxString
& s
) { (void)operator<<(s
); }
520 // string += C string
521 void operator+=(const wxChar
*psz
) { (void)operator<<(psz
); }
523 void operator+=(wxChar ch
) { (void)operator<<(ch
); }
525 // string += buffer (i.e. from wxGetString)
527 wxString
& operator<<(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); return *this; }
528 void operator+=(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); }
530 wxString
& operator<<(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); return *this; }
531 void operator+=(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); }
534 // string += C string
535 wxString
& Append(const wxChar
* psz
)
536 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
537 // append count copies of given character
538 wxString
& Append(wxChar ch
, size_t count
= 1u)
539 { wxString
str(ch
, count
); return *this << str
; }
540 wxString
& Append(const wxChar
* psz
, size_t nLen
)
541 { ConcatSelf(nLen
, psz
); return *this; }
543 // prepend a string, return the string itself
544 wxString
& Prepend(const wxString
& str
)
545 { *this = str
+ *this; return *this; }
547 // non-destructive concatenation
549 friend wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
551 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
553 friend wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
555 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
557 friend wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
559 // stream-like functions
560 // insert an int into string
561 wxString
& operator<<(int i
)
562 { return (*this) << Format(_T("%d"), i
); }
563 // insert an unsigned int into string
564 wxString
& operator<<(unsigned int ui
)
565 { return (*this) << Format(_T("%u"), ui
); }
566 // insert a long into string
567 wxString
& operator<<(long l
)
568 { return (*this) << Format(_T("%ld"), l
); }
569 // insert an unsigned long into string
570 wxString
& operator<<(unsigned long ul
)
571 { return (*this) << Format(_T("%lu"), ul
); }
572 // insert a float into string
573 wxString
& operator<<(float f
)
574 { return (*this) << Format(_T("%f"), f
); }
575 // insert a double into string
576 wxString
& operator<<(double d
)
577 { return (*this) << Format(_T("%g"), d
); }
580 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
581 int Cmp(const wxChar
*psz
) const { return wxStrcmp(c_str(), psz
); }
582 // same as Cmp() but not case-sensitive
583 int CmpNoCase(const wxChar
*psz
) const { return wxStricmp(c_str(), psz
); }
584 // test for the string equality, either considering case or not
585 // (if compareWithCase then the case matters)
586 bool IsSameAs(const wxChar
*psz
, bool compareWithCase
= TRUE
) const
587 { return (compareWithCase
? Cmp(psz
) : CmpNoCase(psz
)) == 0; }
588 // comparison with a signle character: returns TRUE if equal
589 bool IsSameAs(wxChar c
, bool compareWithCase
= TRUE
) const
591 return (Len() == 1) && (compareWithCase
? GetChar(0u) == c
592 : wxToupper(GetChar(0u)) == wxToupper(c
));
595 // simple sub-string extraction
596 // return substring starting at nFirst of length nCount (or till the end
597 // if nCount = default value)
598 wxString
Mid(size_t nFirst
, size_t nCount
= wxSTRING_MAXLEN
) const;
600 // operator version of Mid()
601 wxString
operator()(size_t start
, size_t len
) const
602 { return Mid(start
, len
); }
604 // check that the tring starts with prefix and return the rest of the
605 // string in the provided pointer if it is not NULL, otherwise return
607 bool StartsWith(const wxChar
*prefix
, wxString
*rest
= NULL
) const;
609 // get first nCount characters
610 wxString
Left(size_t nCount
) const;
611 // get last nCount characters
612 wxString
Right(size_t nCount
) const;
613 // get all characters before the first occurence of ch
614 // (returns the whole string if ch not found)
615 wxString
BeforeFirst(wxChar ch
) const;
616 // get all characters before the last occurence of ch
617 // (returns empty string if ch not found)
618 wxString
BeforeLast(wxChar ch
) const;
619 // get all characters after the first occurence of ch
620 // (returns empty string if ch not found)
621 wxString
AfterFirst(wxChar ch
) const;
622 // get all characters after the last occurence of ch
623 // (returns the whole string if ch not found)
624 wxString
AfterLast(wxChar ch
) const;
626 // for compatibility only, use more explicitly named functions above
627 wxString
Before(wxChar ch
) const { return BeforeLast(ch
); }
628 wxString
After(wxChar ch
) const { return AfterFirst(ch
); }
631 // convert to upper case in place, return the string itself
632 wxString
& MakeUpper();
633 // convert to upper case, return the copy of the string
634 // Here's something to remember: BC++ doesn't like returns in inlines.
635 wxString
Upper() const ;
636 // convert to lower case in place, return the string itself
637 wxString
& MakeLower();
638 // convert to lower case, return the copy of the string
639 wxString
Lower() const ;
641 // trimming/padding whitespace (either side) and truncating
642 // remove spaces from left or from right (default) side
643 wxString
& Trim(bool bFromRight
= TRUE
);
644 // add nCount copies chPad in the beginning or at the end (default)
645 wxString
& Pad(size_t nCount
, wxChar chPad
= wxT(' '), bool bFromRight
= TRUE
);
646 // truncate string to given length
647 wxString
& Truncate(size_t uiLen
);
649 // searching and replacing
650 // searching (return starting index, or -1 if not found)
651 int Find(wxChar ch
, bool bFromEnd
= FALSE
) const; // like strchr/strrchr
652 // searching (return starting index, or -1 if not found)
653 int Find(const wxChar
*pszSub
) const; // like strstr
654 // replace first (or all of bReplaceAll) occurences of substring with
655 // another string, returns the number of replacements made
656 size_t Replace(const wxChar
*szOld
,
658 bool bReplaceAll
= TRUE
);
660 // check if the string contents matches a mask containing '*' and '?'
661 bool Matches(const wxChar
*szMask
) const;
663 // conversion to numbers: all functions return TRUE only if the whole string
664 // is a number and put the value of this number into the pointer provided
665 // convert to a signed integer
666 bool ToLong(long *val
) const;
667 // convert to an unsigned integer
668 bool ToULong(unsigned long *val
) const;
669 // convert to a double
670 bool ToDouble(double *val
) const;
672 // formated input/output
673 // as sprintf(), returns the number of characters written or < 0 on error
674 int Printf(const wxChar
*pszFormat
, ...);
675 // as vprintf(), returns the number of characters written or < 0 on error
676 int PrintfV(const wxChar
* pszFormat
, va_list argptr
);
678 // returns the string containing the result of Printf() to it
679 static wxString
Format(const wxChar
*pszFormat
, ...);
680 // the same as above, but takes a va_list
681 static wxString
FormatV(const wxChar
*pszFormat
, va_list argptr
);
683 // raw access to string memory
684 // ensure that string has space for at least nLen characters
685 // only works if the data of this string is not shared
686 void Alloc(size_t nLen
);
687 // minimize the string's memory
688 // only works if the data of this string is not shared
690 // get writable buffer of at least nLen bytes. Unget() *must* be called
691 // a.s.a.p. to put string back in a reasonable state!
692 wxChar
*GetWriteBuf(size_t nLen
);
693 // call this immediately after GetWriteBuf() has been used
694 void UngetWriteBuf();
695 void UngetWriteBuf(size_t nLen
);
697 // wxWindows version 1 compatibility functions
700 wxString
SubString(size_t from
, size_t to
) const
701 { return Mid(from
, (to
- from
+ 1)); }
702 // values for second parameter of CompareTo function
703 enum caseCompare
{exact
, ignoreCase
};
704 // values for first parameter of Strip function
705 enum stripType
{leading
= 0x1, trailing
= 0x2, both
= 0x3};
708 int sprintf(const wxChar
*pszFormat
, ...);
711 inline int CompareTo(const wxChar
* psz
, caseCompare cmp
= exact
) const
712 { return cmp
== exact
? Cmp(psz
) : CmpNoCase(psz
); }
715 size_t Length() const { return Len(); }
716 // Count the number of characters
717 int Freq(wxChar ch
) const;
719 void LowerCase() { MakeLower(); }
721 void UpperCase() { MakeUpper(); }
722 // use Trim except that it doesn't change this string
723 wxString
Strip(stripType w
= trailing
) const;
725 // use Find (more general variants not yet supported)
726 size_t Index(const wxChar
* psz
) const { return Find(psz
); }
727 size_t Index(wxChar ch
) const { return Find(ch
); }
729 wxString
& Remove(size_t pos
) { return Truncate(pos
); }
730 wxString
& RemoveLast() { return Truncate(Len() - 1); }
732 wxString
& Remove(size_t nStart
, size_t nLen
) { return erase( nStart
, nLen
); }
735 int First( const wxChar ch
) const { return Find(ch
); }
736 int First( const wxChar
* psz
) const { return Find(psz
); }
737 int First( const wxString
&str
) const { return Find(str
); }
738 int Last( const wxChar ch
) const { return Find(ch
, TRUE
); }
739 bool Contains(const wxString
& str
) const { return Find(str
) != -1; }
742 bool IsNull() const { return IsEmpty(); }
744 #ifdef wxSTD_STRING_COMPATIBILITY
745 // std::string compatibility functions
748 typedef wxChar value_type
;
749 typedef const value_type
*const_iterator
;
751 // an 'invalid' value for string index
752 static const size_t npos
;
755 // take nLen chars starting at nPos
756 wxString(const wxString
& str
, size_t nPos
, size_t nLen
)
758 wxASSERT( str
.GetStringData()->IsValid() );
759 InitWith(str
.c_str(), nPos
, nLen
== npos
? 0 : nLen
);
761 // take all characters from pStart to pEnd
762 wxString(const void *pStart
, const void *pEnd
);
764 // lib.string.capacity
765 // return the length of the string
766 size_t size() const { return Len(); }
767 // return the length of the string
768 size_t length() const { return Len(); }
769 // return the maximum size of the string
770 size_t max_size() const { return wxSTRING_MAXLEN
; }
771 // resize the string, filling the space with c if c != 0
772 void resize(size_t nSize
, wxChar ch
= wxT('\0'));
773 // delete the contents of the string
774 void clear() { Empty(); }
775 // returns true if the string is empty
776 bool empty() const { return IsEmpty(); }
777 // inform string about planned change in size
778 void reserve(size_t size
) { Alloc(size
); }
781 // return the character at position n
782 wxChar
at(size_t n
) const { return GetChar(n
); }
783 // returns the writable character at position n
784 wxChar
& at(size_t n
) { return GetWritableChar(n
); }
786 // first valid index position
787 const_iterator
begin() const { return wx_str(); }
788 // position one after the last valid one
789 const_iterator
end() const { return wx_str() + length(); }
791 // lib.string.modifiers
793 wxString
& append(const wxString
& str
)
794 { *this += str
; return *this; }
795 // append elements str[pos], ..., str[pos+n]
796 wxString
& append(const wxString
& str
, size_t pos
, size_t n
)
797 { ConcatSelf(n
, str
.c_str() + pos
); return *this; }
798 // append first n (or all if n == npos) characters of sz
799 wxString
& append(const wxChar
*sz
, size_t n
= npos
)
800 { ConcatSelf(n
== npos
? wxStrlen(sz
) : n
, sz
); return *this; }
802 // append n copies of ch
803 wxString
& append(size_t n
, wxChar ch
) { return Pad(n
, ch
); }
805 // same as `this_string = str'
806 wxString
& assign(const wxString
& str
) { return (*this) = str
; }
807 // same as ` = str[pos..pos + n]
808 wxString
& assign(const wxString
& str
, size_t pos
, size_t n
)
809 { return *this = wxString((const wxChar
*)str
+ pos
, n
); }
810 // same as `= first n (or all if n == npos) characters of sz'
811 wxString
& assign(const wxChar
*sz
, size_t n
= npos
)
812 { return *this = wxString(sz
, n
); }
813 // same as `= n copies of ch'
814 wxString
& assign(size_t n
, wxChar ch
)
815 { return *this = wxString(ch
, n
); }
817 // insert another string
818 wxString
& insert(size_t nPos
, const wxString
& str
);
819 // insert n chars of str starting at nStart (in str)
820 wxString
& insert(size_t nPos
, const wxString
& str
, size_t nStart
, size_t n
)
821 { return insert(nPos
, wxString((const wxChar
*)str
+ nStart
, n
)); }
823 // insert first n (or all if n == npos) characters of sz
824 wxString
& insert(size_t nPos
, const wxChar
*sz
, size_t n
= npos
)
825 { return insert(nPos
, wxString(sz
, n
)); }
826 // insert n copies of ch
827 wxString
& insert(size_t nPos
, size_t n
, wxChar ch
)
828 { return insert(nPos
, wxString(ch
, n
)); }
830 // delete characters from nStart to nStart + nLen
831 wxString
& erase(size_t nStart
= 0, size_t nLen
= npos
);
833 // replaces the substring of length nLen starting at nStart
834 wxString
& replace(size_t nStart
, size_t nLen
, const wxChar
* sz
);
835 // replaces the substring with nCount copies of ch
836 wxString
& replace(size_t nStart
, size_t nLen
, size_t nCount
, wxChar ch
);
837 // replaces a substring with another substring
838 wxString
& replace(size_t nStart
, size_t nLen
,
839 const wxString
& str
, size_t nStart2
, size_t nLen2
);
840 // replaces the substring with first nCount chars of sz
841 wxString
& replace(size_t nStart
, size_t nLen
,
842 const wxChar
* sz
, size_t nCount
);
845 void swap(wxString
& str
);
847 // All find() functions take the nStart argument which specifies the
848 // position to start the search on, the default value is 0. All functions
849 // return npos if there were no match.
852 size_t find(const wxString
& str
, size_t nStart
= 0) const;
854 // VC++ 1.5 can't cope with this syntax.
855 #if !defined(__VISUALC__) || defined(__WIN32__)
856 // find first n characters of sz
857 size_t find(const wxChar
* sz
, size_t nStart
= 0, size_t n
= npos
) const;
860 // Gives a duplicate symbol (presumably a case-insensitivity problem)
861 #if !defined(__BORLANDC__)
862 // find the first occurence of character ch after nStart
863 size_t find(wxChar ch
, size_t nStart
= 0) const;
865 // rfind() family is exactly like find() but works right to left
867 // as find, but from the end
868 size_t rfind(const wxString
& str
, size_t nStart
= npos
) const;
870 // VC++ 1.5 can't cope with this syntax.
871 #if !defined(__VISUALC__) || defined(__WIN32__)
872 // as find, but from the end
873 size_t rfind(const wxChar
* sz
, size_t nStart
= npos
,
874 size_t n
= npos
) const;
875 // as find, but from the end
876 size_t rfind(wxChar ch
, size_t nStart
= npos
) const;
879 // find first/last occurence of any character in the set
881 // as strpbrk() but starts at nStart, returns npos if not found
882 size_t find_first_of(const wxString
& str
, size_t nStart
= 0) const
883 { return find_first_of(str
.c_str(), nStart
); }
885 size_t find_first_of(const wxChar
* sz
, size_t nStart
= 0) const;
886 // same as find(char, size_t)
887 size_t find_first_of(wxChar c
, size_t nStart
= 0) const
888 { return find(c
, nStart
); }
889 // find the last (starting from nStart) char from str in this string
890 size_t find_last_of (const wxString
& str
, size_t nStart
= npos
) const
891 { return find_last_of(str
.c_str(), nStart
); }
893 size_t find_last_of (const wxChar
* sz
, size_t nStart
= npos
) const;
895 size_t find_last_of(wxChar c
, size_t nStart
= npos
) const
896 { return rfind(c
, nStart
); }
898 // find first/last occurence of any character not in the set
900 // as strspn() (starting from nStart), returns npos on failure
901 size_t find_first_not_of(const wxString
& str
, size_t nStart
= 0) const
902 { return find_first_not_of(str
.c_str(), nStart
); }
904 size_t find_first_not_of(const wxChar
* sz
, size_t nStart
= 0) const;
906 size_t find_first_not_of(wxChar ch
, size_t nStart
= 0) const;
908 size_t find_last_not_of(const wxString
& str
, size_t nStart
= npos
) const
909 { return find_first_not_of(str
.c_str(), nStart
); }
911 size_t find_last_not_of(const wxChar
* sz
, size_t nStart
= npos
) const;
913 size_t find_last_not_of(wxChar ch
, size_t nStart
= npos
) const;
915 // All compare functions return -1, 0 or 1 if the [sub]string is less,
916 // equal or greater than the compare() argument.
918 // just like strcmp()
919 int compare(const wxString
& str
) const { return Cmp(str
); }
920 // comparison with a substring
921 int compare(size_t nStart
, size_t nLen
, const wxString
& str
) const
922 { return Mid(nStart
, nLen
).Cmp(str
); }
923 // comparison of 2 substrings
924 int compare(size_t nStart
, size_t nLen
,
925 const wxString
& str
, size_t nStart2
, size_t nLen2
) const
926 { return Mid(nStart
, nLen
).Cmp(str
.Mid(nStart2
, nLen2
)); }
927 // just like strcmp()
928 int compare(const wxChar
* sz
) const { return Cmp(sz
); }
929 // substring comparison with first nCount characters of sz
930 int compare(size_t nStart
, size_t nLen
,
931 const wxChar
* sz
, size_t nCount
= npos
) const
932 { return Mid(nStart
, nLen
).Cmp(wxString(sz
, nCount
)); }
934 // substring extraction
935 wxString
substr(size_t nStart
= 0, size_t nLen
= npos
) const
936 { return Mid(nStart
, nLen
); }
937 #endif // wxSTD_STRING_COMPATIBILITY
940 // ----------------------------------------------------------------------------
941 // The string array uses it's knowledge of internal structure of the wxString
942 // class to optimize string storage. Normally, we would store pointers to
943 // string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
944 // sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
945 // really all we need to turn such pointer into a string!
947 // Of course, it can be called a dirty hack, but we use twice less memory and
948 // this approach is also more speed efficient, so it's probably worth it.
950 // Usage notes: when a string is added/inserted, a new copy of it is created,
951 // so the original string may be safely deleted. When a string is retrieved
952 // from the array (operator[] or Item() method), a reference is returned.
953 // ----------------------------------------------------------------------------
955 class WXDLLEXPORT wxArrayString
958 // type of function used by wxArrayString::Sort()
959 typedef int (*CompareFunction
)(const wxString
& first
,
960 const wxString
& second
);
962 // constructors and destructor
963 // default ctor: if autoSort is TRUE, the array is always sorted (in
964 // alphabetical order)
965 wxArrayString(bool autoSort
= FALSE
);
967 wxArrayString(const wxArrayString
& array
);
968 // assignment operator
969 wxArrayString
& operator=(const wxArrayString
& src
);
970 // not virtual, this class should not be derived from
974 // empties the list, but doesn't release memory
976 // empties the list and releases memory
978 // preallocates memory for given number of items
979 void Alloc(size_t nCount
);
980 // minimzes the memory usage (by freeing all extra memory)
984 // number of elements in the array
985 size_t GetCount() const { return m_nCount
; }
987 bool IsEmpty() const { return m_nCount
== 0; }
988 // number of elements in the array (GetCount is preferred API)
989 size_t Count() const { return m_nCount
; }
991 // items access (range checking is done in debug version)
992 // get item at position uiIndex
993 wxString
& Item(size_t nIndex
) const
994 { wxASSERT( nIndex
< m_nCount
); return *(wxString
*)&(m_pItems
[nIndex
]); }
996 wxString
& operator[](size_t nIndex
) const { return Item(nIndex
); }
998 wxString
& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
1001 // Search the element in the array, starting from the beginning if
1002 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
1003 // sensitive (default). Returns index of the first item matched or
1005 int Index (const wxChar
*sz
, bool bCase
= TRUE
, bool bFromEnd
= FALSE
) const;
1006 // add new element at the end (if the array is not sorted), return its
1008 size_t Add(const wxString
& str
);
1009 // add new element at given position
1010 void Insert(const wxString
& str
, size_t uiIndex
);
1011 // remove first item matching this value
1012 void Remove(const wxChar
*sz
);
1013 // remove item by index
1014 void Remove(size_t nIndex
);
1017 // sort array elements in alphabetical order (or reversed alphabetical
1018 // order if reverseOrder parameter is TRUE)
1019 void Sort(bool reverseOrder
= FALSE
);
1020 // sort array elements using specified comparaison function
1021 void Sort(CompareFunction compareFunction
);
1024 // compare two arrays case sensitively
1025 bool operator==(const wxArrayString
& a
) const;
1026 // compare two arrays case sensitively
1027 bool operator!=(const wxArrayString
& a
) const { return !(*this == a
); }
1030 void Copy(const wxArrayString
& src
); // copies the contents of another array
1033 void Grow(); // makes array bigger if needed
1034 void Free(); // free all the strings stored
1036 void DoSort(); // common part of all Sort() variants
1038 size_t m_nSize
, // current size of the array
1039 m_nCount
; // current number of elements
1041 wxChar
**m_pItems
; // pointer to data
1043 bool m_autoSort
; // if TRUE, keep the array always sorted
1046 class WXDLLEXPORT wxSortedArrayString
: public wxArrayString
1049 wxSortedArrayString() : wxArrayString(TRUE
)
1051 wxSortedArrayString(const wxArrayString
& array
) : wxArrayString(TRUE
)
1055 // ---------------------------------------------------------------------------
1056 // wxString comparison functions: operator versions are always case sensitive
1057 // ---------------------------------------------------------------------------
1059 inline bool operator==(const wxString
& s1
, const wxString
& s2
)
1060 { return (s1
.Len() == s2
.Len()) && (s1
.Cmp(s2
) == 0); }
1061 inline bool operator==(const wxString
& s1
, const wxChar
* s2
)
1062 { return s1
.Cmp(s2
) == 0; }
1063 inline bool operator==(const wxChar
* s1
, const wxString
& s2
)
1064 { return s2
.Cmp(s1
) == 0; }
1065 inline bool operator!=(const wxString
& s1
, const wxString
& s2
)
1066 { return (s1
.Len() != s2
.Len()) || (s1
.Cmp(s2
) != 0); }
1067 inline bool operator!=(const wxString
& s1
, const wxChar
* s2
)
1068 { return s1
.Cmp(s2
) != 0; }
1069 inline bool operator!=(const wxChar
* s1
, const wxString
& s2
)
1070 { return s2
.Cmp(s1
) != 0; }
1071 inline bool operator< (const wxString
& s1
, const wxString
& s2
)
1072 { return s1
.Cmp(s2
) < 0; }
1073 inline bool operator< (const wxString
& s1
, const wxChar
* s2
)
1074 { return s1
.Cmp(s2
) < 0; }
1075 inline bool operator< (const wxChar
* s1
, const wxString
& s2
)
1076 { return s2
.Cmp(s1
) > 0; }
1077 inline bool operator> (const wxString
& s1
, const wxString
& s2
)
1078 { return s1
.Cmp(s2
) > 0; }
1079 inline bool operator> (const wxString
& s1
, const wxChar
* s2
)
1080 { return s1
.Cmp(s2
) > 0; }
1081 inline bool operator> (const wxChar
* s1
, const wxString
& s2
)
1082 { return s2
.Cmp(s1
) < 0; }
1083 inline bool operator<=(const wxString
& s1
, const wxString
& s2
)
1084 { return s1
.Cmp(s2
) <= 0; }
1085 inline bool operator<=(const wxString
& s1
, const wxChar
* s2
)
1086 { return s1
.Cmp(s2
) <= 0; }
1087 inline bool operator<=(const wxChar
* s1
, const wxString
& s2
)
1088 { return s2
.Cmp(s1
) >= 0; }
1089 inline bool operator>=(const wxString
& s1
, const wxString
& s2
)
1090 { return s1
.Cmp(s2
) >= 0; }
1091 inline bool operator>=(const wxString
& s1
, const wxChar
* s2
)
1092 { return s1
.Cmp(s2
) >= 0; }
1093 inline bool operator>=(const wxChar
* s1
, const wxString
& s2
)
1094 { return s2
.Cmp(s1
) <= 0; }
1096 // comparison with char
1097 inline bool operator==(wxChar c
, const wxString
& s
) { return s
.IsSameAs(c
); }
1098 inline bool operator==(const wxString
& s
, wxChar c
) { return s
.IsSameAs(c
); }
1099 inline bool operator!=(wxChar c
, const wxString
& s
) { return !s
.IsSameAs(c
); }
1100 inline bool operator!=(const wxString
& s
, wxChar c
) { return !s
.IsSameAs(c
); }
1103 inline bool operator==(const wxString
& s1
, const wxWCharBuffer
& s2
)
1104 { return (s1
.Cmp((const wchar_t *)s2
) == 0); }
1105 inline bool operator==(const wxWCharBuffer
& s1
, const wxString
& s2
)
1106 { return (s2
.Cmp((const wchar_t *)s1
) == 0); }
1107 inline bool operator!=(const wxString
& s1
, const wxWCharBuffer
& s2
)
1108 { return (s1
.Cmp((const wchar_t *)s2
) != 0); }
1109 inline bool operator!=(const wxWCharBuffer
& s1
, const wxString
& s2
)
1110 { return (s2
.Cmp((const wchar_t *)s1
) != 0); }
1111 #else // !wxUSE_UNICODE
1112 inline bool operator==(const wxString
& s1
, const wxCharBuffer
& s2
)
1113 { return (s1
.Cmp((const char *)s2
) == 0); }
1114 inline bool operator==(const wxCharBuffer
& s1
, const wxString
& s2
)
1115 { return (s2
.Cmp((const char *)s1
) == 0); }
1116 inline bool operator!=(const wxString
& s1
, const wxCharBuffer
& s2
)
1117 { return (s1
.Cmp((const char *)s2
) != 0); }
1118 inline bool operator!=(const wxCharBuffer
& s1
, const wxString
& s2
)
1119 { return (s2
.Cmp((const char *)s1
) != 0); }
1120 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1122 wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
1123 wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
1124 wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
1125 wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
1126 wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
1128 inline wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxWCharBuffer
& buf
)
1129 { return string
+ (const wchar_t *)buf
; }
1130 inline wxString WXDLLEXPORT
operator+(const wxWCharBuffer
& buf
, const wxString
& string
)
1131 { return (const wchar_t *)buf
+ string
; }
1132 #else // !wxUSE_UNICODE
1133 inline wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxCharBuffer
& buf
)
1134 { return string
+ (const char *)buf
; }
1135 inline wxString WXDLLEXPORT
operator+(const wxCharBuffer
& buf
, const wxString
& string
)
1136 { return (const char *)buf
+ string
; }
1137 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1139 // ---------------------------------------------------------------------------
1140 // Implementation only from here until the end of file
1141 // ---------------------------------------------------------------------------
1143 // don't pollute the library user's name space
1144 #undef ASSERT_VALID_INDEX
1146 #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
1148 #include "wx/ioswrap.h"
1150 WXDLLEXPORT istream
& operator>>(istream
&, wxString
&);
1151 WXDLLEXPORT ostream
& operator<<(ostream
&, const wxString
&);
1153 #endif // wxSTD_STRING_COMPATIBILITY
1155 #endif // _WX_WXSTRINGH__