]> git.saurik.com Git - wxWidgets.git/blob - include/wx/string.h
projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Compilation fixes.
[wxWidgets.git] / include / wx / string.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/string.h
3 // Purpose: wxString and wxArrayString classes
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 29/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 /*
13 Efficient string class [more or less] compatible with MFC CString,
14 wxWidgets version 1 wxString and std::string and some handy functions
15 missing from string.h.
16 */
17
18 #ifndef _WX_WXSTRINGH__
19 #define _WX_WXSTRINGH__
20
21 // ----------------------------------------------------------------------------
22 // headers
23 // ----------------------------------------------------------------------------
24
25 #include "wx/defs.h" // everybody should include this
26
27 #if defined(__WXMAC__) || defined(__VISAGECPP__)
28 #include <ctype.h>
29 #endif
30
31 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
32 // problem in VACPP V4 with including stdlib.h multiple times
33 // strconv includes it anyway
34 # include <stdio.h>
35 # include <string.h>
36 # include <stdarg.h>
37 # include <limits.h>
38 #else
39 # include <string.h>
40 # include <stdio.h>
41 # include <stdarg.h>
42 # include <limits.h>
43 # include <stdlib.h>
44 #endif
45
46 #ifdef HAVE_STRCASECMP_IN_STRINGS_H
47 #include <strings.h> // for strcasecmp()
48 #endif // HAVE_STRCASECMP_IN_STRINGS_H
49
50 #ifdef __WXPALMOS__
51 #include <StringMgr.h>
52 #endif
53
54 #include "wx/wxchar.h" // for wxChar
55 #include "wx/buffer.h" // for wxCharBuffer
56 #include "wx/strconv.h" // for wxConvertXXX() macros and wxMBConv classes
57
58 class WXDLLIMPEXP_BASE wxString;
59
60 // ---------------------------------------------------------------------------
61 // macros
62 // ---------------------------------------------------------------------------
63
64 // casts [unfortunately!] needed to call some broken functions which require
65 // "char *" instead of "const char *"
66 #define WXSTRINGCAST (wxChar *)(const wxChar *)
67 #define wxCSTRINGCAST (wxChar *)(const wxChar *)
68 #define wxMBSTRINGCAST (char *)(const char *)
69 #define wxWCSTRINGCAST (wchar_t *)(const wchar_t *)
70
71 // implementation only
72 #define wxASSERT_VALID_INDEX(i) \
73 wxASSERT_MSG( (size_t)(i) <= length(), _T("invalid index in wxString") )
74
75 // ----------------------------------------------------------------------------
76 // constants
77 // ----------------------------------------------------------------------------
78
79 // maximum possible length for a string means "take all string" everywhere
80 #define wxSTRING_MAXLEN wxStringBase::npos
81
82 // ----------------------------------------------------------------------------
83 // global data
84 // ----------------------------------------------------------------------------
85
86 // global pointer to empty string
87 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString;
88
89 // ---------------------------------------------------------------------------
90 // global functions complementing standard C string library replacements for
91 // strlen() and portable strcasecmp()
92 //---------------------------------------------------------------------------
93
94 // Use wxXXX() functions from wxchar.h instead! These functions are for
95 // backwards compatibility only.
96
97 // checks whether the passed in pointer is NULL and if the string is empty
98 inline bool IsEmpty(const char *p) { return (!p || !*p); }
99
100 // safe version of strlen() (returns 0 if passed NULL pointer)
101 inline size_t Strlen(const char *psz)
102 { return psz ? strlen(psz) : 0; }
103
104 // portable strcasecmp/_stricmp
105 inline int Stricmp(const char *psz1, const char *psz2)
106 {
107 #if defined(__VISUALC__) && defined(__WXWINCE__)
108 register char c1, c2;
109 do {
110 c1 = tolower(*psz1++);
111 c2 = tolower(*psz2++);
112 } while ( c1 && (c1 == c2) );
113
114 return c1 - c2;
115 #elif defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
116 return _stricmp(psz1, psz2);
117 #elif defined(__SC__)
118 return _stricmp(psz1, psz2);
119 #elif defined(__SALFORDC__)
120 return stricmp(psz1, psz2);
121 #elif defined(__BORLANDC__)
122 return stricmp(psz1, psz2);
123 #elif defined(__WATCOMC__)
124 return stricmp(psz1, psz2);
125 #elif defined(__DJGPP__)
126 return stricmp(psz1, psz2);
127 #elif defined(__EMX__)
128 return stricmp(psz1, psz2);
129 #elif defined(__WXPM__)
130 return stricmp(psz1, psz2);
131 #elif defined(__WXPALMOS__) || \
132 defined(HAVE_STRCASECMP_IN_STRING_H) || \
133 defined(HAVE_STRCASECMP_IN_STRINGS_H) || \
134 defined(__GNUWIN32__)
135 return strcasecmp(psz1, psz2);
136 #elif defined(__MWERKS__) && !defined(__INTEL__)
137 register char c1, c2;
138 do {
139 c1 = tolower(*psz1++);
140 c2 = tolower(*psz2++);
141 } while ( c1 && (c1 == c2) );
142
143 return c1 - c2;
144 #else
145 // almost all compilers/libraries provide this function (unfortunately under
146 // different names), that's why we don't implement our own which will surely
147 // be more efficient than this code (uncomment to use):
148 /*
149 register char c1, c2;
150 do {
151 c1 = tolower(*psz1++);
152 c2 = tolower(*psz2++);
153 } while ( c1 && (c1 == c2) );
154
155 return c1 - c2;
156 */
157
158 #error "Please define string case-insensitive compare for your OS/compiler"
159 #endif // OS/compiler
160 }
161
162 // ----------------------------------------------------------------------------
163 // deal with STL/non-STL/non-STL-but-wxUSE_STD_STRING
164 // ----------------------------------------------------------------------------
165
166 // in both cases we need to define wxStdString
167 #if wxUSE_STL || wxUSE_STD_STRING
168
169 #include "wx/beforestd.h"
170 #include <string>
171 #include "wx/afterstd.h"
172
173 #if wxUSE_UNICODE
174 #ifdef HAVE_STD_WSTRING
175 typedef std::wstring wxStdString;
176 #else
177 typedef std::basic_string<wxChar> wxStdString;
178 #endif
179 #else
180 typedef std::string wxStdString;
181 #endif
182
183 #endif // need <string>
184
185 #if wxUSE_STL
186
187 // we don't need an extra ctor from std::string when copy ctor already does
188 // the work
189 #undef wxUSE_STD_STRING
190 #define wxUSE_STD_STRING 0
191
192 #if (defined(__GNUG__) && (__GNUG__ < 3)) || \
193 (defined(_MSC_VER) && (_MSC_VER <= 1200))
194 #define wxSTRING_BASE_HASNT_CLEAR
195 #endif
196
197 typedef wxStdString wxStringBase;
198 #else // if !wxUSE_STL
199
200 #if !defined(HAVE_STD_STRING_COMPARE) && \
201 (!defined(__WX_SETUP_H__) || wxUSE_STL == 0)
202 #define HAVE_STD_STRING_COMPARE
203 #endif
204
205 // ---------------------------------------------------------------------------
206 // string data prepended with some housekeeping info (used by wxString class),
207 // is never used directly (but had to be put here to allow inlining)
208 // ---------------------------------------------------------------------------
209
210 struct WXDLLIMPEXP_BASE wxStringData
211 {
212 int nRefs; // reference count
213 size_t nDataLength, // actual string length
214 nAllocLength; // allocated memory size
215
216 // mimics declaration 'wxChar data[nAllocLength]'
217 wxChar* data() const { return (wxChar*)(this + 1); }
218
219 // empty string has a special ref count so it's never deleted
220 bool IsEmpty() const { return (nRefs == -1); }
221 bool IsShared() const { return (nRefs > 1); }
222
223 // lock/unlock
224 void Lock() { if ( !IsEmpty() ) nRefs++; }
225
226 // VC++ will refuse to inline Unlock but profiling shows that it is wrong
227 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
228 __forceinline
229 #endif
230 // VC++ free must take place in same DLL as allocation when using non dll
231 // run-time library (e.g. Multithreaded instead of Multithreaded DLL)
232 #if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
233 void Unlock() { if ( !IsEmpty() && --nRefs == 0) Free(); }
234 // we must not inline deallocation since allocation is not inlined
235 void Free();
236 #else
237 void Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this); }
238 #endif
239
240 // if we had taken control over string memory (GetWriteBuf), it's
241 // intentionally put in invalid state
242 void Validate(bool b) { nRefs = (b ? 1 : 0); }
243 bool IsValid() const { return (nRefs != 0); }
244 };
245
246 class WXDLLIMPEXP_BASE wxStringBase
247 {
248 #if !wxUSE_STL
249 friend class WXDLLIMPEXP_BASE wxArrayString;
250 #endif
251 public :
252 // an 'invalid' value for string index, moved to this place due to a CW bug
253 static const size_t npos;
254 protected:
255 // points to data preceded by wxStringData structure with ref count info
256 wxChar *m_pchData;
257
258 // accessor to string data
259 wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
260
261 // string (re)initialization functions
262 // initializes the string to the empty value (must be called only from
263 // ctors, use Reinit() otherwise)
264 void Init() { m_pchData = (wxChar *)wxEmptyString; }
265 // initializes the string with (a part of) C-string
266 void InitWith(const wxChar *psz, size_t nPos = 0, size_t nLen = npos);
267 // as Init, but also frees old data
268 void Reinit() { GetStringData()->Unlock(); Init(); }
269
270 // memory allocation
271 // allocates memory for string of length nLen
272 bool AllocBuffer(size_t nLen);
273 // copies data to another string
274 bool AllocCopy(wxString&, int, int) const;
275 // effectively copies data to string
276 bool AssignCopy(size_t, const wxChar *);
277
278 // append a (sub)string
279 bool ConcatSelf(size_t nLen, const wxChar *src, size_t nMaxLen);
280 bool ConcatSelf(size_t nLen, const wxChar *src)
281 { return ConcatSelf(nLen, src, nLen); }
282
283 // functions called before writing to the string: they copy it if there
284 // are other references to our data (should be the only owner when writing)
285 bool CopyBeforeWrite();
286 bool AllocBeforeWrite(size_t);
287
288 // compatibility with wxString
289 bool Alloc(size_t nLen);
290 public:
291 // standard types
292 typedef wxChar value_type;
293 typedef wxChar char_type;
294 typedef size_t size_type;
295 typedef value_type& reference;
296 typedef const value_type& const_reference;
297 typedef value_type* pointer;
298 typedef const value_type* const_pointer;
299 typedef value_type *iterator;
300 typedef const value_type *const_iterator;
301
302 // constructors and destructor
303 // ctor for an empty string
304 wxStringBase() { Init(); }
305 // copy ctor
306 wxStringBase(const wxStringBase& stringSrc)
307 {
308 wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
309 _T("did you forget to call UngetWriteBuf()?") );
310
311 if ( stringSrc.empty() ) {
312 // nothing to do for an empty string
313 Init();
314 }
315 else {
316 m_pchData = stringSrc.m_pchData; // share same data
317 GetStringData()->Lock(); // => one more copy
318 }
319 }
320 // string containing nRepeat copies of ch
321 wxStringBase(size_type nRepeat, wxChar ch);
322 // ctor takes first nLength characters from C string
323 // (default value of npos means take all the string)
324 wxStringBase(const wxChar *psz)
325 { InitWith(psz, 0, npos); }
326 wxStringBase(const wxChar *psz, size_t nLength)
327 { InitWith(psz, 0, nLength); }
328 wxStringBase(const wxChar *psz, wxMBConv& WXUNUSED(conv), size_t nLength = npos)
329 { InitWith(psz, 0, nLength); }
330 // take nLen chars starting at nPos
331 wxStringBase(const wxStringBase& str, size_t nPos, size_t nLen)
332 {
333 wxASSERT_MSG( str.GetStringData()->IsValid(),
334 _T("did you forget to call UngetWriteBuf()?") );
335 Init();
336 size_t strLen = str.length() - nPos; nLen = strLen < nLen ? strLen : nLen;
337 InitWith(str.c_str(), nPos, nLen);
338 }
339 // take all characters from pStart to pEnd
340 wxStringBase(const void *pStart, const void *pEnd);
341
342 // dtor is not virtual, this class must not be inherited from!
343 ~wxStringBase()
344 {
345 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
346 //RN - according to the above VC++ does indeed inline this,
347 //even though it spits out two warnings
348 #pragma warning (disable:4714)
349 #endif
350
351 GetStringData()->Unlock();
352 }
353
354 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
355 //re-enable inlining warning
356 #pragma warning (default:4714)
357 #endif
358 // overloaded assignment
359 // from another wxString
360 wxStringBase& operator=(const wxStringBase& stringSrc);
361 // from a character
362 wxStringBase& operator=(wxChar ch);
363 // from a C string
364 wxStringBase& operator=(const wxChar *psz);
365
366 // return the length of the string
367 size_type size() const { return GetStringData()->nDataLength; }
368 // return the length of the string
369 size_type length() const { return size(); }
370 // return the maximum size of the string
371 size_type max_size() const { return wxSTRING_MAXLEN; }
372 // resize the string, filling the space with c if c != 0
373 void resize(size_t nSize, wxChar ch = wxT('\0'));
374 // delete the contents of the string
375 void clear() { erase(0, npos); }
376 // returns true if the string is empty
377 bool empty() const { return size() == 0; }
378 // inform string about planned change in size
379 void reserve(size_t sz) { Alloc(sz); }
380 size_type capacity() const { return GetStringData()->nAllocLength; }
381
382 // lib.string.access
383 // return the character at position n
384 value_type at(size_type n) const
385 { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
386 // returns the writable character at position n
387 reference at(size_type n)
388 { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
389
390 // lib.string.modifiers
391 // append elements str[pos], ..., str[pos+n]
392 wxStringBase& append(const wxStringBase& str, size_t pos, size_t n)
393 {
394 wxASSERT(pos <= str.length());
395 ConcatSelf(n, str.c_str() + pos, str.length() - pos);
396 return *this;
397 }
398 // append a string
399 wxStringBase& append(const wxStringBase& str)
400 { ConcatSelf(str.length(), str.c_str()); return *this; }
401 // append first n (or all if n == npos) characters of sz
402 wxStringBase& append(const wxChar *sz)
403 { ConcatSelf(wxStrlen(sz), sz); return *this; }
404 wxStringBase& append(const wxChar *sz, size_t n)
405 { ConcatSelf(n, sz); return *this; }
406 // append n copies of ch
407 wxStringBase& append(size_t n, wxChar ch);
408 // append from first to last
409 wxStringBase& append(const_iterator first, const_iterator last)
410 { ConcatSelf(last - first, first); return *this; }
411
412 // same as `this_string = str'
413 wxStringBase& assign(const wxStringBase& str)
414 { return *this = str; }
415 // same as ` = str[pos..pos + n]
416 wxStringBase& assign(const wxStringBase& str, size_t pos, size_t n)
417 { clear(); return append(str, pos, n); }
418 // same as `= first n (or all if n == npos) characters of sz'
419 wxStringBase& assign(const wxChar *sz)
420 { clear(); return append(sz, wxStrlen(sz)); }
421 wxStringBase& assign(const wxChar *sz, size_t n)
422 { clear(); return append(sz, n); }
423 // same as `= n copies of ch'
424 wxStringBase& assign(size_t n, wxChar ch)
425 { clear(); return append(n, ch); }
426 // assign from first to last
427 wxStringBase& assign(const_iterator first, const_iterator last)
428 { clear(); return append(first, last); }
429
430 // first valid index position
431 const_iterator begin() const { return m_pchData; }
432 // position one after the last valid one
433 const_iterator end() const { return m_pchData + length(); }
434
435 // first valid index position
436 iterator begin();
437 // position one after the last valid one
438 iterator end();
439
440 // insert another string
441 wxStringBase& insert(size_t nPos, const wxStringBase& str)
442 {
443 wxASSERT( str.GetStringData()->IsValid() );
444 return insert(nPos, str.c_str(), str.length());
445 }
446 // insert n chars of str starting at nStart (in str)
447 wxStringBase& insert(size_t nPos, const wxStringBase& str, size_t nStart, size_t n)
448 {
449 wxASSERT( str.GetStringData()->IsValid() );
450 wxASSERT( nStart < str.length() );
451 size_t strLen = str.length() - nStart;
452 n = strLen < n ? strLen : n;
453 return insert(nPos, str.c_str() + nStart, n);
454 }
455 // insert first n (or all if n == npos) characters of sz
456 wxStringBase& insert(size_t nPos, const wxChar *sz, size_t n = npos);
457 // insert n copies of ch
458 wxStringBase& insert(size_t nPos, size_t n, wxChar ch)
459 { return insert(nPos, wxStringBase(n, ch)); }
460 iterator insert(iterator it, wxChar ch)
461 { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; }
462 void insert(iterator it, const_iterator first, const_iterator last)
463 { insert(it - begin(), first, last - first); }
464 void insert(iterator it, size_type n, wxChar ch)
465 { insert(it - begin(), n, ch); }
466
467 // delete characters from nStart to nStart + nLen
468 wxStringBase& erase(size_type pos = 0, size_type n = npos);
469 iterator erase(iterator first, iterator last)
470 {
471 size_t idx = first - begin();
472 erase(idx, last - first);
473 return begin() + idx;
474 }
475 iterator erase(iterator first);
476
477 // explicit conversion to C string (use this with printf()!)
478 const wxChar* c_str() const { return m_pchData; }
479 const wxChar* data() const { return m_pchData; }
480
481 // replaces the substring of length nLen starting at nStart
482 wxStringBase& replace(size_t nStart, size_t nLen, const wxChar* sz);
483 // replaces the substring of length nLen starting at nStart
484 wxStringBase& replace(size_t nStart, size_t nLen, const wxStringBase& str)
485 { return replace(nStart, nLen, str.c_str()); }
486 // replaces the substring with nCount copies of ch
487 wxStringBase& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch);
488 // replaces a substring with another substring
489 wxStringBase& replace(size_t nStart, size_t nLen,
490 const wxStringBase& str, size_t nStart2, size_t nLen2);
491 // replaces the substring with first nCount chars of sz
492 wxStringBase& replace(size_t nStart, size_t nLen,
493 const wxChar* sz, size_t nCount);
494 wxStringBase& replace(iterator first, iterator last, const_pointer s)
495 { return replace(first - begin(), last - first, s); }
496 wxStringBase& replace(iterator first, iterator last, const_pointer s,
497 size_type n)
498 { return replace(first - begin(), last - first, s, n); }
499 wxStringBase& replace(iterator first, iterator last, const wxStringBase& s)
500 { return replace(first - begin(), last - first, s); }
501 wxStringBase& replace(iterator first, iterator last, size_type n, wxChar c)
502 { return replace(first - begin(), last - first, n, c); }
503 wxStringBase& replace(iterator first, iterator last,
504 const_iterator first1, const_iterator last1)
505 { return replace(first - begin(), last - first, first1, last1 - first1); }
506
507 // swap two strings
508 void swap(wxStringBase& str);
509
510 // All find() functions take the nStart argument which specifies the
511 // position to start the search on, the default value is 0. All functions
512 // return npos if there were no match.
513
514 // find a substring
515 size_t find(const wxStringBase& str, size_t nStart = 0) const;
516
517 // find first n characters of sz
518 size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
519
520 // find the first occurence of character ch after nStart
521 size_t find(wxChar ch, size_t nStart = 0) const;
522
523 // rfind() family is exactly like find() but works right to left
524
525 // as find, but from the end
526 size_t rfind(const wxStringBase& str, size_t nStart = npos) const;
527
528 // as find, but from the end
529 size_t rfind(const wxChar* sz, size_t nStart = npos,
530 size_t n = npos) const;
531 // as find, but from the end
532 size_t rfind(wxChar ch, size_t nStart = npos) const;
533
534 // find first/last occurence of any character in the set
535
536 // as strpbrk() but starts at nStart, returns npos if not found
537 size_t find_first_of(const wxStringBase& str, size_t nStart = 0) const
538 { return find_first_of(str.c_str(), nStart); }
539 // same as above
540 size_t find_first_of(const wxChar* sz, size_t nStart = 0) const;
541 size_t find_first_of(const wxChar* sz, size_t nStart, size_t n) const;
542 // same as find(char, size_t)
543 size_t find_first_of(wxChar c, size_t nStart = 0) const
544 { return find(c, nStart); }
545 // find the last (starting from nStart) char from str in this string
546 size_t find_last_of (const wxStringBase& str, size_t nStart = npos) const
547 { return find_last_of(str.c_str(), nStart); }
548 // same as above
549 size_t find_last_of (const wxChar* sz, size_t nStart = npos) const;
550 size_t find_last_of(const wxChar* sz, size_t nStart, size_t n) const;
551 // same as above
552 size_t find_last_of(wxChar c, size_t nStart = npos) const
553 { return rfind(c, nStart); }
554
555 // find first/last occurence of any character not in the set
556
557 // as strspn() (starting from nStart), returns npos on failure
558 size_t find_first_not_of(const wxStringBase& str, size_t nStart = 0) const
559 { return find_first_not_of(str.c_str(), nStart); }
560 // same as above
561 size_t find_first_not_of(const wxChar* sz, size_t nStart = 0) const;
562 size_t find_first_not_of(const wxChar* sz, size_t nStart, size_t n) const;
563 // same as above
564 size_t find_first_not_of(wxChar ch, size_t nStart = 0) const;
565 // as strcspn()
566 size_t find_last_not_of(const wxStringBase& str, size_t nStart = npos) const
567 { return find_last_not_of(str.c_str(), nStart); }
568 // same as above
569 size_t find_last_not_of(const wxChar* sz, size_t nStart = npos) const;
570 size_t find_last_not_of(const wxChar* sz, size_t nStart, size_t n) const;
571 // same as above
572 size_t find_last_not_of(wxChar ch, size_t nStart = npos) const;
573
574 // All compare functions return -1, 0 or 1 if the [sub]string is less,
575 // equal or greater than the compare() argument.
576
577 // comparison with another string
578 int compare(const wxStringBase& str) const;
579 // comparison with a substring
580 int compare(size_t nStart, size_t nLen, const wxStringBase& str) const;
581 // comparison of 2 substrings
582 int compare(size_t nStart, size_t nLen,
583 const wxStringBase& str, size_t nStart2, size_t nLen2) const;
584 // comparison with a c string
585 int compare(const wxChar* sz) const;
586 // substring comparison with first nCount characters of sz
587 int compare(size_t nStart, size_t nLen,
588 const wxChar* sz, size_t nCount = npos) const;
589
590 size_type copy(wxChar* s, size_type n, size_type pos = 0);
591
592 // substring extraction
593 wxStringBase substr(size_t nStart = 0, size_t nLen = npos) const;
594
595 // string += string
596 wxStringBase& operator+=(const wxStringBase& s) { return append(s); }
597 // string += C string
598 wxStringBase& operator+=(const wxChar *psz) { return append(psz); }
599 // string += char
600 wxStringBase& operator+=(wxChar ch) { return append(1, ch); }
601 };
602
603 #endif // !wxUSE_STL
604
605 // ----------------------------------------------------------------------------
606 // wxString: string class trying to be compatible with std::string, MFC
607 // CString and wxWindows 1.x wxString all at once
608 // ---------------------------------------------------------------------------
609
610 class WXDLLIMPEXP_BASE wxString : public wxStringBase
611 {
612 #if !wxUSE_STL
613 friend class WXDLLIMPEXP_BASE wxArrayString;
614 #endif
615
616 // NB: special care was taken in arranging the member functions in such order
617 // that all inline functions can be effectively inlined, verify that all
618 // performace critical functions are still inlined if you change order!
619 private:
620 // if we hadn't made these operators private, it would be possible to
621 // compile "wxString s; s = 17;" without any warnings as 17 is implicitly
622 // converted to char in C and we do have operator=(char)
623 //
624 // NB: we don't need other versions (short/long and unsigned) as attempt
625 // to assign another numeric type to wxString will now result in
626 // ambiguity between operator=(char) and operator=(int)
627 wxString& operator=(int);
628
629 // these methods are not implemented - there is _no_ conversion from int to
630 // string, you're doing something wrong if the compiler wants to call it!
631 //
632 // try `s << i' or `s.Printf("%d", i)' instead
633 wxString(int);
634
635 public:
636 // constructors and destructor
637 // ctor for an empty string
638 wxString() : wxStringBase() { }
639 // copy ctor
640 wxString(const wxStringBase& stringSrc) : wxStringBase(stringSrc) { }
641 wxString(const wxString& stringSrc) : wxStringBase(stringSrc) { }
642 // string containing nRepeat copies of ch
643 wxString(wxChar ch, size_t nRepeat = 1)
644 : wxStringBase(nRepeat, ch) { }
645 wxString(size_t nRepeat, wxChar ch)
646 : wxStringBase(nRepeat, ch) { }
647 // ctor takes first nLength characters from C string
648 // (default value of npos means take all the string)
649 wxString(const wxChar *psz)
650 : wxStringBase(psz ? psz : wxT("")) { }
651 wxString(const wxChar *psz, size_t nLength)
652 : wxStringBase(psz, nLength) { }
653 wxString(const wxChar *psz, wxMBConv& WXUNUSED(conv), size_t nLength = npos)
654 : wxStringBase(psz, nLength == npos ? wxStrlen(psz) : nLength) { }
655
656 // even we're not build with wxUSE_STL == 1 it is very convenient to allow
657 // implicit conversions from std::string to wxString as this allows to use
658 // the same strings in non-GUI and GUI code, however we don't want to
659 // unconditionally add this ctor as it would make wx lib dependent on
660 // libstdc++ on some Linux versions which is bad, so instead we ask the
661 // client code to define this wxUSE_STD_STRING symbol if they need it
662 #if wxUSE_STD_STRING
663 wxString(const wxStdString& s)
664 : wxStringBase(s.c_str()) { }
665 #endif // wxUSE_STD_STRING
666
667 #if wxUSE_UNICODE
668 // from multibyte string
669 wxString(const char *psz, wxMBConv& conv, size_t nLength = npos);
670 // from wxWCharBuffer (i.e. return from wxGetString)
671 wxString(const wxWCharBuffer& psz) : wxStringBase(psz.data()) { }
672 #else // ANSI
673 // from C string (for compilers using unsigned char)
674 wxString(const unsigned char* psz)
675 : wxStringBase((const char*)psz) { }
676 // from part of C string (for compilers using unsigned char)
677 wxString(const unsigned char* psz, size_t nLength)
678 : wxStringBase((const char*)psz, nLength) { }
679
680 #if wxUSE_WCHAR_T
681 // from wide (Unicode) string
682 wxString(const wchar_t *pwz, wxMBConv& conv = wxConvLibc, size_t nLength = npos);
683 #endif // !wxUSE_WCHAR_T
684
685 // from wxCharBuffer
686 wxString(const wxCharBuffer& psz)
687 : wxStringBase(psz) { }
688 #endif // Unicode/ANSI
689
690 // generic attributes & operations
691 // as standard strlen()
692 size_t Len() const { return length(); }
693 // string contains any characters?
694 bool IsEmpty() const { return empty(); }
695 // empty string is "false", so !str will return true
696 bool operator!() const { return IsEmpty(); }
697 // truncate the string to given length
698 wxString& Truncate(size_t uiLen);
699 // empty string contents
700 void Empty()
701 {
702 Truncate(0);
703
704 wxASSERT_MSG( empty(), _T("string not empty after call to Empty()?") );
705 }
706 // empty the string and free memory
707 void Clear()
708 {
709 wxString tmp(wxEmptyString);
710 swap(tmp);
711 }
712
713 // contents test
714 // Is an ascii value
715 bool IsAscii() const;
716 // Is a number
717 bool IsNumber() const;
718 // Is a word
719 bool IsWord() const;
720
721 // data access (all indexes are 0 based)
722 // read access
723 wxChar GetChar(size_t n) const
724 { return at(n); }
725 // read/write access
726 wxChar& GetWritableChar(size_t n)
727 { return at(n); }
728 // write access
729 void SetChar(size_t n, wxChar ch)
730 { at(n) = ch; }
731
732 // get last character
733 wxChar Last() const
734 {
735 wxASSERT_MSG( !empty(), _T("wxString: index out of bounds") );
736
737 return at(length() - 1);
738 }
739
740 // get writable last character
741 wxChar& Last()
742 {
743 wxASSERT_MSG( !empty(), _T("wxString: index out of bounds") );
744 return at(length() - 1);
745 }
746
747 /*
748 Note that we we must define all of the overloads below to avoid
749 ambiguity when using str[0]. Also note that for a conforming compiler we
750 don't need const version of operatorp[] at all as indexed access to
751 const string is provided by implicit conversion to "const wxChar *"
752 below and defining them would only result in ambiguities, but some other
753 compilers refuse to compile "str[0]" without them.
754 */
755
756 #if defined(__BORLANDC__) || defined(__WATCOMC__) || defined(__MWERKS__)
757 wxChar operator[](int n) const
758 { return wxStringBase::at(n); }
759 wxChar operator[](size_type n) const
760 { return wxStringBase::at(n); }
761 #ifndef wxSIZE_T_IS_UINT
762 wxChar operator[](unsigned int n) const
763 { return wxStringBase::at(n); }
764 #endif // size_t != unsigned int
765 #endif // broken compiler
766
767
768 // operator versions of GetWriteableChar()
769 wxChar& operator[](int n)
770 { return wxStringBase::at(n); }
771 wxChar& operator[](size_type n)
772 { return wxStringBase::at(n); }
773 #ifndef wxSIZE_T_IS_UINT
774 wxChar& operator[](unsigned int n)
775 { return wxStringBase::at(n); }
776 #endif // size_t != unsigned int
777
778 // implicit conversion to C string
779 operator const wxChar*() const { return c_str(); }
780
781 // identical to c_str(), for wxWin 1.6x compatibility
782 const wxChar* wx_str() const { return c_str(); }
783 // identical to c_str(), for MFC compatibility
784 const wxChar* GetData() const { return c_str(); }
785
786 // conversion to/from plain (i.e. 7 bit) ASCII: this is useful for
787 // converting numbers or strings which are certain not to contain special
788 // chars (typically system functions, X atoms, environment variables etc.)
789 //
790 // the behaviour of these functions with the strings containing anything
791 // else than 7 bit ASCII characters is undefined, use at your own risk.
792 #if wxUSE_UNICODE
793 static wxString FromAscii(const char *ascii); // string
794 static wxString FromAscii(const char ascii); // char
795 const wxCharBuffer ToAscii() const;
796 #else // ANSI
797 static wxString FromAscii(const char *ascii) { return wxString( ascii ); }
798 static wxString FromAscii(const char ascii) { return wxString( ascii ); }
799 const char *ToAscii() const { return c_str(); }
800 #endif // Unicode/!Unicode
801
802 // conversions with (possible) format conversions: have to return a
803 // buffer with temporary data
804 //
805 // the functions defined (in either Unicode or ANSI) mode are mb_str() to
806 // return an ANSI (multibyte) string, wc_str() to return a wide string and
807 // fn_str() to return a string which should be used with the OS APIs
808 // accepting the file names. The return value is always the same, but the
809 // type differs because a function may either return pointer to the buffer
810 // directly or have to use intermediate buffer for translation.
811 #if wxUSE_UNICODE
812 const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const;
813
814 const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }
815
816 const wxChar* wc_str() const { return c_str(); }
817
818 // for compatibility with !wxUSE_UNICODE version
819 const wxChar* wc_str(wxMBConv& WXUNUSED(conv)) const { return c_str(); }
820
821 #if wxMBFILES
822 const wxCharBuffer fn_str() const { return mb_str(wxConvFile); }
823 #else // !wxMBFILES
824 const wxChar* fn_str() const { return c_str(); }
825 #endif // wxMBFILES/!wxMBFILES
826 #else // ANSI
827 const wxChar* mb_str() const { return c_str(); }
828
829 // for compatibility with wxUSE_UNICODE version
830 const wxChar* mb_str(wxMBConv& WXUNUSED(conv)) const { return c_str(); }
831
832 const wxWX2MBbuf mbc_str() const { return mb_str(); }
833
834 #if wxUSE_WCHAR_T
835 const wxWCharBuffer wc_str(wxMBConv& conv) const;
836 #endif // wxUSE_WCHAR_T
837 #ifdef __WXOSX__
838 const wxCharBuffer fn_str() const { return wxConvFile.cWC2WX( wc_str( wxConvLocal ) ); }
839 #else
840 const wxChar* fn_str() const { return c_str(); }
841 #endif
842 #endif // Unicode/ANSI
843
844 // overloaded assignment
845 // from another wxString
846 wxString& operator=(const wxStringBase& stringSrc)
847 { return (wxString&)wxStringBase::operator=(stringSrc); }
848 // from a character
849 wxString& operator=(wxChar ch)
850 { return (wxString&)wxStringBase::operator=(ch); }
851 // from a C string - STL probably will crash on NULL,
852 // so we need to compensate in that case
853 #if wxUSE_STL
854 wxString& operator=(const wxChar *psz)
855 { if(psz) wxStringBase::operator=(psz); else Clear(); return *this; }
856 #else
857 wxString& operator=(const wxChar *psz)
858 { return (wxString&)wxStringBase::operator=(psz); }
859 #endif
860
861 #if wxUSE_UNICODE
862 // from wxWCharBuffer
863 wxString& operator=(const wxWCharBuffer& psz)
864 { (void) operator=((const wchar_t *)psz); return *this; }
865 #else // ANSI
866 // from another kind of C string
867 wxString& operator=(const unsigned char* psz);
868 #if wxUSE_WCHAR_T
869 // from a wide string
870 wxString& operator=(const wchar_t *pwz);
871 #endif
872 // from wxCharBuffer
873 wxString& operator=(const wxCharBuffer& psz)
874 { (void) operator=((const char *)psz); return *this; }
875 #endif // Unicode/ANSI
876
877 // string concatenation
878 // in place concatenation
879 /*
880 Concatenate and return the result. Note that the left to right
881 associativity of << allows to write things like "str << str1 << str2
882 << ..." (unlike with +=)
883 */
884 // string += string
885 wxString& operator<<(const wxString& s)
886 {
887 #if !wxUSE_STL
888 wxASSERT_MSG( s.GetStringData()->IsValid(),
889 _T("did you forget to call UngetWriteBuf()?") );
890 #endif
891
892 append(s);
893 return *this;
894 }
895 // string += C string
896 wxString& operator<<(const wxChar *psz)
897 { append(psz); return *this; }
898 // string += char
899 wxString& operator<<(wxChar ch) { append(1, ch); return *this; }
900
901 // string += buffer (i.e. from wxGetString)
902 #if wxUSE_UNICODE
903 wxString& operator<<(const wxWCharBuffer& s)
904 { (void)operator<<((const wchar_t *)s); return *this; }
905 void operator+=(const wxWCharBuffer& s)
906 { (void)operator<<((const wchar_t *)s); }
907 #else // !wxUSE_UNICODE
908 wxString& operator<<(const wxCharBuffer& s)
909 { (void)operator<<((const char *)s); return *this; }
910 void operator+=(const wxCharBuffer& s)
911 { (void)operator<<((const char *)s); }
912 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
913
914 // string += C string
915 wxString& Append(const wxString& s)
916 {
917 // test for empty() to share the string if possible
918 if ( empty() )
919 *this = s;
920 else
921 append(s);
922 return *this;
923 }
924 wxString& Append(const wxChar* psz)
925 { append(psz); return *this; }
926 // append count copies of given character
927 wxString& Append(wxChar ch, size_t count = 1u)
928 { append(count, ch); return *this; }
929 wxString& Append(const wxChar* psz, size_t nLen)
930 { append(psz, nLen); return *this; }
931
932 // prepend a string, return the string itself
933 wxString& Prepend(const wxString& str)
934 { *this = str + *this; return *this; }
935
936 // non-destructive concatenation
937 // two strings
938 friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string1,
939 const wxString& string2);
940 // string with a single char
941 friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string, wxChar ch);
942 // char with a string
943 friend wxString WXDLLIMPEXP_BASE operator+(wxChar ch, const wxString& string);
944 // string with C string
945 friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string,
946 const wxChar *psz);
947 // C string with string
948 friend wxString WXDLLIMPEXP_BASE operator+(const wxChar *psz,
949 const wxString& string);
950
951 // stream-like functions
952 // insert an int into string
953 wxString& operator<<(int i)
954 { return (*this) << Format(_T("%d"), i); }
955 // insert an unsigned int into string
956 wxString& operator<<(unsigned int ui)
957 { return (*this) << Format(_T("%u"), ui); }
958 // insert a long into string
959 wxString& operator<<(long l)
960 { return (*this) << Format(_T("%ld"), l); }
961 // insert an unsigned long into string
962 wxString& operator<<(unsigned long ul)
963 { return (*this) << Format(_T("%lu"), ul); }
964 #if defined wxLongLong_t && !defined wxLongLongIsLong
965 // insert a long long if they exist and aren't longs
966 wxString& operator<<(wxLongLong_t ll)
967 {
968 const wxChar *fmt = _T("%") wxLongLongFmtSpec _T("d");
969 return (*this) << Format(fmt, ll);
970 }
971 // insert an unsigned long long
972 wxString& operator<<(wxULongLong_t ull)
973 {
974 const wxChar *fmt = _T("%") wxLongLongFmtSpec _T("u");
975 return (*this) << Format(fmt , ull);
976 }
977 #endif
978 // insert a float into string
979 wxString& operator<<(float f)
980 { return (*this) << Format(_T("%f"), f); }
981 // insert a double into string
982 wxString& operator<<(double d)
983 { return (*this) << Format(_T("%g"), d); }
984
985 // string comparison
986 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
987 int Cmp(const wxChar *psz) const;
988 int Cmp(const wxString& s) const;
989 // same as Cmp() but not case-sensitive
990 int CmpNoCase(const wxChar *psz) const;
991 int CmpNoCase(const wxString& s) const;
992 // test for the string equality, either considering case or not
993 // (if compareWithCase then the case matters)
994 bool IsSameAs(const wxChar *psz, bool compareWithCase = true) const
995 { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
996 // comparison with a signle character: returns true if equal
997 bool IsSameAs(wxChar c, bool compareWithCase = true) const
998 {
999 return (length() == 1) && (compareWithCase ? GetChar(0u) == c
1000 : wxToupper(GetChar(0u)) == wxToupper(c));
1001 }
1002
1003 // simple sub-string extraction
1004 // return substring starting at nFirst of length nCount (or till the end
1005 // if nCount = default value)
1006 wxString Mid(size_t nFirst, size_t nCount = npos) const;
1007
1008 // operator version of Mid()
1009 wxString operator()(size_t start, size_t len) const
1010 { return Mid(start, len); }
1011
1012 // check that the string starts with prefix and return the rest of the
1013 // string in the provided pointer if it is not NULL, otherwise return
1014 // false
1015 bool StartsWith(const wxChar *prefix, wxString *rest = NULL) const;
1016
1017 // get first nCount characters
1018 wxString Left(size_t nCount) const;
1019 // get last nCount characters
1020 wxString Right(size_t nCount) const;
1021 // get all characters before the first occurance of ch
1022 // (returns the whole string if ch not found)
1023 wxString BeforeFirst(wxChar ch) const;
1024 // get all characters before the last occurence of ch
1025 // (returns empty string if ch not found)
1026 wxString BeforeLast(wxChar ch) const;
1027 // get all characters after the first occurence of ch
1028 // (returns empty string if ch not found)
1029 wxString AfterFirst(wxChar ch) const;
1030 // get all characters after the last occurence of ch
1031 // (returns the whole string if ch not found)
1032 wxString AfterLast(wxChar ch) const;
1033
1034 // for compatibility only, use more explicitly named functions above
1035 wxString Before(wxChar ch) const { return BeforeLast(ch); }
1036 wxString After(wxChar ch) const { return AfterFirst(ch); }
1037
1038 // case conversion
1039 // convert to upper case in place, return the string itself
1040 wxString& MakeUpper();
1041 // convert to upper case, return the copy of the string
1042 // Here's something to remember: BC++ doesn't like returns in inlines.
1043 wxString Upper() const ;
1044 // convert to lower case in place, return the string itself
1045 wxString& MakeLower();
1046 // convert to lower case, return the copy of the string
1047 wxString Lower() const ;
1048
1049 // trimming/padding whitespace (either side) and truncating
1050 // remove spaces from left or from right (default) side
1051 wxString& Trim(bool bFromRight = true);
1052 // add nCount copies chPad in the beginning or at the end (default)
1053 wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = true);
1054
1055 // searching and replacing
1056 // searching (return starting index, or -1 if not found)
1057 int Find(wxChar ch, bool bFromEnd = false) const; // like strchr/strrchr
1058 // searching (return starting index, or -1 if not found)
1059 int Find(const wxChar *pszSub) const; // like strstr
1060 // replace first (or all of bReplaceAll) occurences of substring with
1061 // another string, returns the number of replacements made
1062 size_t Replace(const wxChar *szOld,
1063 const wxChar *szNew,
1064 bool bReplaceAll = true);
1065
1066 // check if the string contents matches a mask containing '*' and '?'
1067 bool Matches(const wxChar *szMask) const;
1068
1069 // conversion to numbers: all functions return true only if the whole
1070 // string is a number and put the value of this number into the pointer
1071 // provided, the base is the numeric base in which the conversion should be
1072 // done and must be comprised between 2 and 36 or be 0 in which case the
1073 // standard C rules apply (leading '0' => octal, "0x" => hex)
1074 // convert to a signed integer
1075 bool ToLong(long *val, int base = 10) const;
1076 // convert to an unsigned integer
1077 bool ToULong(unsigned long *val, int base = 10) const;
1078 // convert to a double
1079 bool ToDouble(double *val) const;
1080
1081 // formatted input/output
1082 // as sprintf(), returns the number of characters written or < 0 on error
1083 // (take 'this' into account in attribute parameter count)
1084 int Printf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
1085 // as vprintf(), returns the number of characters written or < 0 on error
1086 int PrintfV(const wxChar* pszFormat, va_list argptr);
1087
1088 // returns the string containing the result of Printf() to it
1089 static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1;
1090 // the same as above, but takes a va_list
1091 static wxString FormatV(const wxChar *pszFormat, va_list argptr);
1092
1093 // raw access to string memory
1094 // ensure that string has space for at least nLen characters
1095 // only works if the data of this string is not shared
1096 bool Alloc(size_t nLen) { reserve(nLen); /*return capacity() >= nLen;*/ return true; }
1097 // minimize the string's memory
1098 // only works if the data of this string is not shared
1099 bool Shrink();
1100 #if !wxUSE_STL
1101 // get writable buffer of at least nLen bytes. Unget() *must* be called
1102 // a.s.a.p. to put string back in a reasonable state!
1103 wxChar *GetWriteBuf(size_t nLen);
1104 // call this immediately after GetWriteBuf() has been used
1105 void UngetWriteBuf();
1106 void UngetWriteBuf(size_t nLen);
1107 #endif
1108
1109 // wxWidgets version 1 compatibility functions
1110
1111 // use Mid()
1112 wxString SubString(size_t from, size_t to) const
1113 { return Mid(from, (to - from + 1)); }
1114 // values for second parameter of CompareTo function
1115 enum caseCompare {exact, ignoreCase};
1116 // values for first parameter of Strip function
1117 enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
1118
1119 // use Printf()
1120 // (take 'this' into account in attribute parameter count)
1121 int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
1122
1123 // use Cmp()
1124 inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const
1125 { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
1126
1127 // use Len
1128 size_t Length() const { return length(); }
1129 // Count the number of characters
1130 int Freq(wxChar ch) const;
1131 // use MakeLower
1132 void LowerCase() { MakeLower(); }
1133 // use MakeUpper
1134 void UpperCase() { MakeUpper(); }
1135 // use Trim except that it doesn't change this string
1136 wxString Strip(stripType w = trailing) const;
1137
1138 // use Find (more general variants not yet supported)
1139 size_t Index(const wxChar* psz) const { return Find(psz); }
1140 size_t Index(wxChar ch) const { return Find(ch); }
1141 // use Truncate
1142 wxString& Remove(size_t pos) { return Truncate(pos); }
1143 wxString& RemoveLast(size_t n = 1) { return Truncate(length() - n); }
1144
1145 wxString& Remove(size_t nStart, size_t nLen)
1146 { return (wxString&)erase( nStart, nLen ); }
1147
1148 // use Find()
1149 int First( const wxChar ch ) const { return Find(ch); }
1150 int First( const wxChar* psz ) const { return Find(psz); }
1151 int First( const wxString &str ) const { return Find(str); }
1152 int Last( const wxChar ch ) const { return Find(ch, true); }
1153 bool Contains(const wxString& str) const { return Find(str) != wxNOT_FOUND; }
1154
1155 // use empty()
1156 bool IsNull() const { return empty(); }
1157
1158 // std::string compatibility functions
1159
1160 // take nLen chars starting at nPos
1161 wxString(const wxString& str, size_t nPos, size_t nLen)
1162 : wxStringBase(str, nPos, nLen) { }
1163 // take all characters from pStart to pEnd
1164 wxString(const void *pStart, const void *pEnd)
1165 : wxStringBase((const wxChar*)pStart, (const wxChar*)pEnd) { }
1166 #if wxUSE_STL
1167 wxString(const_iterator first, const_iterator last)
1168 : wxStringBase(first, last) { }
1169 #endif
1170
1171 // lib.string.modifiers
1172 // append elements str[pos], ..., str[pos+n]
1173 wxString& append(const wxString& str, size_t pos, size_t n)
1174 { return (wxString&)wxStringBase::append(str, pos, n); }
1175 // append a string
1176 wxString& append(const wxString& str)
1177 { return (wxString&)wxStringBase::append(str); }
1178 // append first n (or all if n == npos) characters of sz
1179 wxString& append(const wxChar *sz)
1180 { return (wxString&)wxStringBase::append(sz); }
1181 wxString& append(const wxChar *sz, size_t n)
1182 { return (wxString&)wxStringBase::append(sz, n); }
1183 // append n copies of ch
1184 wxString& append(size_t n, wxChar ch)
1185 { return (wxString&)wxStringBase::append(n, ch); }
1186 // append from first to last
1187 wxString& append(const_iterator first, const_iterator last)
1188 { return (wxString&)wxStringBase::append(first, last); }
1189
1190 // same as `this_string = str'
1191 wxString& assign(const wxString& str)
1192 { return (wxString&)wxStringBase::assign(str); }
1193 // same as ` = str[pos..pos + n]
1194 wxString& assign(const wxString& str, size_t pos, size_t n)
1195 { return (wxString&)wxStringBase::assign(str, pos, n); }
1196 // same as `= first n (or all if n == npos) characters of sz'
1197 wxString& assign(const wxChar *sz)
1198 { return (wxString&)wxStringBase::assign(sz); }
1199 wxString& assign(const wxChar *sz, size_t n)
1200 { return (wxString&)wxStringBase::assign(sz, n); }
1201 // same as `= n copies of ch'
1202 wxString& assign(size_t n, wxChar ch)
1203 { return (wxString&)wxStringBase::assign(n, ch); }
1204 // assign from first to last
1205 wxString& assign(const_iterator first, const_iterator last)
1206 { return (wxString&)wxStringBase::assign(first, last); }
1207
1208 // string comparison
1209 #if !defined(HAVE_STD_STRING_COMPARE)
1210 int compare(const wxStringBase& str) const;
1211 // comparison with a substring
1212 int compare(size_t nStart, size_t nLen, const wxStringBase& str) const;
1213 // comparison of 2 substrings
1214 int compare(size_t nStart, size_t nLen,
1215 const wxStringBase& str, size_t nStart2, size_t nLen2) const;
1216 // just like strcmp()
1217 int compare(const wxChar* sz) const;
1218 // substring comparison with first nCount characters of sz
1219 int compare(size_t nStart, size_t nLen,
1220 const wxChar* sz, size_t nCount = npos) const;
1221 #endif // !defined HAVE_STD_STRING_COMPARE
1222
1223 // insert another string
1224 wxString& insert(size_t nPos, const wxString& str)
1225 { return (wxString&)wxStringBase::insert(nPos, str); }
1226 // insert n chars of str starting at nStart (in str)
1227 wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
1228 { return (wxString&)wxStringBase::insert(nPos, str, nStart, n); }
1229 // insert first n (or all if n == npos) characters of sz
1230 wxString& insert(size_t nPos, const wxChar *sz)
1231 { return (wxString&)wxStringBase::insert(nPos, sz); }
1232 wxString& insert(size_t nPos, const wxChar *sz, size_t n)
1233 { return (wxString&)wxStringBase::insert(nPos, sz, n); }
1234 // insert n copies of ch
1235 wxString& insert(size_t nPos, size_t n, wxChar ch)
1236 { return (wxString&)wxStringBase::insert(nPos, n, ch); }
1237 iterator insert(iterator it, wxChar ch)
1238 { return wxStringBase::insert(it, ch); }
1239 void insert(iterator it, const_iterator first, const_iterator last)
1240 { wxStringBase::insert(it, first, last); }
1241 void insert(iterator it, size_type n, wxChar ch)
1242 { wxStringBase::insert(it, n, ch); }
1243
1244 // delete characters from nStart to nStart + nLen
1245 wxString& erase(size_type pos = 0, size_type n = npos)
1246 { return (wxString&)wxStringBase::erase(pos, n); }
1247 iterator erase(iterator first, iterator last)
1248 { return wxStringBase::erase(first, last); }
1249 iterator erase(iterator first)
1250 { return wxStringBase::erase(first); }
1251
1252 #ifdef wxSTRING_BASE_HASNT_CLEAR
1253 void clear() { erase(); }
1254 #endif
1255
1256 // replaces the substring of length nLen starting at nStart
1257 wxString& replace(size_t nStart, size_t nLen, const wxChar* sz)
1258 { return (wxString&)wxStringBase::replace(nStart, nLen, sz); }
1259 // replaces the substring of length nLen starting at nStart
1260 wxString& replace(size_t nStart, size_t nLen, const wxString& str)
1261 { return (wxString&)wxStringBase::replace(nStart, nLen, str); }
1262 // replaces the substring with nCount copies of ch
1263 wxString& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch)
1264 { return (wxString&)wxStringBase::replace(nStart, nLen, nCount, ch); }
1265 // replaces a substring with another substring
1266 wxString& replace(size_t nStart, size_t nLen,
1267 const wxString& str, size_t nStart2, size_t nLen2)
1268 { return (wxString&)wxStringBase::replace(nStart, nLen, str,
1269 nStart2, nLen2); }
1270 // replaces the substring with first nCount chars of sz
1271 wxString& replace(size_t nStart, size_t nLen,
1272 const wxChar* sz, size_t nCount)
1273 { return (wxString&)wxStringBase::replace(nStart, nLen, sz, nCount); }
1274 wxString& replace(iterator first, iterator last, const_pointer s)
1275 { return (wxString&)wxStringBase::replace(first, last, s); }
1276 wxString& replace(iterator first, iterator last, const_pointer s,
1277 size_type n)
1278 { return (wxString&)wxStringBase::replace(first, last, s, n); }
1279 wxString& replace(iterator first, iterator last, const wxString& s)
1280 { return (wxString&)wxStringBase::replace(first, last, s); }
1281 wxString& replace(iterator first, iterator last, size_type n, wxChar c)
1282 { return (wxString&)wxStringBase::replace(first, last, n, c); }
1283 wxString& replace(iterator first, iterator last,
1284 const_iterator first1, const_iterator last1)
1285 { return (wxString&)wxStringBase::replace(first, last, first1, last1); }
1286
1287 // string += string
1288 wxString& operator+=(const wxString& s)
1289 { return (wxString&)wxStringBase::operator+=(s); }
1290 // string += C string
1291 wxString& operator+=(const wxChar *psz)
1292 { return (wxString&)wxStringBase::operator+=(psz); }
1293 // string += char
1294 wxString& operator+=(wxChar ch)
1295 { return (wxString&)wxStringBase::operator+=(ch); }
1296 };
1297
1298 // notice that even though for many compilers the friend declarations above are
1299 // enough, from the point of view of C++ standard we must have the declarations
1300 // here as friend ones are not injected in the enclosing namespace and without
1301 // them the code fails to compile with conforming compilers such as xlC or g++4
1302 wxString WXDLLIMPEXP_BASE operator+(const wxString& string1, const wxString& string2);
1303 wxString WXDLLIMPEXP_BASE operator+(const wxString& string, wxChar ch);
1304 wxString WXDLLIMPEXP_BASE operator+(wxChar ch, const wxString& string);
1305 wxString WXDLLIMPEXP_BASE operator+(const wxString& string, const wxChar *psz);
1306 wxString WXDLLIMPEXP_BASE operator+(const wxChar *psz, const wxString& string);
1307
1308
1309 // define wxArrayString, for compatibility
1310 #if WXWIN_COMPATIBILITY_2_4 && !wxUSE_STL
1311 #include "wx/arrstr.h"
1312 #endif
1313
1314 #if wxUSE_STL
1315 // return an empty wxString (not very useful with wxUSE_STL == 1)
1316 inline const wxString wxGetEmptyString() { return wxString(); }
1317 #else // !wxUSE_STL
1318 // return an empty wxString (more efficient than wxString() here)
1319 inline const wxString& wxGetEmptyString()
1320 {
1321 return *(wxString *)&wxEmptyString;
1322 }
1323 #endif // wxUSE_STL/!wxUSE_STL
1324
1325 // ----------------------------------------------------------------------------
1326 // wxStringBuffer: a tiny class allowing to get a writable pointer into string
1327 // ----------------------------------------------------------------------------
1328
1329 #if wxUSE_STL
1330
1331 class WXDLLIMPEXP_BASE wxStringBuffer
1332 {
1333 public:
1334 wxStringBuffer(wxString& str, size_t lenWanted = 1024)
1335 : m_str(str), m_buf(lenWanted)
1336 { }
1337
1338 ~wxStringBuffer() { m_str.assign(m_buf.data(), wxStrlen(m_buf.data())); }
1339
1340 operator wxChar*() { return m_buf.data(); }
1341
1342 private:
1343 wxString& m_str;
1344 #if wxUSE_UNICODE
1345 wxWCharBuffer m_buf;
1346 #else
1347 wxCharBuffer m_buf;
1348 #endif
1349
1350 DECLARE_NO_COPY_CLASS(wxStringBuffer)
1351 };
1352
1353 class WXDLLIMPEXP_BASE wxStringBufferLength
1354 {
1355 public:
1356 wxStringBufferLength(wxString& str, size_t lenWanted = 1024)
1357 : m_str(str), m_buf(lenWanted), m_len(0), m_lenSet(false)
1358 { }
1359
1360 ~wxStringBufferLength()
1361 {
1362 wxASSERT(m_lenSet);
1363 m_str.assign(m_buf.data(), m_len);
1364 }
1365
1366 operator wxChar*() { return m_buf.data(); }
1367 void SetLength(size_t length) { m_len = length; m_lenSet = true; }
1368
1369 private:
1370 wxString& m_str;
1371 #if wxUSE_UNICODE
1372 wxWCharBuffer m_buf;
1373 #else
1374 wxCharBuffer m_buf;
1375 #endif
1376 size_t m_len;
1377 bool m_lenSet;
1378
1379 DECLARE_NO_COPY_CLASS(wxStringBufferLength)
1380 };
1381
1382 #else // if !wxUSE_STL
1383
1384 class WXDLLIMPEXP_BASE wxStringBuffer
1385 {
1386 public:
1387 wxStringBuffer(wxString& str, size_t lenWanted = 1024)
1388 : m_str(str), m_buf(NULL)
1389 { m_buf = m_str.GetWriteBuf(lenWanted); }
1390
1391 ~wxStringBuffer() { m_str.UngetWriteBuf(); }
1392
1393 operator wxChar*() const { return m_buf; }
1394
1395 private:
1396 wxString& m_str;
1397 wxChar *m_buf;
1398
1399 DECLARE_NO_COPY_CLASS(wxStringBuffer)
1400 };
1401
1402 class WXDLLIMPEXP_BASE wxStringBufferLength
1403 {
1404 public:
1405 wxStringBufferLength(wxString& str, size_t lenWanted = 1024)
1406 : m_str(str), m_buf(NULL), m_len(0), m_lenSet(false)
1407 {
1408 m_buf = m_str.GetWriteBuf(lenWanted);
1409 wxASSERT(m_buf != NULL);
1410 }
1411
1412 ~wxStringBufferLength()
1413 {
1414 wxASSERT(m_lenSet);
1415 m_str.UngetWriteBuf(m_len);
1416 }
1417
1418 operator wxChar*() const { return m_buf; }
1419 void SetLength(size_t length) { m_len = length; m_lenSet = true; }
1420
1421 private:
1422 wxString& m_str;
1423 wxChar *m_buf;
1424 size_t m_len;
1425 bool m_lenSet;
1426
1427 DECLARE_NO_COPY_CLASS(wxStringBufferLength)
1428 };
1429
1430 #endif // !wxUSE_STL
1431
1432 // ---------------------------------------------------------------------------
1433 // wxString comparison functions: operator versions are always case sensitive
1434 // ---------------------------------------------------------------------------
1435
1436 // note that when wxUSE_STL == 1 the comparison operators taking std::string
1437 // are used and defining them also for wxString would only result in
1438 // compilation ambiguities when comparing std::string and wxString
1439 #if !wxUSE_STL
1440
1441 inline bool operator==(const wxString& s1, const wxString& s2)
1442 { return (s1.Len() == s2.Len()) && (s1.Cmp(s2) == 0); }
1443 inline bool operator==(const wxString& s1, const wxChar * s2)
1444 { return s1.Cmp(s2) == 0; }
1445 inline bool operator==(const wxChar * s1, const wxString& s2)
1446 { return s2.Cmp(s1) == 0; }
1447 inline bool operator!=(const wxString& s1, const wxString& s2)
1448 { return (s1.Len() != s2.Len()) || (s1.Cmp(s2) != 0); }
1449 inline bool operator!=(const wxString& s1, const wxChar * s2)
1450 { return s1.Cmp(s2) != 0; }
1451 inline bool operator!=(const wxChar * s1, const wxString& s2)
1452 { return s2.Cmp(s1) != 0; }
1453 inline bool operator< (const wxString& s1, const wxString& s2)
1454 { return s1.Cmp(s2) < 0; }
1455 inline bool operator< (const wxString& s1, const wxChar * s2)
1456 { return s1.Cmp(s2) < 0; }
1457 inline bool operator< (const wxChar * s1, const wxString& s2)
1458 { return s2.Cmp(s1) > 0; }
1459 inline bool operator> (const wxString& s1, const wxString& s2)
1460 { return s1.Cmp(s2) > 0; }
1461 inline bool operator> (const wxString& s1, const wxChar * s2)
1462 { return s1.Cmp(s2) > 0; }
1463 inline bool operator> (const wxChar * s1, const wxString& s2)
1464 { return s2.Cmp(s1) < 0; }
1465 inline bool operator<=(const wxString& s1, const wxString& s2)
1466 { return s1.Cmp(s2) <= 0; }
1467 inline bool operator<=(const wxString& s1, const wxChar * s2)
1468 { return s1.Cmp(s2) <= 0; }
1469 inline bool operator<=(const wxChar * s1, const wxString& s2)
1470 { return s2.Cmp(s1) >= 0; }
1471 inline bool operator>=(const wxString& s1, const wxString& s2)
1472 { return s1.Cmp(s2) >= 0; }
1473 inline bool operator>=(const wxString& s1, const wxChar * s2)
1474 { return s1.Cmp(s2) >= 0; }
1475 inline bool operator>=(const wxChar * s1, const wxString& s2)
1476 { return s2.Cmp(s1) <= 0; }
1477
1478 #if wxUSE_UNICODE
1479 inline bool operator==(const wxString& s1, const wxWCharBuffer& s2)
1480 { return (s1.Cmp((const wchar_t *)s2) == 0); }
1481 inline bool operator==(const wxWCharBuffer& s1, const wxString& s2)
1482 { return (s2.Cmp((const wchar_t *)s1) == 0); }
1483 inline bool operator!=(const wxString& s1, const wxWCharBuffer& s2)
1484 { return (s1.Cmp((const wchar_t *)s2) != 0); }
1485 inline bool operator!=(const wxWCharBuffer& s1, const wxString& s2)
1486 { return (s2.Cmp((const wchar_t *)s1) != 0); }
1487 #else // !wxUSE_UNICODE
1488 inline bool operator==(const wxString& s1, const wxCharBuffer& s2)
1489 { return (s1.Cmp((const char *)s2) == 0); }
1490 inline bool operator==(const wxCharBuffer& s1, const wxString& s2)
1491 { return (s2.Cmp((const char *)s1) == 0); }
1492 inline bool operator!=(const wxString& s1, const wxCharBuffer& s2)
1493 { return (s1.Cmp((const char *)s2) != 0); }
1494 inline bool operator!=(const wxCharBuffer& s1, const wxString& s2)
1495 { return (s2.Cmp((const char *)s1) != 0); }
1496 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1497
1498 #if wxUSE_UNICODE
1499 inline wxString operator+(const wxString& string, const wxWCharBuffer& buf)
1500 { return string + (const wchar_t *)buf; }
1501 inline wxString operator+(const wxWCharBuffer& buf, const wxString& string)
1502 { return (const wchar_t *)buf + string; }
1503 #else // !wxUSE_UNICODE
1504 inline wxString operator+(const wxString& string, const wxCharBuffer& buf)
1505 { return string + (const char *)buf; }
1506 inline wxString operator+(const wxCharBuffer& buf, const wxString& string)
1507 { return (const char *)buf + string; }
1508 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
1509
1510 #endif // !wxUSE_STL
1511
1512 // comparison with char (those are not defined by std::[w]string and so should
1513 // be always available)
1514 inline bool operator==(wxChar c, const wxString& s) { return s.IsSameAs(c); }
1515 inline bool operator==(const wxString& s, wxChar c) { return s.IsSameAs(c); }
1516 inline bool operator!=(wxChar c, const wxString& s) { return !s.IsSameAs(c); }
1517 inline bool operator!=(const wxString& s, wxChar c) { return !s.IsSameAs(c); }
1518
1519 // ---------------------------------------------------------------------------
1520 // Implementation only from here until the end of file
1521 // ---------------------------------------------------------------------------
1522
1523 // don't pollute the library user's name space
1524 #undef wxASSERT_VALID_INDEX
1525
1526 #if wxUSE_STD_IOSTREAM
1527
1528 #include "wx/iosfwrap.h"
1529
1530 WXDLLIMPEXP_BASE wxSTD istream& operator>>(wxSTD istream&, wxString&);
1531 WXDLLIMPEXP_BASE wxSTD ostream& operator<<(wxSTD ostream&, const wxString&);
1532
1533 #endif // wxSTD_STRING_COMPATIBILITY
1534
1535 #endif // _WX_WXSTRINGH__
wxWidgets (Impactor)