]> git.saurik.com Git - wxWidgets.git/blame - include/wx/string.h
Added definition of wxUSE_DISPLAY.
[wxWidgets.git] / include / wx / string.h
CommitLineData
3c67202d 1///////////////////////////////////////////////////////////////////////////////
c801d85f 2// Name: string.h
3c67202d 3// Purpose: wxString and wxArrayString classes
c801d85f
KB
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>
371a5b4e 9// Licence: wxWindows licence
3c67202d 10///////////////////////////////////////////////////////////////////////////////
c801d85f 11
e90c1d2a
VZ
12/*
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.
16*/
17
34138703
JS
18#ifndef _WX_WXSTRINGH__
19#define _WX_WXSTRINGH__
c801d85f 20
af49c4b8 21#if defined(__GNUG__) && !defined(__APPLE__)
e90c1d2a
VZ
22 #pragma interface "string.h"
23#endif
24
25// ----------------------------------------------------------------------------
26// conditinal compilation
27// ----------------------------------------------------------------------------
28
29// compile the std::string compatibility functions if defined
30#define wxSTD_STRING_COMPATIBILITY
31
e90c1d2a
VZ
32// ----------------------------------------------------------------------------
33// headers
34// ----------------------------------------------------------------------------
35
5737d05f
VZ
36#include "wx/defs.h" // everybody should include this
37
9dea36ef 38#if defined(__WXMAC__) || defined(__VISAGECPP__)
3f4a0c5b 39 #include <ctype.h>
17dff81c 40#endif
3f4a0c5b 41
91b8de8d
RR
42#ifdef __EMX__
43 #include <std.h>
44#endif
45
9dea36ef
DW
46#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
47 // problem in VACPP V4 with including stdlib.h multiple times
48 // strconv includes it anyway
49# include <stdio.h>
50# include <string.h>
51# include <stdarg.h>
52# include <limits.h>
53#else
54# include <string.h>
55# include <stdio.h>
56# include <stdarg.h>
57# include <limits.h>
58# include <stdlib.h>
59#endif
c801d85f 60
57493f9f 61#ifdef HAVE_STRINGS_H
1bfcb0b6 62 #include <strings.h> // for strcasecmp()
d739313f 63#endif // HAVE_STRINGS_H
1bfcb0b6 64
e90c1d2a
VZ
65#include "wx/wxchar.h" // for wxChar
66#include "wx/buffer.h" // for wxCharBuffer
67#include "wx/strconv.h" // for wxConvertXXX() macros and wxMBConv classes
3f4a0c5b 68
c801d85f
KB
69// ---------------------------------------------------------------------------
70// macros
71// ---------------------------------------------------------------------------
72
5737d05f
VZ
73// casts [unfortunately!] needed to call some broken functions which require
74// "char *" instead of "const char *"
2bb67b80 75#define WXSTRINGCAST (wxChar *)(const wxChar *)
e90c1d2a
VZ
76#define wxCSTRINGCAST (wxChar *)(const wxChar *)
77#define wxMBSTRINGCAST (char *)(const char *)
78#define wxWCSTRINGCAST (wchar_t *)(const wchar_t *)
c801d85f 79
3c67202d 80// implementation only
5737d05f 81#define wxASSERT_VALID_INDEX(i) \
b1801e0e 82 wxASSERT_MSG( (size_t)(i) <= Len(), _T("invalid index in wxString") )
c801d85f 83
e90c1d2a
VZ
84// ----------------------------------------------------------------------------
85// constants
86// ----------------------------------------------------------------------------
87
66b6b045 88#if defined(__VISAGECPP__) && __IBMCPP__ >= 400
67b81440 89// must define this static for VA or else you get multiply defined symbols everywhere
5d33ed2c 90extern const unsigned int wxSTRING_MAXLEN;
66b6b045
DW
91
92#else
e90c1d2a
VZ
93// maximum possible length for a string means "take all string" everywhere
94// (as sizeof(StringData) is unknown here, we substract 100)
95const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100;
96
66b6b045
DW
97#endif
98
e90c1d2a
VZ
99// ----------------------------------------------------------------------------
100// global data
101// ----------------------------------------------------------------------------
102
103// global pointer to empty string
104WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
6001e347 105
c801d85f 106// ---------------------------------------------------------------------------
e90c1d2a 107// global functions complementing standard C string library replacements for
3c67202d
VZ
108// strlen() and portable strcasecmp()
109//---------------------------------------------------------------------------
e90c1d2a
VZ
110
111// Use wxXXX() functions from wxchar.h instead! These functions are for
112// backwards compatibility only.
88150e60 113
3c67202d 114// checks whether the passed in pointer is NULL and if the string is empty
6d56eb5c 115inline bool IsEmpty(const char *p) { return (!p || !*p); }
c801d85f 116
3c67202d 117// safe version of strlen() (returns 0 if passed NULL pointer)
6d56eb5c 118inline size_t Strlen(const char *psz)
c801d85f
KB
119 { return psz ? strlen(psz) : 0; }
120
3c67202d 121// portable strcasecmp/_stricmp
6d56eb5c 122inline int Stricmp(const char *psz1, const char *psz2)
dd1eaa89 123{
91b8de8d 124#if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
dd1eaa89 125 return _stricmp(psz1, psz2);
91b8de8d 126#elif defined(__SC__)
2432b92d 127 return _stricmp(psz1, psz2);
91b8de8d 128#elif defined(__SALFORDC__)
a3ef5bf5 129 return stricmp(psz1, psz2);
dd1eaa89
VZ
130#elif defined(__BORLANDC__)
131 return stricmp(psz1, psz2);
7be1f0d9
JS
132#elif defined(__WATCOMC__)
133 return stricmp(psz1, psz2);
14704334
VS
134#elif defined(__DJGPP__)
135 return stricmp(psz1, psz2);
91b8de8d
RR
136#elif defined(__EMX__)
137 return stricmp(psz1, psz2);
e2c87f4c 138#elif defined(__WXPM__)
1777b9bb 139 return stricmp(psz1, psz2);
91b8de8d 140#elif defined(__UNIX__) || defined(__GNUWIN32__)
dd1eaa89 141 return strcasecmp(psz1, psz2);
8be97d65 142#elif defined(__MWERKS__) && !defined(__INTEL__)
17dff81c
SC
143 register char c1, c2;
144 do {
145 c1 = tolower(*psz1++);
146 c2 = tolower(*psz2++);
147 } while ( c1 && (c1 == c2) );
148
149 return c1 - c2;
dd1eaa89
VZ
150#else
151 // almost all compilers/libraries provide this function (unfortunately under
152 // different names), that's why we don't implement our own which will surely
153 // be more efficient than this code (uncomment to use):
154 /*
155 register char c1, c2;
156 do {
157 c1 = tolower(*psz1++);
158 c2 = tolower(*psz2++);
159 } while ( c1 && (c1 == c2) );
160
161 return c1 - c2;
162 */
163
164 #error "Please define string case-insensitive compare for your OS/compiler"
165#endif // OS/compiler
166}
c801d85f 167
f04f3991 168// return an empty wxString
f7bd2698 169class WXDLLEXPORT wxString; // not yet defined
e90c1d2a 170inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; }
f04f3991 171
c801d85f 172// ---------------------------------------------------------------------------
f04f3991 173// string data prepended with some housekeeping info (used by wxString class),
c801d85f
KB
174// is never used directly (but had to be put here to allow inlining)
175// ---------------------------------------------------------------------------
e90c1d2a 176
c801d85f
KB
177struct WXDLLEXPORT wxStringData
178{
179 int nRefs; // reference count
3c024cc2 180 size_t nDataLength, // actual string length
c801d85f
KB
181 nAllocLength; // allocated memory size
182
2bb67b80
OK
183 // mimics declaration 'wxChar data[nAllocLength]'
184 wxChar* data() const { return (wxChar*)(this + 1); }
c801d85f
KB
185
186 // empty string has a special ref count so it's never deleted
dbda9e86
JS
187 bool IsEmpty() const { return (nRefs == -1); }
188 bool IsShared() const { return (nRefs > 1); }
c801d85f
KB
189
190 // lock/unlock
dd1eaa89 191 void Lock() { if ( !IsEmpty() ) nRefs++; }
f6bcfd97 192
8ecf21b7 193 // VC++ will refuse to inline Unlock but profiling shows that it is wrong
f6bcfd97
BP
194#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
195 __forceinline
196#endif
ca5e07c7
GD
197 // VC++ free must take place in same DLL as allocation when using non dll
198 // run-time library (e.g. Multithreaded instead of Multithreaded DLL)
8ecf21b7
GD
199#if defined(__VISUALC__) && defined(_MT) && !defined(_DLL)
200 void Unlock() { if ( !IsEmpty() && --nRefs == 0) Free(); }
ca5e07c7
GD
201 // we must not inline deallocation since allocation is not inlined
202 void Free();
8ecf21b7 203#else
f1317a5d 204 void Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this); }
8ecf21b7 205#endif
8fd0f20b 206
dd1eaa89 207 // if we had taken control over string memory (GetWriteBuf), it's
8fd0f20b 208 // intentionally put in invalid state
dbda9e86
JS
209 void Validate(bool b) { nRefs = (b ? 1 : 0); }
210 bool IsValid() const { return (nRefs != 0); }
c801d85f
KB
211};
212
c801d85f 213// ---------------------------------------------------------------------------
3c67202d
VZ
214// This is (yet another one) String class for C++ programmers. It doesn't use
215// any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
216// thus you should be able to compile it with practicaly any C++ compiler.
217// This class uses copy-on-write technique, i.e. identical strings share the
218// same memory as long as neither of them is changed.
219//
220// This class aims to be as compatible as possible with the new standard
221// std::string class, but adds some additional functions and should be at
222// least as efficient than the standard implementation.
223//
224// Performance note: it's more efficient to write functions which take "const
225// String&" arguments than "const char *" if you assign the argument to
226// another string.
227//
228// It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
229//
230// To do:
231// - ressource support (string tables in ressources)
232// - more wide character (UNICODE) support
233// - regular expressions support
c801d85f 234// ---------------------------------------------------------------------------
3c67202d 235
3c67202d
VZ
236class WXDLLEXPORT wxString
237{
fbcb4166 238friend class WXDLLEXPORT wxArrayString;
c801d85f 239
3c67202d
VZ
240 // NB: special care was taken in arranging the member functions in such order
241 // that all inline functions can be effectively inlined, verify that all
242 // performace critical functions are still inlined if you change order!
dd1eaa89
VZ
243private:
244 // points to data preceded by wxStringData structure with ref count info
2bb67b80 245 wxChar *m_pchData;
dd1eaa89
VZ
246
247 // accessor to string data
248 wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
249
6b95b20d
VZ
250 // string (re)initialization functions
251 // initializes the string to the empty value (must be called only from
252 // ctors, use Reinit() otherwise)
e90c1d2a 253 void Init() { m_pchData = (wxChar *)wxEmptyString; }
6b95b20d 254 // initializaes the string with (a part of) C-string
2bb67b80 255 void InitWith(const wxChar *psz, size_t nPos = 0, size_t nLen = wxSTRING_MAXLEN);
6b95b20d
VZ
256 // as Init, but also frees old data
257 void Reinit() { GetStringData()->Unlock(); Init(); }
258
259 // memory allocation
b1801e0e
GD
260 // allocates memory for string of length nLen
261 bool AllocBuffer(size_t nLen);
6b95b20d 262 // copies data to another string
b1801e0e 263 bool AllocCopy(wxString&, int, int) const;
6b95b20d 264 // effectively copies data to string
b1801e0e 265 bool AssignCopy(size_t, const wxChar *);
6b95b20d
VZ
266
267 // append a (sub)string
083f7497 268 bool ConcatSelf(size_t nLen, const wxChar *src);
6b95b20d
VZ
269
270 // functions called before writing to the string: they copy it if there
271 // are other references to our data (should be the only owner when writing)
b1801e0e
GD
272 bool CopyBeforeWrite();
273 bool AllocBeforeWrite(size_t);
6b95b20d 274
00b4a13e
VZ
275 // if we hadn't made these operators private, it would be possible to
276 // compile "wxString s; s = 17;" without any warnings as 17 is implicitly
277 // converted to char in C and we do have operator=(char)
278 //
279 // NB: we don't need other versions (short/long and unsigned) as attempt
280 // to assign another numeric type to wxString will now result in
281 // ambiguity between operator=(char) and operator=(int)
282 wxString& operator=(int);
283
284 // these methods are not implemented - there is _no_ conversion from int to
c606a9a4
VZ
285 // string, you're doing something wrong if the compiler wants to call it!
286 //
287 // try `s << i' or `s.Printf("%d", i)' instead
288 wxString(int);
c606a9a4 289
c801d85f 290public:
3c67202d
VZ
291 // constructors and destructor
292 // ctor for an empty string
b1801e0e 293 wxString() : m_pchData(NULL) { Init(); }
3c67202d 294 // copy ctor
b1801e0e 295 wxString(const wxString& stringSrc) : m_pchData(NULL)
6b95b20d 296 {
09443a26
VZ
297 wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
298 _T("did you forget to call UngetWriteBuf()?") );
6b95b20d
VZ
299
300 if ( stringSrc.IsEmpty() ) {
301 // nothing to do for an empty string
302 Init();
303 }
304 else {
305 m_pchData = stringSrc.m_pchData; // share same data
306 GetStringData()->Lock(); // => one more copy
307 }
308 }
3c67202d 309 // string containing nRepeat copies of ch
2bb67b80 310 wxString(wxChar ch, size_t nRepeat = 1);
3c67202d 311 // ctor takes first nLength characters from C string
566b84d2 312 // (default value of wxSTRING_MAXLEN means take all the string)
2bb67b80 313 wxString(const wxChar *psz, size_t nLength = wxSTRING_MAXLEN)
b1801e0e
GD
314 : m_pchData(NULL)
315 { InitWith(psz, 0, nLength); }
f6bcfd97 316 wxString(const wxChar *psz, wxMBConv& WXUNUSED(conv), size_t nLength = wxSTRING_MAXLEN)
b1801e0e
GD
317 : m_pchData(NULL)
318 { InitWith(psz, 0, nLength); }
e90c1d2a 319
2bb67b80
OK
320#if wxUSE_UNICODE
321 // from multibyte string
322 // (NB: nLength is right now number of Unicode characters, not
323 // characters in psz! So try not to use it yet!)
2b5f62a0 324 wxString(const char *psz, wxMBConv& conv, size_t nLength = wxSTRING_MAXLEN);
2bb67b80
OK
325 // from wxWCharBuffer (i.e. return from wxGetString)
326 wxString(const wxWCharBuffer& psz)
327 { InitWith(psz, 0, wxSTRING_MAXLEN); }
e90c1d2a 328#else // ANSI
3c67202d 329 // from C string (for compilers using unsigned char)
2bb67b80 330 wxString(const unsigned char* psz, size_t nLength = wxSTRING_MAXLEN)
b1801e0e
GD
331 : m_pchData(NULL)
332 { InitWith((const char*)psz, 0, nLength); }
e90c1d2a 333
6f841509 334#if wxUSE_WCHAR_T
2bb67b80 335 // from wide (Unicode) string
1c2e6a28 336 wxString(const wchar_t *pwz, wxMBConv& conv = wxConvLibc, size_t nLength = wxSTRING_MAXLEN);
e90c1d2a
VZ
337#endif // !wxUSE_WCHAR_T
338
2bb67b80
OK
339 // from wxCharBuffer
340 wxString(const wxCharBuffer& psz)
b1801e0e
GD
341 : m_pchData(NULL)
342 { InitWith(psz, 0, wxSTRING_MAXLEN); }
e90c1d2a
VZ
343#endif // Unicode/ANSI
344
3c67202d 345 // dtor is not virtual, this class must not be inherited from!
6b95b20d 346 ~wxString() { GetStringData()->Unlock(); }
c801d85f 347
3c67202d
VZ
348 // generic attributes & operations
349 // as standard strlen()
47d67540 350 size_t Len() const { return GetStringData()->nDataLength; }
3c67202d 351 // string contains any characters?
dd1eaa89 352 bool IsEmpty() const { return Len() == 0; }
dcfde592
VZ
353 // empty string is "FALSE", so !str will return TRUE
354 bool operator!() const { return IsEmpty(); }
735d1db6
VZ
355 // truncate the string to given length
356 wxString& Truncate(size_t uiLen);
3c67202d 357 // empty string contents
dd1eaa89
VZ
358 void Empty()
359 {
735d1db6 360 Truncate(0);
dd1eaa89 361
735d1db6 362 wxASSERT_MSG( IsEmpty(), _T("string not empty after call to Empty()?") );
7be07660 363 }
3c67202d 364 // empty the string and free memory
7be07660
VZ
365 void Clear()
366 {
367 if ( !GetStringData()->IsEmpty() )
368 Reinit();
369
09443a26
VZ
370 wxASSERT_MSG( !GetStringData()->nDataLength &&
371 !GetStringData()->nAllocLength,
372 _T("string should be empty after Clear()") );
dd1eaa89
VZ
373 }
374
3c67202d
VZ
375 // contents test
376 // Is an ascii value
c801d85f 377 bool IsAscii() const;
3c67202d 378 // Is a number
c801d85f 379 bool IsNumber() const;
3c67202d 380 // Is a word
c801d85f 381 bool IsWord() const;
c801d85f 382
3c67202d
VZ
383 // data access (all indexes are 0 based)
384 // read access
2bb67b80 385 wxChar GetChar(size_t n) const
5737d05f 386 { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
3c67202d 387 // read/write access
2bb67b80 388 wxChar& GetWritableChar(size_t n)
5737d05f 389 { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
3c67202d 390 // write access
2bb67b80 391 void SetChar(size_t n, wxChar ch)
5737d05f 392 { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; }
c801d85f 393
3c67202d 394 // get last character
2bb67b80 395 wxChar Last() const
09443a26
VZ
396 {
397 wxASSERT_MSG( !IsEmpty(), _T("wxString: index out of bounds") );
398
399 return m_pchData[Len() - 1];
400 }
401
3c67202d 402 // get writable last character
2bb67b80 403 wxChar& Last()
09443a26
VZ
404 {
405 wxASSERT_MSG( !IsEmpty(), _T("wxString: index out of bounds") );
406 CopyBeforeWrite();
407 return m_pchData[Len()-1];
408 }
c801d85f 409
d836ee96
VZ
410 /*
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).
419
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
426 time)
427
428 The only real fix is, of course, to remove all versions but the one
429 taking size_t...
430 */
431
3c67202d 432 // operator version of GetChar
2bb67b80 433 wxChar operator[](size_t n) const
5737d05f 434 { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
c5248639 435
3c67202d 436 // operator version of GetChar
2bb67b80 437 wxChar operator[](int n) const
5737d05f 438 { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
cd0b1709 439
f83db661 440 // operator version of GetWriteableChar
2bb67b80 441 wxChar& operator[](size_t n)
5737d05f 442 { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
d836ee96
VZ
443
444#ifndef wxSIZE_T_IS_UINT
445 // operator version of GetChar
446 wxChar operator[](unsigned int n) const
5737d05f 447 { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; }
d836ee96 448
f83db661 449 // operator version of GetWriteableChar
d836ee96 450 wxChar& operator[](unsigned int n)
5737d05f 451 { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
d836ee96 452#endif // size_t != unsigned int
c801d85f 453
3c67202d 454 // implicit conversion to C string
2bb67b80 455 operator const wxChar*() const { return m_pchData; }
e015c2a3 456
3c67202d 457 // explicit conversion to C string (use this with printf()!)
2bb67b80 458 const wxChar* c_str() const { return m_pchData; }
e015c2a3 459 // identical to c_str(), for wxWin 1.6x compatibility
6f841509 460 const wxChar* wx_str() const { return m_pchData; }
e015c2a3 461 // identical to c_str(), for MFC compatibility
2bb67b80 462 const wxChar* GetData() const { return m_pchData; }
e90c1d2a 463
e015c2a3
VZ
464 // conversion to/from plain (i.e. 7 bit) ASCII: this is useful for
465 // converting numbers or strings which are certain not to contain special
466 // chars (typically system functions, X atoms, environment variables etc.)
467 //
468 // the behaviour of these functions with the strings containing anything
469 // else than 7 bit ASCII characters is undefined, use at your own risk.
b1ac3b56 470#if wxUSE_UNICODE
2b5f62a0
VZ
471 static wxString FromAscii(const char *ascii); // string
472 static wxString FromAscii(const char ascii); // char
b1ac3b56 473 const wxCharBuffer ToAscii() const;
e015c2a3
VZ
474#else // ANSI
475 static wxString FromAscii(const char *ascii) { return wxString( ascii ); }
2b5f62a0 476 static wxString FromAscii(const char ascii) { return wxString( ascii ); }
e015c2a3
VZ
477 const char *ToAscii() const { return c_str(); }
478#endif // Unicode/!Unicode
b1ac3b56 479
2b5f62a0 480 // conversions with (possible) format conversions: have to return a
e90c1d2a 481 // buffer with temporary data
f6bcfd97
BP
482 //
483 // the functions defined (in either Unicode or ANSI) mode are mb_str() to
484 // return an ANSI (multibyte) string, wc_str() to return a wide string and
485 // fn_str() to return a string which should be used with the OS APIs
486 // accepting the file names. The return value is always the same, but the
487 // type differs because a function may either return pointer to the buffer
488 // directly or have to use intermediate buffer for translation.
2bb67b80 489#if wxUSE_UNICODE
f6bcfd97
BP
490 const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const
491 { return conv.cWC2MB(m_pchData); }
492
e90c1d2a
VZ
493 const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }
494
f6bcfd97
BP
495 const wxChar* wc_str() const { return m_pchData; }
496
497 // for compatibility with !wxUSE_UNICODE version
498 const wxChar* wc_str(wxMBConv& WXUNUSED(conv)) const { return m_pchData; }
e90c1d2a 499
2bb67b80 500#if wxMBFILES
5f709e67 501 const wxCharBuffer fn_str() const { return mb_str(wxConvFile); }
e90c1d2a 502#else // !wxMBFILES
2bb67b80 503 const wxChar* fn_str() const { return m_pchData; }
e90c1d2a
VZ
504#endif // wxMBFILES/!wxMBFILES
505#else // ANSI
e90c1d2a 506 const wxChar* mb_str() const { return m_pchData; }
f6bcfd97
BP
507
508 // for compatibility with wxUSE_UNICODE version
509 const wxChar* mb_str(wxMBConv& WXUNUSED(conv)) const { return m_pchData; }
510
e90c1d2a 511 const wxWX2MBbuf mbc_str() const { return mb_str(); }
f6bcfd97 512
6f841509 513#if wxUSE_WCHAR_T
f6bcfd97
BP
514 const wxWCharBuffer wc_str(wxMBConv& conv) const
515 { return conv.cMB2WC(m_pchData); }
e90c1d2a 516#endif // wxUSE_WCHAR_T
f6bcfd97 517
2bb67b80 518 const wxChar* fn_str() const { return m_pchData; }
e90c1d2a 519#endif // Unicode/ANSI
c801d85f 520
3c67202d
VZ
521 // overloaded assignment
522 // from another wxString
c801d85f 523 wxString& operator=(const wxString& stringSrc);
3c67202d 524 // from a character
2bb67b80 525 wxString& operator=(wxChar ch);
3c67202d 526 // from a C string
2bb67b80 527 wxString& operator=(const wxChar *psz);
111bb7f2
OK
528#if wxUSE_UNICODE
529 // from wxWCharBuffer
b1801e0e
GD
530 wxString& operator=(const wxWCharBuffer& psz)
531 { (void) operator=((const wchar_t *)psz); return *this; }
e90c1d2a 532#else // ANSI
3c67202d 533 // from another kind of C string
c801d85f 534 wxString& operator=(const unsigned char* psz);
6f841509 535#if wxUSE_WCHAR_T
3c67202d 536 // from a wide string
c801d85f 537 wxString& operator=(const wchar_t *pwz);
6f841509 538#endif
111bb7f2 539 // from wxCharBuffer
b1801e0e
GD
540 wxString& operator=(const wxCharBuffer& psz)
541 { (void) operator=((const char *)psz); return *this; }
e90c1d2a 542#endif // Unicode/ANSI
3c67202d
VZ
543
544 // string concatenation
545 // in place concatenation
546 /*
547 Concatenate and return the result. Note that the left to right
548 associativity of << allows to write things like "str << str1 << str2
549 << ..." (unlike with +=)
550 */
551 // string += string
dd1eaa89
VZ
552 wxString& operator<<(const wxString& s)
553 {
09443a26
VZ
554 wxASSERT_MSG( s.GetStringData()->IsValid(),
555 _T("did you forget to call UngetWriteBuf()?") );
dd1eaa89
VZ
556
557 ConcatSelf(s.Len(), s);
558 return *this;
559 }
3c67202d 560 // string += C string
2bb67b80
OK
561 wxString& operator<<(const wxChar *psz)
562 { ConcatSelf(wxStrlen(psz), psz); return *this; }
3c67202d 563 // string += char
2bb67b80 564 wxString& operator<<(wxChar ch) { ConcatSelf(1, &ch); return *this; }
dd1eaa89 565
3c67202d 566 // string += string
6b95b20d 567 void operator+=(const wxString& s) { (void)operator<<(s); }
3c67202d 568 // string += C string
2bb67b80 569 void operator+=(const wxChar *psz) { (void)operator<<(psz); }
3c67202d 570 // string += char
2bb67b80
OK
571 void operator+=(wxChar ch) { (void)operator<<(ch); }
572
573 // string += buffer (i.e. from wxGetString)
574#if wxUSE_UNICODE
09443a26
VZ
575 wxString& operator<<(const wxWCharBuffer& s)
576 { (void)operator<<((const wchar_t *)s); return *this; }
577 void operator+=(const wxWCharBuffer& s)
578 { (void)operator<<((const wchar_t *)s); }
579#else // !wxUSE_UNICODE
580 wxString& operator<<(const wxCharBuffer& s)
581 { (void)operator<<((const char *)s); return *this; }
582 void operator+=(const wxCharBuffer& s)
583 { (void)operator<<((const char *)s); }
584#endif // wxUSE_UNICODE/!wxUSE_UNICODE
6b95b20d 585
3c67202d 586 // string += C string
09443a26
VZ
587 wxString& Append(const wxString& s)
588 {
589 // test for IsEmpty() to share the string if possible
590 if ( IsEmpty() )
591 *this = s;
592 else
593 ConcatSelf(s.Length(), s.c_str());
594 return *this;
595 }
2bb67b80
OK
596 wxString& Append(const wxChar* psz)
597 { ConcatSelf(wxStrlen(psz), psz); return *this; }
3c67202d 598 // append count copies of given character
2bb67b80 599 wxString& Append(wxChar ch, size_t count = 1u)
3c67202d 600 { wxString str(ch, count); return *this << str; }
8f06a017
RD
601 wxString& Append(const wxChar* psz, size_t nLen)
602 { ConcatSelf(nLen, psz); return *this; }
3c67202d
VZ
603
604 // prepend a string, return the string itself
605 wxString& Prepend(const wxString& str)
606 { *this = str + *this; return *this; }
607
608 // non-destructive concatenation
609 //
c33534e5 610 friend wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2);
3c67202d 611 //
2bb67b80 612 friend wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch);
3c67202d 613 //
2bb67b80 614 friend wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string);
3c67202d 615 //
2bb67b80 616 friend wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz);
3c67202d 617 //
2bb67b80 618 friend wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string);
3c67202d
VZ
619
620 // stream-like functions
621 // insert an int into string
3ce65f6c
VZ
622 wxString& operator<<(int i)
623 { return (*this) << Format(_T("%d"), i); }
624 // insert an unsigned int into string
625 wxString& operator<<(unsigned int ui)
626 { return (*this) << Format(_T("%u"), ui); }
627 // insert a long into string
628 wxString& operator<<(long l)
629 { return (*this) << Format(_T("%ld"), l); }
630 // insert an unsigned long into string
631 wxString& operator<<(unsigned long ul)
632 { return (*this) << Format(_T("%lu"), ul); }
3c67202d 633 // insert a float into string
3ce65f6c
VZ
634 wxString& operator<<(float f)
635 { return (*this) << Format(_T("%f"), f); }
3c67202d 636 // insert a double into string
3ce65f6c
VZ
637 wxString& operator<<(double d)
638 { return (*this) << Format(_T("%g"), d); }
c84c52de 639
3c67202d 640 // string comparison
30b21f9a 641 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
f33fee2a 642 int Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); }
3c67202d 643 // same as Cmp() but not case-sensitive
f33fee2a 644 int CmpNoCase(const wxChar *psz) const { return wxStricmp(c_str(), psz); }
3c67202d
VZ
645 // test for the string equality, either considering case or not
646 // (if compareWithCase then the case matters)
2bb67b80 647 bool IsSameAs(const wxChar *psz, bool compareWithCase = TRUE) const
3c67202d 648 { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
f33fee2a
VZ
649 // comparison with a signle character: returns TRUE if equal
650 bool IsSameAs(wxChar c, bool compareWithCase = TRUE) const
651 {
652 return (Len() == 1) && (compareWithCase ? GetChar(0u) == c
653 : wxToupper(GetChar(0u)) == wxToupper(c));
654 }
3c67202d
VZ
655
656 // simple sub-string extraction
657 // return substring starting at nFirst of length nCount (or till the end
658 // if nCount = default value)
566b84d2 659 wxString Mid(size_t nFirst, size_t nCount = wxSTRING_MAXLEN) const;
3c67202d 660
f6bcfd97 661 // operator version of Mid()
3c67202d
VZ
662 wxString operator()(size_t start, size_t len) const
663 { return Mid(start, len); }
664
c0881dc3 665 // check that the string starts with prefix and return the rest of the
f6bcfd97
BP
666 // string in the provided pointer if it is not NULL, otherwise return
667 // FALSE
668 bool StartsWith(const wxChar *prefix, wxString *rest = NULL) const;
669
3c67202d 670 // get first nCount characters
c801d85f 671 wxString Left(size_t nCount) const;
3c67202d 672 // get last nCount characters
c801d85f 673 wxString Right(size_t nCount) const;
c0881dc3 674 // get all characters before the first occurance of ch
3c67202d 675 // (returns the whole string if ch not found)
2bb67b80 676 wxString BeforeFirst(wxChar ch) const;
3c67202d
VZ
677 // get all characters before the last occurence of ch
678 // (returns empty string if ch not found)
2bb67b80 679 wxString BeforeLast(wxChar ch) const;
3c67202d
VZ
680 // get all characters after the first occurence of ch
681 // (returns empty string if ch not found)
2bb67b80 682 wxString AfterFirst(wxChar ch) const;
3c67202d
VZ
683 // get all characters after the last occurence of ch
684 // (returns the whole string if ch not found)
2bb67b80 685 wxString AfterLast(wxChar ch) const;
3c67202d
VZ
686
687 // for compatibility only, use more explicitly named functions above
2bb67b80
OK
688 wxString Before(wxChar ch) const { return BeforeLast(ch); }
689 wxString After(wxChar ch) const { return AfterFirst(ch); }
3c67202d
VZ
690
691 // case conversion
c84c52de 692 // convert to upper case in place, return the string itself
c801d85f 693 wxString& MakeUpper();
c84c52de 694 // convert to upper case, return the copy of the string
03ab016d
JS
695 // Here's something to remember: BC++ doesn't like returns in inlines.
696 wxString Upper() const ;
c84c52de 697 // convert to lower case in place, return the string itself
c801d85f 698 wxString& MakeLower();
c84c52de 699 // convert to lower case, return the copy of the string
03ab016d 700 wxString Lower() const ;
c801d85f 701
3c67202d
VZ
702 // trimming/padding whitespace (either side) and truncating
703 // remove spaces from left or from right (default) side
c801d85f 704 wxString& Trim(bool bFromRight = TRUE);
3c67202d 705 // add nCount copies chPad in the beginning or at the end (default)
223d09f6 706 wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = TRUE);
dd1eaa89 707
3c67202d
VZ
708 // searching and replacing
709 // searching (return starting index, or -1 if not found)
2bb67b80 710 int Find(wxChar ch, bool bFromEnd = FALSE) const; // like strchr/strrchr
3c67202d 711 // searching (return starting index, or -1 if not found)
2bb67b80 712 int Find(const wxChar *pszSub) const; // like strstr
3c67202d
VZ
713 // replace first (or all of bReplaceAll) occurences of substring with
714 // another string, returns the number of replacements made
2bb67b80
OK
715 size_t Replace(const wxChar *szOld,
716 const wxChar *szNew,
3c67202d
VZ
717 bool bReplaceAll = TRUE);
718
719 // check if the string contents matches a mask containing '*' and '?'
2bb67b80 720 bool Matches(const wxChar *szMask) const;
c801d85f 721
538f35cc
VZ
722 // conversion to numbers: all functions return TRUE only if the whole
723 // string is a number and put the value of this number into the pointer
724 // provided, the base is the numeric base in which the conversion should be
725 // done and must be comprised between 2 and 36 or be 0 in which case the
726 // standard C rules apply (leading '0' => octal, "0x" => hex)
cd0b1709 727 // convert to a signed integer
538f35cc 728 bool ToLong(long *val, int base = 10) const;
cd0b1709 729 // convert to an unsigned integer
538f35cc 730 bool ToULong(unsigned long *val, int base = 10) const;
cd0b1709
VZ
731 // convert to a double
732 bool ToDouble(double *val) const;
733
3c67202d
VZ
734 // formated input/output
735 // as sprintf(), returns the number of characters written or < 0 on error
7357f981
GD
736 // (take 'this' into account in attribute parameter count)
737 int Printf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
3c67202d 738 // as vprintf(), returns the number of characters written or < 0 on error
2bb67b80 739 int PrintfV(const wxChar* pszFormat, va_list argptr);
dd1eaa89 740
341e7d28 741 // returns the string containing the result of Printf() to it
7357f981 742 static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1;
341e7d28
VZ
743 // the same as above, but takes a va_list
744 static wxString FormatV(const wxChar *pszFormat, va_list argptr);
745
3c67202d
VZ
746 // raw access to string memory
747 // ensure that string has space for at least nLen characters
dd1eaa89 748 // only works if the data of this string is not shared
b1801e0e 749 bool Alloc(size_t nLen);
3c67202d 750 // minimize the string's memory
dd1eaa89 751 // only works if the data of this string is not shared
b1801e0e 752 bool Shrink();
3c67202d
VZ
753 // get writable buffer of at least nLen bytes. Unget() *must* be called
754 // a.s.a.p. to put string back in a reasonable state!
2bb67b80 755 wxChar *GetWriteBuf(size_t nLen);
3c67202d 756 // call this immediately after GetWriteBuf() has been used
8fd0f20b 757 void UngetWriteBuf();
8f06a017 758 void UngetWriteBuf(size_t nLen);
c801d85f 759
3c67202d
VZ
760 // wxWindows version 1 compatibility functions
761
762 // use Mid()
763 wxString SubString(size_t from, size_t to) const
764 { return Mid(from, (to - from + 1)); }
765 // values for second parameter of CompareTo function
c801d85f 766 enum caseCompare {exact, ignoreCase};
3c67202d 767 // values for first parameter of Strip function
c801d85f 768 enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
8870c26e 769
7357f981
GD
770 // use Printf()
771 // (take 'this' into account in attribute parameter count)
772 int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;
c801d85f 773
3c67202d 774 // use Cmp()
2bb67b80 775 inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const
6b95b20d 776 { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
c801d85f 777
3c67202d 778 // use Len
c801d85f 779 size_t Length() const { return Len(); }
3c67202d 780 // Count the number of characters
2bb67b80 781 int Freq(wxChar ch) const;
3c67202d 782 // use MakeLower
c801d85f 783 void LowerCase() { MakeLower(); }
3c67202d 784 // use MakeUpper
c801d85f 785 void UpperCase() { MakeUpper(); }
3c67202d 786 // use Trim except that it doesn't change this string
c801d85f
KB
787 wxString Strip(stripType w = trailing) const;
788
3c67202d 789 // use Find (more general variants not yet supported)
2bb67b80
OK
790 size_t Index(const wxChar* psz) const { return Find(psz); }
791 size_t Index(wxChar ch) const { return Find(ch); }
3c67202d 792 // use Truncate
c801d85f 793 wxString& Remove(size_t pos) { return Truncate(pos); }
28a156b1 794 wxString& RemoveLast(size_t n = 1) { return Truncate(Len() - n); }
c801d85f 795
3ed358cb 796 wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); }
dd1eaa89 797
3c67202d 798 // use Find()
2bb67b80
OK
799 int First( const wxChar ch ) const { return Find(ch); }
800 int First( const wxChar* psz ) const { return Find(psz); }
3ed358cb 801 int First( const wxString &str ) const { return Find(str); }
2bb67b80 802 int Last( const wxChar ch ) const { return Find(ch, TRUE); }
3c67202d 803 bool Contains(const wxString& str) const { return Find(str) != -1; }
c801d85f 804
3c67202d 805 // use IsEmpty()
c801d85f 806 bool IsNull() const { return IsEmpty(); }
c801d85f 807
3c67202d
VZ
808#ifdef wxSTD_STRING_COMPATIBILITY
809 // std::string compatibility functions
dd1eaa89 810
2bc07607
VZ
811 // standard types
812 typedef wxChar value_type;
5460b9e3
VZ
813 typedef size_t size_type;
814 typedef value_type *iterator;
2bc07607
VZ
815 typedef const value_type *const_iterator;
816
3c67202d 817 // an 'invalid' value for string index
c801d85f 818 static const size_t npos;
dd1eaa89 819
3c67202d
VZ
820 // constructors
821 // take nLen chars starting at nPos
822 wxString(const wxString& str, size_t nPos, size_t nLen)
b1801e0e 823 : m_pchData(NULL)
3c67202d 824 {
09443a26
VZ
825 wxASSERT_MSG( str.GetStringData()->IsValid(),
826 _T("did you forget to call UngetWriteBuf()?") );
827
3c67202d
VZ
828 InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
829 }
830 // take all characters from pStart to pEnd
831 wxString(const void *pStart, const void *pEnd);
832
833 // lib.string.capacity
834 // return the length of the string
835 size_t size() const { return Len(); }
836 // return the length of the string
837 size_t length() const { return Len(); }
838 // return the maximum size of the string
566b84d2 839 size_t max_size() const { return wxSTRING_MAXLEN; }
3c67202d 840 // resize the string, filling the space with c if c != 0
223d09f6 841 void resize(size_t nSize, wxChar ch = wxT('\0'));
3c67202d
VZ
842 // delete the contents of the string
843 void clear() { Empty(); }
844 // returns true if the string is empty
845 bool empty() const { return IsEmpty(); }
252a752e 846 // inform string about planned change in size
2b5f62a0 847 void reserve(size_t sz) { Alloc(sz); }
3c67202d
VZ
848
849 // lib.string.access
850 // return the character at position n
2bb67b80 851 wxChar at(size_t n) const { return GetChar(n); }
3c67202d 852 // returns the writable character at position n
2bb67b80 853 wxChar& at(size_t n) { return GetWritableChar(n); }
3c67202d 854
2bc07607
VZ
855 // first valid index position
856 const_iterator begin() const { return wx_str(); }
857 // position one after the last valid one
858 const_iterator end() const { return wx_str() + length(); }
859
5460b9e3
VZ
860 // first valid index position
861 iterator begin() { CopyBeforeWrite(); return m_pchData; }
862 // position one after the last valid one
863 iterator end() { CopyBeforeWrite(); return m_pchData + length(); }
864
3c67202d
VZ
865 // lib.string.modifiers
866 // append a string
867 wxString& append(const wxString& str)
868 { *this += str; return *this; }
869 // append elements str[pos], ..., str[pos+n]
870 wxString& append(const wxString& str, size_t pos, size_t n)
871 { ConcatSelf(n, str.c_str() + pos); return *this; }
872 // append first n (or all if n == npos) characters of sz
2bb67b80
OK
873 wxString& append(const wxChar *sz, size_t n = npos)
874 { ConcatSelf(n == npos ? wxStrlen(sz) : n, sz); return *this; }
3c67202d
VZ
875
876 // append n copies of ch
2bb67b80 877 wxString& append(size_t n, wxChar ch) { return Pad(n, ch); }
3c67202d
VZ
878
879 // same as `this_string = str'
735d1db6
VZ
880 wxString& assign(const wxString& str)
881 { return *this = str; }
3c67202d
VZ
882 // same as ` = str[pos..pos + n]
883 wxString& assign(const wxString& str, size_t pos, size_t n)
735d1db6 884 { Empty(); return Append(str.c_str() + pos, n); }
3c67202d 885 // same as `= first n (or all if n == npos) characters of sz'
2bb67b80 886 wxString& assign(const wxChar *sz, size_t n = npos)
735d1db6 887 { Empty(); return Append(sz, n == npos ? wxStrlen(sz) : n); }
3c67202d 888 // same as `= n copies of ch'
2bb67b80 889 wxString& assign(size_t n, wxChar ch)
735d1db6 890 { Empty(); return Append(ch, n); }
3c67202d
VZ
891
892 // insert another string
893 wxString& insert(size_t nPos, const wxString& str);
894 // insert n chars of str starting at nStart (in str)
895 wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
2bb67b80 896 { return insert(nPos, wxString((const wxChar *)str + nStart, n)); }
3c67202d
VZ
897
898 // insert first n (or all if n == npos) characters of sz
2bb67b80 899 wxString& insert(size_t nPos, const wxChar *sz, size_t n = npos)
3c67202d
VZ
900 { return insert(nPos, wxString(sz, n)); }
901 // insert n copies of ch
2bb67b80 902 wxString& insert(size_t nPos, size_t n, wxChar ch)
3c67202d
VZ
903 { return insert(nPos, wxString(ch, n)); }
904
905 // delete characters from nStart to nStart + nLen
906 wxString& erase(size_t nStart = 0, size_t nLen = npos);
907
908 // replaces the substring of length nLen starting at nStart
2bb67b80 909 wxString& replace(size_t nStart, size_t nLen, const wxChar* sz);
3c67202d 910 // replaces the substring with nCount copies of ch
2bb67b80 911 wxString& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch);
3c67202d
VZ
912 // replaces a substring with another substring
913 wxString& replace(size_t nStart, size_t nLen,
914 const wxString& str, size_t nStart2, size_t nLen2);
915 // replaces the substring with first nCount chars of sz
fb20fa43
VZ
916 wxString& replace(size_t nStart, size_t nLen,
917 const wxChar* sz, size_t nCount);
3c67202d
VZ
918
919 // swap two strings
920 void swap(wxString& str);
921
922 // All find() functions take the nStart argument which specifies the
923 // position to start the search on, the default value is 0. All functions
924 // return npos if there were no match.
925
926 // find a substring
927 size_t find(const wxString& str, size_t nStart = 0) const;
928
929 // VC++ 1.5 can't cope with this syntax.
3f4a0c5b 930#if !defined(__VISUALC__) || defined(__WIN32__)
3c67202d 931 // find first n characters of sz
2bb67b80 932 size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
fb20fa43 933#endif // VC++ 1.5
3c67202d
VZ
934
935 // Gives a duplicate symbol (presumably a case-insensitivity problem)
62448488 936#if !defined(__BORLANDC__)
3c67202d 937 // find the first occurence of character ch after nStart
2bb67b80 938 size_t find(wxChar ch, size_t nStart = 0) const;
62448488 939#endif
3c67202d
VZ
940 // rfind() family is exactly like find() but works right to left
941
942 // as find, but from the end
943 size_t rfind(const wxString& str, size_t nStart = npos) const;
944
945 // VC++ 1.5 can't cope with this syntax.
3f4a0c5b 946#if !defined(__VISUALC__) || defined(__WIN32__)
3c67202d 947 // as find, but from the end
2bb67b80 948 size_t rfind(const wxChar* sz, size_t nStart = npos,
3c67202d
VZ
949 size_t n = npos) const;
950 // as find, but from the end
2bb67b80 951 size_t rfind(wxChar ch, size_t nStart = npos) const;
fb20fa43 952#endif // VC++ 1.5
3c67202d
VZ
953
954 // find first/last occurence of any character in the set
955
969d318c
VZ
956 // as strpbrk() but starts at nStart, returns npos if not found
957 size_t find_first_of(const wxString& str, size_t nStart = 0) const
958 { return find_first_of(str.c_str(), nStart); }
959 // same as above
2bb67b80 960 size_t find_first_of(const wxChar* sz, size_t nStart = 0) const;
3c67202d 961 // same as find(char, size_t)
969d318c
VZ
962 size_t find_first_of(wxChar c, size_t nStart = 0) const
963 { return find(c, nStart); }
964 // find the last (starting from nStart) char from str in this string
965 size_t find_last_of (const wxString& str, size_t nStart = npos) const
966 { return find_last_of(str.c_str(), nStart); }
967 // same as above
968 size_t find_last_of (const wxChar* sz, size_t nStart = npos) const;
969 // same as above
970 size_t find_last_of(wxChar c, size_t nStart = npos) const
971 { return rfind(c, nStart); }
3c67202d
VZ
972
973 // find first/last occurence of any character not in the set
974
969d318c
VZ
975 // as strspn() (starting from nStart), returns npos on failure
976 size_t find_first_not_of(const wxString& str, size_t nStart = 0) const
977 { return find_first_not_of(str.c_str(), nStart); }
978 // same as above
979 size_t find_first_not_of(const wxChar* sz, size_t nStart = 0) const;
980 // same as above
2bb67b80 981 size_t find_first_not_of(wxChar ch, size_t nStart = 0) const;
969d318c 982 // as strcspn()
fb20fa43
VZ
983 size_t find_last_not_of(const wxString& str, size_t nStart = npos) const
984 { return find_first_not_of(str.c_str(), nStart); }
969d318c
VZ
985 // same as above
986 size_t find_last_not_of(const wxChar* sz, size_t nStart = npos) const;
987 // same as above
2bb67b80 988 size_t find_last_not_of(wxChar ch, size_t nStart = npos) const;
3c67202d
VZ
989
990 // All compare functions return -1, 0 or 1 if the [sub]string is less,
991 // equal or greater than the compare() argument.
992
993 // just like strcmp()
994 int compare(const wxString& str) const { return Cmp(str); }
995 // comparison with a substring
fb20fa43
VZ
996 int compare(size_t nStart, size_t nLen, const wxString& str) const
997 { return Mid(nStart, nLen).Cmp(str); }
3c67202d
VZ
998 // comparison of 2 substrings
999 int compare(size_t nStart, size_t nLen,
fb20fa43
VZ
1000 const wxString& str, size_t nStart2, size_t nLen2) const
1001 { return Mid(nStart, nLen).Cmp(str.Mid(nStart2, nLen2)); }
3c67202d 1002 // just like strcmp()
2bb67b80 1003 int compare(const wxChar* sz) const { return Cmp(sz); }
3c67202d
VZ
1004 // substring comparison with first nCount characters of sz
1005 int compare(size_t nStart, size_t nLen,
fb20fa43
VZ
1006 const wxChar* sz, size_t nCount = npos) const
1007 { return Mid(nStart, nLen).Cmp(wxString(sz, nCount)); }
3c67202d
VZ
1008
1009 // substring extraction
8c264b23
VZ
1010 wxString substr(size_t nStart = 0, size_t nLen = npos) const
1011 { return Mid(nStart, nLen); }
3c67202d 1012#endif // wxSTD_STRING_COMPATIBILITY
c801d85f
KB
1013};
1014
1015// ----------------------------------------------------------------------------
3c67202d
VZ
1016// The string array uses it's knowledge of internal structure of the wxString
1017// class to optimize string storage. Normally, we would store pointers to
1018// string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
1019// sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
1020// really all we need to turn such pointer into a string!
1021//
1022// Of course, it can be called a dirty hack, but we use twice less memory and
1023// this approach is also more speed efficient, so it's probably worth it.
1024//
1025// Usage notes: when a string is added/inserted, a new copy of it is created,
1026// so the original string may be safely deleted. When a string is retrieved
1027// from the array (operator[] or Item() method), a reference is returned.
c801d85f 1028// ----------------------------------------------------------------------------
e90c1d2a 1029
fbcb4166 1030class WXDLLEXPORT wxArrayString
c801d85f
KB
1031{
1032public:
30b21f9a
VZ
1033 // type of function used by wxArrayString::Sort()
1034 typedef int (*CompareFunction)(const wxString& first,
1035 const wxString& second);
1036
3c67202d 1037 // constructors and destructor
0fe1f685 1038 // default ctor
b1801e0e
GD
1039 wxArrayString()
1040 : m_nSize(0), m_nCount(0), m_pItems(NULL), m_autoSort(FALSE)
1041 { Init(FALSE); }
0fe1f685
VZ
1042 // if autoSort is TRUE, the array is always sorted (in alphabetical order)
1043 //
1044 // NB: the reason for using int and not bool is that like this we can avoid
1045 // using this ctor for implicit conversions from "const char *" (which
1046 // we'd like to be implicitly converted to wxString instead!)
1047 //
1048 // of course, using explicit would be even better - if all compilers
1049 // supported it...
b1801e0e
GD
1050 wxArrayString(int autoSort)
1051 : m_nSize(0), m_nCount(0), m_pItems(NULL), m_autoSort(FALSE)
1052 { Init(autoSort != 0); }
3c67202d 1053 // copy ctor
c801d85f 1054 wxArrayString(const wxArrayString& array);
3c67202d 1055 // assignment operator
c801d85f 1056 wxArrayString& operator=(const wxArrayString& src);
3c67202d 1057 // not virtual, this class should not be derived from
c801d85f 1058 ~wxArrayString();
c801d85f 1059
3c67202d
VZ
1060 // memory management
1061 // empties the list, but doesn't release memory
c801d85f 1062 void Empty();
3c67202d 1063 // empties the list and releases memory
c801d85f 1064 void Clear();
3c67202d 1065 // preallocates memory for given number of items
c801d85f 1066 void Alloc(size_t nCount);
3c67202d 1067 // minimzes the memory usage (by freeing all extra memory)
dd1eaa89 1068 void Shrink();
3c67202d
VZ
1069
1070 // simple accessors
1071 // number of elements in the array
1072 size_t GetCount() const { return m_nCount; }
1073 // is it empty?
1074 bool IsEmpty() const { return m_nCount == 0; }
1075 // number of elements in the array (GetCount is preferred API)
1076 size_t Count() const { return m_nCount; }
1077
1078 // items access (range checking is done in debug version)
1079 // get item at position uiIndex
c801d85f 1080 wxString& Item(size_t nIndex) const
09443a26
VZ
1081 {
1082 wxASSERT_MSG( nIndex < m_nCount,
1083 _T("wxArrayString: index out of bounds") );
1084
1085 return *(wxString *)&(m_pItems[nIndex]);
1086 }
1087
3c67202d 1088 // same as Item()
c801d85f 1089 wxString& operator[](size_t nIndex) const { return Item(nIndex); }
3c67202d 1090 // get last item
09443a26
VZ
1091 wxString& Last() const
1092 {
1093 wxASSERT_MSG( !IsEmpty(),
1094 _T("wxArrayString: index out of bounds") );
1095 return Item(Count() - 1);
1096 }
3c67202d 1097
9d155f50
RL
1098 // return a wxString[], useful for the controls which
1099 // take one in their ctor. You must delete[] it yourself
1100 // once you are done with it. Will return NULL if the
1101 // ArrayString was empty.
1102 wxString* GetStringArray() const;
1103
3c67202d
VZ
1104 // item management
1105 // Search the element in the array, starting from the beginning if
1106 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
1107 // sensitive (default). Returns index of the first item matched or
1108 // wxNOT_FOUND
2bb67b80 1109 int Index (const wxChar *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
e01c8145
VZ
1110 // add new element at the end (if the array is not sorted), return its
1111 // index
2a39c386 1112 size_t Add(const wxString& str, size_t nInsert = 1);
3c67202d 1113 // add new element at given position
2a39c386 1114 void Insert(const wxString& str, size_t uiIndex, size_t nInsert = 1);
71e03035
VZ
1115 // expand the array to have count elements
1116 void SetCount(size_t count);
3c67202d 1117 // remove first item matching this value
2bb67b80 1118 void Remove(const wxChar *sz);
3c67202d 1119 // remove item by index
2a39c386
VZ
1120 void Remove(size_t nIndex, size_t nRemove = 1);
1121 void RemoveAt(size_t nIndex, size_t nRemove = 1) { Remove(nIndex, nRemove); }
c801d85f 1122
30b21f9a
VZ
1123 // sorting
1124 // sort array elements in alphabetical order (or reversed alphabetical
1125 // order if reverseOrder parameter is TRUE)
1126 void Sort(bool reverseOrder = FALSE);
1127 // sort array elements using specified comparaison function
1128 void Sort(CompareFunction compareFunction);
c801d85f 1129
f6bcfd97
BP
1130 // comparison
1131 // compare two arrays case sensitively
1132 bool operator==(const wxArrayString& a) const;
1133 // compare two arrays case sensitively
1134 bool operator!=(const wxArrayString& a) const { return !(*this == a); }
1135
e87271f3 1136protected:
0fe1f685 1137 void Init(bool autoSort); // common part of all ctors
e87271f3
VZ
1138 void Copy(const wxArrayString& src); // copies the contents of another array
1139
c801d85f 1140private:
2a39c386 1141 void Grow(size_t nIncrement = 0); // makes array bigger if needed
e87271f3 1142 void Free(); // free all the strings stored
c801d85f 1143
e87271f3 1144 void DoSort(); // common part of all Sort() variants
30b21f9a 1145
3c67202d 1146 size_t m_nSize, // current size of the array
c801d85f
KB
1147 m_nCount; // current number of elements
1148
e87271f3
VZ
1149 wxChar **m_pItems; // pointer to data
1150
1151 bool m_autoSort; // if TRUE, keep the array always sorted
1152};
1153
1154class WXDLLEXPORT wxSortedArrayString : public wxArrayString
1155{
1156public:
1157 wxSortedArrayString() : wxArrayString(TRUE)
1158 { }
1159 wxSortedArrayString(const wxArrayString& array) : wxArrayString(TRUE)
1160 { Copy(array); }
c801d85f
KB
1161};
1162
1d218550
VZ
1163// ----------------------------------------------------------------------------
1164// wxStringBuffer: a tiny class allowing to get a writable pointer into string
1165// ----------------------------------------------------------------------------
1166
1167class WXDLLEXPORT wxStringBuffer
1168{
1169public:
1170 wxStringBuffer(wxString& str, size_t lenWanted = 1024)
b1801e0e
GD
1171 : m_str(str), m_buf(NULL)
1172 { m_buf = m_str.GetWriteBuf(lenWanted); }
e015c2a3 1173
1d218550 1174 ~wxStringBuffer() { m_str.UngetWriteBuf(); }
e015c2a3 1175
1d218550 1176 operator wxChar*() const { return m_buf; }
e015c2a3 1177
1d218550
VZ
1178private:
1179 wxString& m_str;
1180 wxChar *m_buf;
e015c2a3
VZ
1181
1182 DECLARE_NO_COPY_CLASS(wxStringBuffer)
1d218550
VZ
1183};
1184
c801d85f 1185// ---------------------------------------------------------------------------
3c67202d 1186// wxString comparison functions: operator versions are always case sensitive
c801d85f 1187// ---------------------------------------------------------------------------
f33fee2a 1188
0cbe5ee3
VZ
1189inline bool operator==(const wxString& s1, const wxString& s2)
1190 { return (s1.Len() == s2.Len()) && (s1.Cmp(s2) == 0); }
1191inline bool operator==(const wxString& s1, const wxChar * s2)
1192 { return s1.Cmp(s2) == 0; }
1193inline bool operator==(const wxChar * s1, const wxString& s2)
1194 { return s2.Cmp(s1) == 0; }
1195inline bool operator!=(const wxString& s1, const wxString& s2)
1196 { return (s1.Len() != s2.Len()) || (s1.Cmp(s2) != 0); }
1197inline bool operator!=(const wxString& s1, const wxChar * s2)
1198 { return s1.Cmp(s2) != 0; }
1199inline bool operator!=(const wxChar * s1, const wxString& s2)
1200 { return s2.Cmp(s1) != 0; }
1201inline bool operator< (const wxString& s1, const wxString& s2)
1202 { return s1.Cmp(s2) < 0; }
1203inline bool operator< (const wxString& s1, const wxChar * s2)
1204 { return s1.Cmp(s2) < 0; }
1205inline bool operator< (const wxChar * s1, const wxString& s2)
1206 { return s2.Cmp(s1) > 0; }
1207inline bool operator> (const wxString& s1, const wxString& s2)
1208 { return s1.Cmp(s2) > 0; }
1209inline bool operator> (const wxString& s1, const wxChar * s2)
1210 { return s1.Cmp(s2) > 0; }
1211inline bool operator> (const wxChar * s1, const wxString& s2)
1212 { return s2.Cmp(s1) < 0; }
1213inline bool operator<=(const wxString& s1, const wxString& s2)
1214 { return s1.Cmp(s2) <= 0; }
1215inline bool operator<=(const wxString& s1, const wxChar * s2)
1216 { return s1.Cmp(s2) <= 0; }
1217inline bool operator<=(const wxChar * s1, const wxString& s2)
1218 { return s2.Cmp(s1) >= 0; }
1219inline bool operator>=(const wxString& s1, const wxString& s2)
1220 { return s1.Cmp(s2) >= 0; }
1221inline bool operator>=(const wxString& s1, const wxChar * s2)
1222 { return s1.Cmp(s2) >= 0; }
1223inline bool operator>=(const wxChar * s1, const wxString& s2)
1224 { return s2.Cmp(s1) <= 0; }
3c67202d 1225
f33fee2a
VZ
1226// comparison with char
1227inline bool operator==(wxChar c, const wxString& s) { return s.IsSameAs(c); }
1228inline bool operator==(const wxString& s, wxChar c) { return s.IsSameAs(c); }
1229inline bool operator!=(wxChar c, const wxString& s) { return !s.IsSameAs(c); }
1230inline bool operator!=(const wxString& s, wxChar c) { return !s.IsSameAs(c); }
1231
5ca07d0f
OK
1232#if wxUSE_UNICODE
1233inline bool operator==(const wxString& s1, const wxWCharBuffer& s2)
f33fee2a 1234 { return (s1.Cmp((const wchar_t *)s2) == 0); }
5ca07d0f 1235inline bool operator==(const wxWCharBuffer& s1, const wxString& s2)
f33fee2a 1236 { return (s2.Cmp((const wchar_t *)s1) == 0); }
f6bcfd97
BP
1237inline bool operator!=(const wxString& s1, const wxWCharBuffer& s2)
1238 { return (s1.Cmp((const wchar_t *)s2) != 0); }
1239inline bool operator!=(const wxWCharBuffer& s1, const wxString& s2)
1240 { return (s2.Cmp((const wchar_t *)s1) != 0); }
0cbe5ee3 1241#else // !wxUSE_UNICODE
5ca07d0f 1242inline bool operator==(const wxString& s1, const wxCharBuffer& s2)
f33fee2a 1243 { return (s1.Cmp((const char *)s2) == 0); }
5ca07d0f 1244inline bool operator==(const wxCharBuffer& s1, const wxString& s2)
f33fee2a 1245 { return (s2.Cmp((const char *)s1) == 0); }
f6bcfd97
BP
1246inline bool operator!=(const wxString& s1, const wxCharBuffer& s2)
1247 { return (s1.Cmp((const char *)s2) != 0); }
1248inline bool operator!=(const wxCharBuffer& s1, const wxString& s2)
1249 { return (s2.Cmp((const char *)s1) != 0); }
0cbe5ee3 1250#endif // wxUSE_UNICODE/!wxUSE_UNICODE
5ca07d0f 1251
ed7174ba 1252wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2);
2bb67b80
OK
1253wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch);
1254wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string);
1255wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz);
1256wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string);
028a2b5d 1257#if wxUSE_UNICODE
6d56eb5c 1258inline wxString operator+(const wxString& string, const wxWCharBuffer& buf)
e90c1d2a 1259 { return string + (const wchar_t *)buf; }
6d56eb5c 1260inline wxString operator+(const wxWCharBuffer& buf, const wxString& string)
e90c1d2a 1261 { return (const wchar_t *)buf + string; }
0cbe5ee3 1262#else // !wxUSE_UNICODE
6d56eb5c 1263inline wxString operator+(const wxString& string, const wxCharBuffer& buf)
e90c1d2a 1264 { return string + (const char *)buf; }
6d56eb5c 1265inline wxString operator+(const wxCharBuffer& buf, const wxString& string)
e90c1d2a 1266 { return (const char *)buf + string; }
0cbe5ee3 1267#endif // wxUSE_UNICODE/!wxUSE_UNICODE
f04f3991 1268
c801d85f 1269// ---------------------------------------------------------------------------
3c67202d 1270// Implementation only from here until the end of file
c801d85f
KB
1271// ---------------------------------------------------------------------------
1272
e90c1d2a 1273// don't pollute the library user's name space
5737d05f 1274#undef wxASSERT_VALID_INDEX
e90c1d2a 1275
38830220 1276#if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
c801d85f 1277
65f19af1 1278#include "wx/iosfwrap.h"
c801d85f 1279
dd107c50
VZ
1280WXDLLEXPORT wxSTD istream& operator>>(wxSTD istream&, wxString&);
1281WXDLLEXPORT wxSTD ostream& operator<<(wxSTD ostream&, const wxString&);
c801d85f 1282
3c67202d 1283#endif // wxSTD_STRING_COMPATIBILITY
c801d85f 1284
34138703 1285#endif // _WX_WXSTRINGH__