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()
66 #endif // HAVE_STRINGS_H
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 // if we hadn't made these operators private, it would be possible to
291 // compile "wxString s; s = 17;" without any warnings as 17 is implicitly
292 // converted to char in C and we do have operator=(char)
294 // NB: we don't need other versions (short/long and unsigned) as attempt
295 // to assign another numeric type to wxString will now result in
296 // ambiguity between operator=(char) and operator=(int)
297 wxString
& operator=(int);
299 // these methods are not implemented - there is _no_ conversion from int to
300 // string, you're doing something wrong if the compiler wants to call it!
302 // try `s << i' or `s.Printf("%d", i)' instead
306 // constructors and destructor
307 // ctor for an empty string
308 wxString() { Init(); }
310 wxString(const wxString
& stringSrc
)
312 wxASSERT( stringSrc
.GetStringData()->IsValid() );
314 if ( stringSrc
.IsEmpty() ) {
315 // nothing to do for an empty string
319 m_pchData
= stringSrc
.m_pchData
; // share same data
320 GetStringData()->Lock(); // => one more copy
323 // string containing nRepeat copies of ch
324 wxString(wxChar ch
, size_t nRepeat
= 1);
325 // ctor takes first nLength characters from C string
326 // (default value of wxSTRING_MAXLEN means take all the string)
327 wxString(const wxChar
*psz
, size_t nLength
= wxSTRING_MAXLEN
)
328 { InitWith(psz
, 0, nLength
); }
329 wxString(const wxChar
*psz
, wxMBConv
& WXUNUSED(conv
), size_t nLength
= wxSTRING_MAXLEN
)
330 { InitWith(psz
, 0, nLength
); }
333 // from multibyte string
334 // (NB: nLength is right now number of Unicode characters, not
335 // characters in psz! So try not to use it yet!)
336 wxString(const char *psz
, wxMBConv
& conv
= wxConvLibc
, size_t nLength
= wxSTRING_MAXLEN
);
337 // from wxWCharBuffer (i.e. return from wxGetString)
338 wxString(const wxWCharBuffer
& psz
)
339 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
341 // from C string (for compilers using unsigned char)
342 wxString(const unsigned char* psz
, size_t nLength
= wxSTRING_MAXLEN
)
343 { InitWith((const char*)psz
, 0, nLength
); }
346 // from wide (Unicode) string
347 wxString(const wchar_t *pwz
, wxMBConv
& conv
= wxConvLibc
);
348 #endif // !wxUSE_WCHAR_T
351 wxString(const wxCharBuffer
& psz
)
352 { InitWith(psz
, 0, wxSTRING_MAXLEN
); }
353 #endif // Unicode/ANSI
355 // dtor is not virtual, this class must not be inherited from!
356 ~wxString() { GetStringData()->Unlock(); }
358 // generic attributes & operations
359 // as standard strlen()
360 size_t Len() const { return GetStringData()->nDataLength
; }
361 // string contains any characters?
362 bool IsEmpty() const { return Len() == 0; }
363 // empty string is "FALSE", so !str will return TRUE
364 bool operator!() const { return IsEmpty(); }
365 // truncate the string to given length
366 wxString
& Truncate(size_t uiLen
);
367 // empty string contents
372 wxASSERT_MSG( IsEmpty(), _T("string not empty after call to Empty()?") );
374 // empty the string and free memory
377 if ( !GetStringData()->IsEmpty() )
380 wxASSERT( GetStringData()->nDataLength
== 0 ); // should be empty
381 wxASSERT( GetStringData()->nAllocLength
== 0 ); // and not own any memory
386 bool IsAscii() const;
388 bool IsNumber() const;
392 // data access (all indexes are 0 based)
394 wxChar
GetChar(size_t n
) const
395 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
397 wxChar
& GetWritableChar(size_t n
)
398 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
400 void SetChar(size_t n
, wxChar ch
)
401 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); m_pchData
[n
] = ch
; }
403 // get last character
405 { wxASSERT( !IsEmpty() ); return m_pchData
[Len() - 1]; }
406 // get writable last character
408 { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData
[Len()-1]; }
411 So why do we have all these overloaded operator[]s? A bit of history:
412 initially there was only one of them, taking size_t. Then people
413 started complaining because they wanted to use ints as indices (I
414 wonder why) and compilers were giving warnings about it, so we had to
415 add the operator[](int). Then it became apparent that you couldn't
416 write str[0] any longer because there was ambiguity between two
417 overloads and so you now had to write str[0u] (or, of course, use the
418 explicit casts to either int or size_t but nobody did this).
420 Finally, someone decided to compile wxWin on an Alpha machine and got
421 a surprize: str[0u] didn't compile there because it is of type
422 unsigned int and size_t is unsigned _long_ on Alpha and so there was
423 ambiguity between converting uint to int or ulong. To fix this one we
424 now add operator[](uint) for the machines where size_t is not already
425 the same as unsigned int - hopefully this fixes the problem (for some
428 The only real fix is, of course, to remove all versions but the one
432 // operator version of GetChar
433 wxChar
operator[](size_t n
) const
434 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
436 // operator version of GetChar
437 wxChar
operator[](int n
) const
438 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
440 // operator version of GetWriteableChar
441 wxChar
& operator[](size_t n
)
442 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
444 #ifndef wxSIZE_T_IS_UINT
445 // operator version of GetChar
446 wxChar
operator[](unsigned int n
) const
447 { ASSERT_VALID_INDEX( n
); return m_pchData
[n
]; }
449 // operator version of GetWriteableChar
450 wxChar
& operator[](unsigned int n
)
451 { ASSERT_VALID_INDEX( n
); CopyBeforeWrite(); return m_pchData
[n
]; }
452 #endif // size_t != unsigned int
454 // implicit conversion to C string
455 operator const wxChar
*() const { return m_pchData
; }
456 // explicit conversion to C string (use this with printf()!)
457 const wxChar
* c_str() const { return m_pchData
; }
458 // identical to c_str()
459 const wxChar
* wx_str() const { return m_pchData
; }
460 // identical to c_str()
461 const wxChar
* GetData() const { return m_pchData
; }
463 // conversions with (possible) format convertions: have to return a
464 // buffer with temporary data
466 // the functions defined (in either Unicode or ANSI) mode are mb_str() to
467 // return an ANSI (multibyte) string, wc_str() to return a wide string and
468 // fn_str() to return a string which should be used with the OS APIs
469 // accepting the file names. The return value is always the same, but the
470 // type differs because a function may either return pointer to the buffer
471 // directly or have to use intermediate buffer for translation.
473 const wxCharBuffer
mb_str(wxMBConv
& conv
= wxConvLibc
) const
474 { return conv
.cWC2MB(m_pchData
); }
476 const wxWX2MBbuf
mbc_str() const { return mb_str(*wxConvCurrent
); }
478 const wxChar
* wc_str() const { return m_pchData
; }
480 // for compatibility with !wxUSE_UNICODE version
481 const wxChar
* wc_str(wxMBConv
& WXUNUSED(conv
)) const { return m_pchData
; }
484 const wxCharBuffer
fn_str() const { return mb_str(wxConvFile
); }
486 const wxChar
* fn_str() const { return m_pchData
; }
487 #endif // wxMBFILES/!wxMBFILES
489 const wxChar
* mb_str() const { return m_pchData
; }
491 // for compatibility with wxUSE_UNICODE version
492 const wxChar
* mb_str(wxMBConv
& WXUNUSED(conv
)) const { return m_pchData
; }
494 const wxWX2MBbuf
mbc_str() const { return mb_str(); }
497 const wxWCharBuffer
wc_str(wxMBConv
& conv
) const
498 { return conv
.cMB2WC(m_pchData
); }
499 #endif // wxUSE_WCHAR_T
501 const wxChar
* fn_str() const { return m_pchData
; }
502 #endif // Unicode/ANSI
504 // overloaded assignment
505 // from another wxString
506 wxString
& operator=(const wxString
& stringSrc
);
508 wxString
& operator=(wxChar ch
);
510 wxString
& operator=(const wxChar
*psz
);
512 // from wxWCharBuffer
513 wxString
& operator=(const wxWCharBuffer
& psz
) { return operator=((const wchar_t *)psz
); }
515 // from another kind of C string
516 wxString
& operator=(const unsigned char* psz
);
518 // from a wide string
519 wxString
& operator=(const wchar_t *pwz
);
522 wxString
& operator=(const wxCharBuffer
& psz
) { return operator=((const char *)psz
); }
523 #endif // Unicode/ANSI
525 // string concatenation
526 // in place concatenation
528 Concatenate and return the result. Note that the left to right
529 associativity of << allows to write things like "str << str1 << str2
530 << ..." (unlike with +=)
533 wxString
& operator<<(const wxString
& s
)
535 wxASSERT( s
.GetStringData()->IsValid() );
537 ConcatSelf(s
.Len(), s
);
540 // string += C string
541 wxString
& operator<<(const wxChar
*psz
)
542 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
544 wxString
& operator<<(wxChar ch
) { ConcatSelf(1, &ch
); return *this; }
547 void operator+=(const wxString
& s
) { (void)operator<<(s
); }
548 // string += C string
549 void operator+=(const wxChar
*psz
) { (void)operator<<(psz
); }
551 void operator+=(wxChar ch
) { (void)operator<<(ch
); }
553 // string += buffer (i.e. from wxGetString)
555 wxString
& operator<<(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); return *this; }
556 void operator+=(const wxWCharBuffer
& s
) { (void)operator<<((const wchar_t *)s
); }
558 wxString
& operator<<(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); return *this; }
559 void operator+=(const wxCharBuffer
& s
) { (void)operator<<((const char *)s
); }
562 // string += C string
563 wxString
& Append(const wxChar
* psz
)
564 { ConcatSelf(wxStrlen(psz
), psz
); return *this; }
565 // append count copies of given character
566 wxString
& Append(wxChar ch
, size_t count
= 1u)
567 { wxString
str(ch
, count
); return *this << str
; }
568 wxString
& Append(const wxChar
* psz
, size_t nLen
)
569 { ConcatSelf(nLen
, psz
); return *this; }
571 // prepend a string, return the string itself
572 wxString
& Prepend(const wxString
& str
)
573 { *this = str
+ *this; return *this; }
575 // non-destructive concatenation
577 friend wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
579 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
581 friend wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
583 friend wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
585 friend wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
587 // stream-like functions
588 // insert an int into string
589 wxString
& operator<<(int i
)
590 { return (*this) << Format(_T("%d"), i
); }
591 // insert an unsigned int into string
592 wxString
& operator<<(unsigned int ui
)
593 { return (*this) << Format(_T("%u"), ui
); }
594 // insert a long into string
595 wxString
& operator<<(long l
)
596 { return (*this) << Format(_T("%ld"), l
); }
597 // insert an unsigned long into string
598 wxString
& operator<<(unsigned long ul
)
599 { return (*this) << Format(_T("%lu"), ul
); }
600 // insert a float into string
601 wxString
& operator<<(float f
)
602 { return (*this) << Format(_T("%f"), f
); }
603 // insert a double into string
604 wxString
& operator<<(double d
)
605 { return (*this) << Format(_T("%g"), d
); }
608 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
609 int Cmp(const wxChar
*psz
) const { return wxStrcmp(c_str(), psz
); }
610 // same as Cmp() but not case-sensitive
611 int CmpNoCase(const wxChar
*psz
) const { return wxStricmp(c_str(), psz
); }
612 // test for the string equality, either considering case or not
613 // (if compareWithCase then the case matters)
614 bool IsSameAs(const wxChar
*psz
, bool compareWithCase
= TRUE
) const
615 { return (compareWithCase
? Cmp(psz
) : CmpNoCase(psz
)) == 0; }
616 // comparison with a signle character: returns TRUE if equal
617 bool IsSameAs(wxChar c
, bool compareWithCase
= TRUE
) const
619 return (Len() == 1) && (compareWithCase
? GetChar(0u) == c
620 : wxToupper(GetChar(0u)) == wxToupper(c
));
623 // simple sub-string extraction
624 // return substring starting at nFirst of length nCount (or till the end
625 // if nCount = default value)
626 wxString
Mid(size_t nFirst
, size_t nCount
= wxSTRING_MAXLEN
) const;
628 // operator version of Mid()
629 wxString
operator()(size_t start
, size_t len
) const
630 { return Mid(start
, len
); }
632 // check that the string starts with prefix and return the rest of the
633 // string in the provided pointer if it is not NULL, otherwise return
635 bool StartsWith(const wxChar
*prefix
, wxString
*rest
= NULL
) const;
637 // get first nCount characters
638 wxString
Left(size_t nCount
) const;
639 // get last nCount characters
640 wxString
Right(size_t nCount
) const;
641 // get all characters before the first occurance of ch
642 // (returns the whole string if ch not found)
643 wxString
BeforeFirst(wxChar ch
) const;
644 // get all characters before the last occurence of ch
645 // (returns empty string if ch not found)
646 wxString
BeforeLast(wxChar ch
) const;
647 // get all characters after the first occurence of ch
648 // (returns empty string if ch not found)
649 wxString
AfterFirst(wxChar ch
) const;
650 // get all characters after the last occurence of ch
651 // (returns the whole string if ch not found)
652 wxString
AfterLast(wxChar ch
) const;
654 // for compatibility only, use more explicitly named functions above
655 wxString
Before(wxChar ch
) const { return BeforeLast(ch
); }
656 wxString
After(wxChar ch
) const { return AfterFirst(ch
); }
659 // convert to upper case in place, return the string itself
660 wxString
& MakeUpper();
661 // convert to upper case, return the copy of the string
662 // Here's something to remember: BC++ doesn't like returns in inlines.
663 wxString
Upper() const ;
664 // convert to lower case in place, return the string itself
665 wxString
& MakeLower();
666 // convert to lower case, return the copy of the string
667 wxString
Lower() const ;
669 // trimming/padding whitespace (either side) and truncating
670 // remove spaces from left or from right (default) side
671 wxString
& Trim(bool bFromRight
= TRUE
);
672 // add nCount copies chPad in the beginning or at the end (default)
673 wxString
& Pad(size_t nCount
, wxChar chPad
= wxT(' '), bool bFromRight
= TRUE
);
675 // searching and replacing
676 // searching (return starting index, or -1 if not found)
677 int Find(wxChar ch
, bool bFromEnd
= FALSE
) const; // like strchr/strrchr
678 // searching (return starting index, or -1 if not found)
679 int Find(const wxChar
*pszSub
) const; // like strstr
680 // replace first (or all of bReplaceAll) occurences of substring with
681 // another string, returns the number of replacements made
682 size_t Replace(const wxChar
*szOld
,
684 bool bReplaceAll
= TRUE
);
686 // check if the string contents matches a mask containing '*' and '?'
687 bool Matches(const wxChar
*szMask
) const;
689 // conversion to numbers: all functions return TRUE only if the whole string
690 // is a number and put the value of this number into the pointer provided
691 // convert to a signed integer
692 bool ToLong(long *val
, int base
= 0) const;
693 // convert to an unsigned integer
694 bool ToULong(unsigned long *val
, int base
= 0) const;
695 // convert to a double
696 bool ToDouble(double *val
) const;
698 // formated input/output
699 // as sprintf(), returns the number of characters written or < 0 on error
700 int Printf(const wxChar
*pszFormat
, ...);
701 // as vprintf(), returns the number of characters written or < 0 on error
702 int PrintfV(const wxChar
* pszFormat
, va_list argptr
);
704 // returns the string containing the result of Printf() to it
705 static wxString
Format(const wxChar
*pszFormat
, ...);
706 // the same as above, but takes a va_list
707 static wxString
FormatV(const wxChar
*pszFormat
, va_list argptr
);
709 // raw access to string memory
710 // ensure that string has space for at least nLen characters
711 // only works if the data of this string is not shared
712 void Alloc(size_t nLen
);
713 // minimize the string's memory
714 // only works if the data of this string is not shared
716 // get writable buffer of at least nLen bytes. Unget() *must* be called
717 // a.s.a.p. to put string back in a reasonable state!
718 wxChar
*GetWriteBuf(size_t nLen
);
719 // call this immediately after GetWriteBuf() has been used
720 void UngetWriteBuf();
721 void UngetWriteBuf(size_t nLen
);
723 // wxWindows version 1 compatibility functions
726 wxString
SubString(size_t from
, size_t to
) const
727 { return Mid(from
, (to
- from
+ 1)); }
728 // values for second parameter of CompareTo function
729 enum caseCompare
{exact
, ignoreCase
};
730 // values for first parameter of Strip function
731 enum stripType
{leading
= 0x1, trailing
= 0x2, both
= 0x3};
734 int sprintf(const wxChar
*pszFormat
, ...);
737 inline int CompareTo(const wxChar
* psz
, caseCompare cmp
= exact
) const
738 { return cmp
== exact
? Cmp(psz
) : CmpNoCase(psz
); }
741 size_t Length() const { return Len(); }
742 // Count the number of characters
743 int Freq(wxChar ch
) const;
745 void LowerCase() { MakeLower(); }
747 void UpperCase() { MakeUpper(); }
748 // use Trim except that it doesn't change this string
749 wxString
Strip(stripType w
= trailing
) const;
751 // use Find (more general variants not yet supported)
752 size_t Index(const wxChar
* psz
) const { return Find(psz
); }
753 size_t Index(wxChar ch
) const { return Find(ch
); }
755 wxString
& Remove(size_t pos
) { return Truncate(pos
); }
756 wxString
& RemoveLast(size_t n
= 1) { return Truncate(Len() - n
); }
758 wxString
& Remove(size_t nStart
, size_t nLen
) { return erase( nStart
, nLen
); }
761 int First( const wxChar ch
) const { return Find(ch
); }
762 int First( const wxChar
* psz
) const { return Find(psz
); }
763 int First( const wxString
&str
) const { return Find(str
); }
764 int Last( const wxChar ch
) const { return Find(ch
, TRUE
); }
765 bool Contains(const wxString
& str
) const { return Find(str
) != -1; }
768 bool IsNull() const { return IsEmpty(); }
770 #ifdef wxSTD_STRING_COMPATIBILITY
771 // std::string compatibility functions
774 typedef wxChar value_type
;
775 typedef const value_type
*const_iterator
;
777 // an 'invalid' value for string index
778 static const size_t npos
;
781 // take nLen chars starting at nPos
782 wxString(const wxString
& str
, size_t nPos
, size_t nLen
)
784 wxASSERT( str
.GetStringData()->IsValid() );
785 InitWith(str
.c_str(), nPos
, nLen
== npos
? 0 : nLen
);
787 // take all characters from pStart to pEnd
788 wxString(const void *pStart
, const void *pEnd
);
790 // lib.string.capacity
791 // return the length of the string
792 size_t size() const { return Len(); }
793 // return the length of the string
794 size_t length() const { return Len(); }
795 // return the maximum size of the string
796 size_t max_size() const { return wxSTRING_MAXLEN
; }
797 // resize the string, filling the space with c if c != 0
798 void resize(size_t nSize
, wxChar ch
= wxT('\0'));
799 // delete the contents of the string
800 void clear() { Empty(); }
801 // returns true if the string is empty
802 bool empty() const { return IsEmpty(); }
803 // inform string about planned change in size
804 void reserve(size_t size
) { Alloc(size
); }
807 // return the character at position n
808 wxChar
at(size_t n
) const { return GetChar(n
); }
809 // returns the writable character at position n
810 wxChar
& at(size_t n
) { return GetWritableChar(n
); }
812 // first valid index position
813 const_iterator
begin() const { return wx_str(); }
814 // position one after the last valid one
815 const_iterator
end() const { return wx_str() + length(); }
817 // lib.string.modifiers
819 wxString
& append(const wxString
& str
)
820 { *this += str
; return *this; }
821 // append elements str[pos], ..., str[pos+n]
822 wxString
& append(const wxString
& str
, size_t pos
, size_t n
)
823 { ConcatSelf(n
, str
.c_str() + pos
); return *this; }
824 // append first n (or all if n == npos) characters of sz
825 wxString
& append(const wxChar
*sz
, size_t n
= npos
)
826 { ConcatSelf(n
== npos
? wxStrlen(sz
) : n
, sz
); return *this; }
828 // append n copies of ch
829 wxString
& append(size_t n
, wxChar ch
) { return Pad(n
, ch
); }
831 // same as `this_string = str'
832 wxString
& assign(const wxString
& str
)
833 { return *this = str
; }
834 // same as ` = str[pos..pos + n]
835 wxString
& assign(const wxString
& str
, size_t pos
, size_t n
)
836 { Empty(); return Append(str
.c_str() + pos
, n
); }
837 // same as `= first n (or all if n == npos) characters of sz'
838 wxString
& assign(const wxChar
*sz
, size_t n
= npos
)
839 { Empty(); return Append(sz
, n
== npos
? wxStrlen(sz
) : n
); }
840 // same as `= n copies of ch'
841 wxString
& assign(size_t n
, wxChar ch
)
842 { Empty(); return Append(ch
, n
); }
844 // insert another string
845 wxString
& insert(size_t nPos
, const wxString
& str
);
846 // insert n chars of str starting at nStart (in str)
847 wxString
& insert(size_t nPos
, const wxString
& str
, size_t nStart
, size_t n
)
848 { return insert(nPos
, wxString((const wxChar
*)str
+ nStart
, n
)); }
850 // insert first n (or all if n == npos) characters of sz
851 wxString
& insert(size_t nPos
, const wxChar
*sz
, size_t n
= npos
)
852 { return insert(nPos
, wxString(sz
, n
)); }
853 // insert n copies of ch
854 wxString
& insert(size_t nPos
, size_t n
, wxChar ch
)
855 { return insert(nPos
, wxString(ch
, n
)); }
857 // delete characters from nStart to nStart + nLen
858 wxString
& erase(size_t nStart
= 0, size_t nLen
= npos
);
860 // replaces the substring of length nLen starting at nStart
861 wxString
& replace(size_t nStart
, size_t nLen
, const wxChar
* sz
);
862 // replaces the substring with nCount copies of ch
863 wxString
& replace(size_t nStart
, size_t nLen
, size_t nCount
, wxChar ch
);
864 // replaces a substring with another substring
865 wxString
& replace(size_t nStart
, size_t nLen
,
866 const wxString
& str
, size_t nStart2
, size_t nLen2
);
867 // replaces the substring with first nCount chars of sz
868 wxString
& replace(size_t nStart
, size_t nLen
,
869 const wxChar
* sz
, size_t nCount
);
872 void swap(wxString
& str
);
874 // All find() functions take the nStart argument which specifies the
875 // position to start the search on, the default value is 0. All functions
876 // return npos if there were no match.
879 size_t find(const wxString
& str
, size_t nStart
= 0) const;
881 // VC++ 1.5 can't cope with this syntax.
882 #if !defined(__VISUALC__) || defined(__WIN32__)
883 // find first n characters of sz
884 size_t find(const wxChar
* sz
, size_t nStart
= 0, size_t n
= npos
) const;
887 // Gives a duplicate symbol (presumably a case-insensitivity problem)
888 #if !defined(__BORLANDC__)
889 // find the first occurence of character ch after nStart
890 size_t find(wxChar ch
, size_t nStart
= 0) const;
892 // rfind() family is exactly like find() but works right to left
894 // as find, but from the end
895 size_t rfind(const wxString
& str
, size_t nStart
= npos
) const;
897 // VC++ 1.5 can't cope with this syntax.
898 #if !defined(__VISUALC__) || defined(__WIN32__)
899 // as find, but from the end
900 size_t rfind(const wxChar
* sz
, size_t nStart
= npos
,
901 size_t n
= npos
) const;
902 // as find, but from the end
903 size_t rfind(wxChar ch
, size_t nStart
= npos
) const;
906 // find first/last occurence of any character in the set
908 // as strpbrk() but starts at nStart, returns npos if not found
909 size_t find_first_of(const wxString
& str
, size_t nStart
= 0) const
910 { return find_first_of(str
.c_str(), nStart
); }
912 size_t find_first_of(const wxChar
* sz
, size_t nStart
= 0) const;
913 // same as find(char, size_t)
914 size_t find_first_of(wxChar c
, size_t nStart
= 0) const
915 { return find(c
, nStart
); }
916 // find the last (starting from nStart) char from str in this string
917 size_t find_last_of (const wxString
& str
, size_t nStart
= npos
) const
918 { return find_last_of(str
.c_str(), nStart
); }
920 size_t find_last_of (const wxChar
* sz
, size_t nStart
= npos
) const;
922 size_t find_last_of(wxChar c
, size_t nStart
= npos
) const
923 { return rfind(c
, nStart
); }
925 // find first/last occurence of any character not in the set
927 // as strspn() (starting from nStart), returns npos on failure
928 size_t find_first_not_of(const wxString
& str
, size_t nStart
= 0) const
929 { return find_first_not_of(str
.c_str(), nStart
); }
931 size_t find_first_not_of(const wxChar
* sz
, size_t nStart
= 0) const;
933 size_t find_first_not_of(wxChar ch
, size_t nStart
= 0) const;
935 size_t find_last_not_of(const wxString
& str
, size_t nStart
= npos
) const
936 { return find_first_not_of(str
.c_str(), nStart
); }
938 size_t find_last_not_of(const wxChar
* sz
, size_t nStart
= npos
) const;
940 size_t find_last_not_of(wxChar ch
, size_t nStart
= npos
) const;
942 // All compare functions return -1, 0 or 1 if the [sub]string is less,
943 // equal or greater than the compare() argument.
945 // just like strcmp()
946 int compare(const wxString
& str
) const { return Cmp(str
); }
947 // comparison with a substring
948 int compare(size_t nStart
, size_t nLen
, const wxString
& str
) const
949 { return Mid(nStart
, nLen
).Cmp(str
); }
950 // comparison of 2 substrings
951 int compare(size_t nStart
, size_t nLen
,
952 const wxString
& str
, size_t nStart2
, size_t nLen2
) const
953 { return Mid(nStart
, nLen
).Cmp(str
.Mid(nStart2
, nLen2
)); }
954 // just like strcmp()
955 int compare(const wxChar
* sz
) const { return Cmp(sz
); }
956 // substring comparison with first nCount characters of sz
957 int compare(size_t nStart
, size_t nLen
,
958 const wxChar
* sz
, size_t nCount
= npos
) const
959 { return Mid(nStart
, nLen
).Cmp(wxString(sz
, nCount
)); }
961 // substring extraction
962 wxString
substr(size_t nStart
= 0, size_t nLen
= npos
) const
963 { return Mid(nStart
, nLen
); }
964 #endif // wxSTD_STRING_COMPATIBILITY
967 // ----------------------------------------------------------------------------
968 // The string array uses it's knowledge of internal structure of the wxString
969 // class to optimize string storage. Normally, we would store pointers to
970 // string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
971 // sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
972 // really all we need to turn such pointer into a string!
974 // Of course, it can be called a dirty hack, but we use twice less memory and
975 // this approach is also more speed efficient, so it's probably worth it.
977 // Usage notes: when a string is added/inserted, a new copy of it is created,
978 // so the original string may be safely deleted. When a string is retrieved
979 // from the array (operator[] or Item() method), a reference is returned.
980 // ----------------------------------------------------------------------------
982 class WXDLLEXPORT wxArrayString
985 // type of function used by wxArrayString::Sort()
986 typedef int (*CompareFunction
)(const wxString
& first
,
987 const wxString
& second
);
989 // constructors and destructor
990 // default ctor: if autoSort is TRUE, the array is always sorted (in
991 // alphabetical order)
992 wxArrayString(bool autoSort
= FALSE
);
994 wxArrayString(const wxArrayString
& array
);
995 // assignment operator
996 wxArrayString
& operator=(const wxArrayString
& src
);
997 // not virtual, this class should not be derived from
1000 // memory management
1001 // empties the list, but doesn't release memory
1003 // empties the list and releases memory
1005 // preallocates memory for given number of items
1006 void Alloc(size_t nCount
);
1007 // minimzes the memory usage (by freeing all extra memory)
1011 // number of elements in the array
1012 size_t GetCount() const { return m_nCount
; }
1014 bool IsEmpty() const { return m_nCount
== 0; }
1015 // number of elements in the array (GetCount is preferred API)
1016 size_t Count() const { return m_nCount
; }
1018 // items access (range checking is done in debug version)
1019 // get item at position uiIndex
1020 wxString
& Item(size_t nIndex
) const
1021 { wxASSERT( nIndex
< m_nCount
); return *(wxString
*)&(m_pItems
[nIndex
]); }
1023 wxString
& operator[](size_t nIndex
) const { return Item(nIndex
); }
1025 wxString
& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
1028 // Search the element in the array, starting from the beginning if
1029 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
1030 // sensitive (default). Returns index of the first item matched or
1032 int Index (const wxChar
*sz
, bool bCase
= TRUE
, bool bFromEnd
= FALSE
) const;
1033 // add new element at the end (if the array is not sorted), return its
1035 size_t Add(const wxString
& str
);
1036 // add new element at given position
1037 void Insert(const wxString
& str
, size_t uiIndex
);
1038 // expand the array to have count elements
1039 void SetCount(size_t count
);
1040 // remove first item matching this value
1041 void Remove(const wxChar
*sz
);
1042 // remove item by index
1043 void Remove(size_t nIndex
);
1044 void RemoveAt(size_t nIndex
) { Remove(nIndex
); }
1047 // sort array elements in alphabetical order (or reversed alphabetical
1048 // order if reverseOrder parameter is TRUE)
1049 void Sort(bool reverseOrder
= FALSE
);
1050 // sort array elements using specified comparaison function
1051 void Sort(CompareFunction compareFunction
);
1054 // compare two arrays case sensitively
1055 bool operator==(const wxArrayString
& a
) const;
1056 // compare two arrays case sensitively
1057 bool operator!=(const wxArrayString
& a
) const { return !(*this == a
); }
1060 void Copy(const wxArrayString
& src
); // copies the contents of another array
1063 void Grow(); // makes array bigger if needed
1064 void Free(); // free all the strings stored
1066 void DoSort(); // common part of all Sort() variants
1068 size_t m_nSize
, // current size of the array
1069 m_nCount
; // current number of elements
1071 wxChar
**m_pItems
; // pointer to data
1073 bool m_autoSort
; // if TRUE, keep the array always sorted
1076 class WXDLLEXPORT wxSortedArrayString
: public wxArrayString
1079 wxSortedArrayString() : wxArrayString(TRUE
)
1081 wxSortedArrayString(const wxArrayString
& array
) : wxArrayString(TRUE
)
1085 // ---------------------------------------------------------------------------
1086 // wxString comparison functions: operator versions are always case sensitive
1087 // ---------------------------------------------------------------------------
1089 inline bool operator==(const wxString
& s1
, const wxString
& s2
)
1090 { return (s1
.Len() == s2
.Len()) && (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; }
1095 inline bool operator!=(const wxString
& s1
, const wxString
& s2
)
1096 { return (s1
.Len() != s2
.Len()) || (s1
.Cmp(s2
) != 0); }
1097 inline bool operator!=(const wxString
& s1
, const wxChar
* s2
)
1098 { return s1
.Cmp(s2
) != 0; }
1099 inline bool operator!=(const wxChar
* s1
, const wxString
& s2
)
1100 { return s2
.Cmp(s1
) != 0; }
1101 inline bool operator< (const wxString
& s1
, const wxString
& s2
)
1102 { return s1
.Cmp(s2
) < 0; }
1103 inline bool operator< (const wxString
& s1
, const wxChar
* s2
)
1104 { return s1
.Cmp(s2
) < 0; }
1105 inline bool operator< (const wxChar
* s1
, const wxString
& s2
)
1106 { return s2
.Cmp(s1
) > 0; }
1107 inline bool operator> (const wxString
& s1
, const wxString
& s2
)
1108 { return s1
.Cmp(s2
) > 0; }
1109 inline bool operator> (const wxString
& s1
, const wxChar
* s2
)
1110 { return s1
.Cmp(s2
) > 0; }
1111 inline bool operator> (const wxChar
* s1
, const wxString
& s2
)
1112 { return s2
.Cmp(s1
) < 0; }
1113 inline bool operator<=(const wxString
& s1
, const wxString
& s2
)
1114 { return s1
.Cmp(s2
) <= 0; }
1115 inline bool operator<=(const wxString
& s1
, const wxChar
* s2
)
1116 { return s1
.Cmp(s2
) <= 0; }
1117 inline bool operator<=(const wxChar
* s1
, const wxString
& s2
)
1118 { return s2
.Cmp(s1
) >= 0; }
1119 inline bool operator>=(const wxString
& s1
, const wxString
& s2
)
1120 { return s1
.Cmp(s2
) >= 0; }
1121 inline bool operator>=(const wxString
& s1
, const wxChar
* s2
)
1122 { return s1
.Cmp(s2
) >= 0; }
1123 inline bool operator>=(const wxChar
* s1
, const wxString
& s2
)
1124 { return s2
.Cmp(s1
) <= 0; }
1126 // comparison with char
1127 inline bool operator==(wxChar c
, const wxString
& s
) { return s
.IsSameAs(c
); }
1128 inline bool operator==(const wxString
& s
, wxChar c
) { return s
.IsSameAs(c
); }
1129 inline bool operator!=(wxChar c
, const wxString
& s
) { return !s
.IsSameAs(c
); }
1130 inline bool operator!=(const wxString
& s
, wxChar c
) { return !s
.IsSameAs(c
); }
1133 inline bool operator==(const wxString
& s1
, const wxWCharBuffer
& s2
)
1134 { return (s1
.Cmp((const wchar_t *)s2
) == 0); }
1135 inline bool operator==(const wxWCharBuffer
& s1
, const wxString
& s2
)
1136 { return (s2
.Cmp((const wchar_t *)s1
) == 0); }
1137 inline bool operator!=(const wxString
& s1
, const wxWCharBuffer
& s2
)
1138 { return (s1
.Cmp((const wchar_t *)s2
) != 0); }
1139 inline bool operator!=(const wxWCharBuffer
& s1
, const wxString
& s2
)
1140 { return (s2
.Cmp((const wchar_t *)s1
) != 0); }
1141 #else // !wxUSE_UNICODE
1142 inline bool operator==(const wxString
& s1
, const wxCharBuffer
& s2
)
1143 { return (s1
.Cmp((const char *)s2
) == 0); }
1144 inline bool operator==(const wxCharBuffer
& s1
, const wxString
& s2
)
1145 { return (s2
.Cmp((const char *)s1
) == 0); }
1146 inline bool operator!=(const wxString
& s1
, const wxCharBuffer
& s2
)
1147 { return (s1
.Cmp((const char *)s2
) != 0); }
1148 inline bool operator!=(const wxCharBuffer
& s1
, const wxString
& s2
)
1149 { return (s2
.Cmp((const char *)s1
) != 0); }
1150 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1152 wxString WXDLLEXPORT
operator+(const wxString
& string1
, const wxString
& string2
);
1153 wxString WXDLLEXPORT
operator+(const wxString
& string
, wxChar ch
);
1154 wxString WXDLLEXPORT
operator+(wxChar ch
, const wxString
& string
);
1155 wxString WXDLLEXPORT
operator+(const wxString
& string
, const wxChar
*psz
);
1156 wxString WXDLLEXPORT
operator+(const wxChar
*psz
, const wxString
& string
);
1158 inline wxString
operator+(const wxString
& string
, const wxWCharBuffer
& buf
)
1159 { return string
+ (const wchar_t *)buf
; }
1160 inline wxString
operator+(const wxWCharBuffer
& buf
, const wxString
& string
)
1161 { return (const wchar_t *)buf
+ string
; }
1162 #else // !wxUSE_UNICODE
1163 inline wxString
operator+(const wxString
& string
, const wxCharBuffer
& buf
)
1164 { return string
+ (const char *)buf
; }
1165 inline wxString
operator+(const wxCharBuffer
& buf
, const wxString
& string
)
1166 { return (const char *)buf
+ string
; }
1167 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1169 // ---------------------------------------------------------------------------
1170 // Implementation only from here until the end of file
1171 // ---------------------------------------------------------------------------
1173 // don't pollute the library user's name space
1174 #undef ASSERT_VALID_INDEX
1176 #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
1178 #include "wx/ioswrap.h"
1180 WXDLLEXPORT wxSTD istream
& operator>>(wxSTD istream
&, wxString
&);
1181 WXDLLEXPORT wxSTD ostream
& operator<<(wxSTD ostream
&, const wxString
&);
1183 #endif // wxSTD_STRING_COMPATIBILITY
1185 #endif // _WX_WXSTRINGH__