]> git.saurik.com Git - wxWidgets.git/blob - include/wx/string.h
projects / wxWidgets.git / blob
? search:


2ad17f489604a4b8a40258e93c49ef66e1d33487
[wxWidgets.git] / include / wx / string.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: 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 license
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_WXSTRINGH__
13 #define _WX_WXSTRINGH__
14
15 #ifdef __GNUG__
16 #pragma interface "string.h"
17 #endif
18
19 #ifdef __WXMAC__
20 #include <ctype.h>
21 #endif
22
23 #include <string.h>
24 #include <stdio.h>
25 #include <stdarg.h>
26 #include <limits.h>
27 #include <stdlib.h>
28
29 #ifdef HAVE_STRINGS_H
30 #include <strings.h> // for strcasecmp()
31 #endif // AIX
32
33 #ifndef WX_PRECOMP
34 #include "wx/defs.h"
35
36 #ifdef WXSTRING_IS_WXOBJECT
37 #include "wx/object.h"
38 #endif
39 #endif // !PCH
40
41 #include "wx/debug.h"
42 #include "wx/wxchar.h"
43 #include "wx/buffer.h"
44
45 /*
46 Efficient string class [more or less] compatible with MFC CString,
47 wxWindows version 1 wxString and std::string and some handy functions
48 missing from string.h.
49 */
50
51 // ---------------------------------------------------------------------------
52 // macros
53 // ---------------------------------------------------------------------------
54
55 // compile the std::string compatibility functions if defined
56 #define wxSTD_STRING_COMPATIBILITY
57
58 // define to derive wxString from wxObject
59 #ifdef WXSTRING_IS_WXOBJECT
60 #undef WXSTRING_IS_WXOBJECT
61 #endif
62
63 // maximum possible length for a string means "take all string" everywhere
64 // (as sizeof(StringData) is unknown here we substract 100)
65 const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100;
66
67 // 'naughty' cast
68 #define WXSTRINGCAST (wxChar *)(const wxChar *)
69 #define WXCSTRINGCAST (wxChar *)(const wxChar *)
70 #define MBSTRINGCAST (char *)(const char *)
71 #define WCSTRINGCAST (wchar_t *)(const wchar_t *)
72
73 // implementation only
74 #define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
75
76 // ---------------------------------------------------------------------------
77 // Global functions complementing standard C string library replacements for
78 // strlen() and portable strcasecmp()
79 //---------------------------------------------------------------------------
80 // USE wx* FUNCTIONS IN wx/wxchar.h INSTEAD - THIS IS ONLY FOR BINARY COMPATIBILITY
81
82 // checks whether the passed in pointer is NULL and if the string is empty
83 inline bool WXDLLEXPORT IsEmpty(const char *p) { return (!p || !*p); }
84
85 // safe version of strlen() (returns 0 if passed NULL pointer)
86 inline size_t WXDLLEXPORT Strlen(const char *psz)
87 { return psz ? strlen(psz) : 0; }
88
89 // portable strcasecmp/_stricmp
90 inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2)
91 {
92 #if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
93 return _stricmp(psz1, psz2);
94 #elif defined(__SC__)
95 return _stricmp(psz1, psz2);
96 #elif defined(__SALFORDC__)
97 return stricmp(psz1, psz2);
98 #elif defined(__BORLANDC__)
99 return stricmp(psz1, psz2);
100 #elif defined(__WATCOMC__)
101 return stricmp(psz1, psz2);
102 #elif defined(__UNIX__) || defined(__GNUWIN32__)
103 return strcasecmp(psz1, psz2);
104 #elif defined(__MWERKS__) && !defined(__INTEL__)
105 register char c1, c2;
106 do {
107 c1 = tolower(*psz1++);
108 c2 = tolower(*psz2++);
109 } while ( c1 && (c1 == c2) );
110
111 return c1 - c2;
112 #else
113 // almost all compilers/libraries provide this function (unfortunately under
114 // different names), that's why we don't implement our own which will surely
115 // be more efficient than this code (uncomment to use):
116 /*
117 register char c1, c2;
118 do {
119 c1 = tolower(*psz1++);
120 c2 = tolower(*psz2++);
121 } while ( c1 && (c1 == c2) );
122
123 return c1 - c2;
124 */
125
126 #error "Please define string case-insensitive compare for your OS/compiler"
127 #endif // OS/compiler
128 }
129
130 // ----------------------------------------------------------------------------
131 // global data
132 // ----------------------------------------------------------------------------
133
134 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
135
136 // global pointer to empty string
137 WXDLLEXPORT_DATA(extern const wxChar*) g_szNul;
138
139 // return an empty wxString
140 class WXDLLEXPORT wxString; // not yet defined
141 inline const wxString& wxGetEmptyString() { return *(wxString *)&g_szNul; }
142
143 // ---------------------------------------------------------------------------
144 // string data prepended with some housekeeping info (used by wxString class),
145 // is never used directly (but had to be put here to allow inlining)
146 // ---------------------------------------------------------------------------
147 struct WXDLLEXPORT wxStringData
148 {
149 int nRefs; // reference count
150 size_t nDataLength, // actual string length
151 nAllocLength; // allocated memory size
152
153 // mimics declaration 'wxChar data[nAllocLength]'
154 wxChar* data() const { return (wxChar*)(this + 1); }
155
156 // empty string has a special ref count so it's never deleted
157 bool IsEmpty() const { return (nRefs == -1); }
158 bool IsShared() const { return (nRefs > 1); }
159
160 // lock/unlock
161 void Lock() { if ( !IsEmpty() ) nRefs++; }
162 void Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this); }
163
164 // if we had taken control over string memory (GetWriteBuf), it's
165 // intentionally put in invalid state
166 void Validate(bool b) { nRefs = (b ? 1 : 0); }
167 bool IsValid() const { return (nRefs != 0); }
168 };
169
170 // ---------------------------------------------------------------------------
171 // types of multibyte<->Unicode conversions
172 // ---------------------------------------------------------------------------
173 #if wxUSE_WCHAR_T
174 class WXDLLEXPORT wxMBConv
175 {
176 public:
177 virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
178 virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const;
179 const wxWCharBuffer cMB2WC(const char *psz) const
180 {
181 if (psz) {
182 size_t nLen = MB2WC((wchar_t *) NULL, psz, 0);
183 wxWCharBuffer buf(nLen);
184 MB2WC(WCSTRINGCAST buf, psz, nLen);
185 return buf;
186 } else return wxWCharBuffer((wchar_t *) NULL);
187 }
188 const wxCharBuffer cWC2MB(const wchar_t *psz) const
189 {
190 if (psz) {
191 size_t nLen = WC2MB((char *) NULL, psz, 0);
192 wxCharBuffer buf(nLen);
193 WC2MB(MBSTRINGCAST buf, psz, nLen);
194 return buf;
195 } else return wxCharBuffer((char *) NULL);
196 }
197 #if wxUSE_UNICODE
198 const wxWCharBuffer cMB2WX(const char *psz) const { return cMB2WC(psz); }
199 const wxCharBuffer cWX2MB(const wchar_t *psz) const { return cWC2MB(psz); }
200 const wchar_t* cWC2WX(const wchar_t *psz) const { return psz; }
201 const wchar_t* cMB2WC(const wchar_t *psz) const { return psz; }
202 #else
203 const char* cMB2WX(const char *psz) const { return psz; }
204 const char* cWX2MB(const char *psz) const { return psz; }
205 const wxCharBuffer cWC2WX(const wchar_t *psz) const { return cWC2MB(psz); }
206 const wxWCharBuffer cWX2WC(const char *psz) const { return cMB2WC(psz); }
207 #endif
208 };
209 WXDLLEXPORT_DATA(extern wxMBConv) wxConvLibc;
210 #define wxConv_libc wxConvLibc
211
212 #define wxANOTHER_MBCONV(type) \
213 class type : public wxMBConv { \
214 public: \
215 virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const; \
216 virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const; \
217 }
218
219 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvFile)) wxConvFile;
220 #define wxConv_file wxConvFile
221 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvUTF7)) wxConvUTF7;
222 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvUTF8)) wxConvUTF8;
223 #define wxConv_UTF8 wxConvUTF8
224 #if defined(__WXGTK12__)
225 WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConvGdk)) wxConvGdk;
226 #define wxConv_gdk wxConvGdk
227 #endif // GTK > 1.0
228
229 class wxCharacterSet;
230 class WXDLLEXPORT wxCSConv : public wxMBConv
231 {
232 private:
233 wxChar *m_name;
234 wxCharacterSet *m_cset;
235 bool m_deferred;
236 void SetName(const wxChar *charset);
237 public:
238 wxCSConv(const wxChar *charset);
239 virtual ~wxCSConv();
240 void LoadNow();
241 virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
242 virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const;
243 };
244
245 WXDLLEXPORT_DATA(extern wxCSConv) wxConvLocal;
246 #define wxConv_local wxConvLocal
247
248 WXDLLEXPORT_DATA(extern wxMBConv *) wxConvCurrent;
249 #define wxConv_current wxConvCurrent
250
251 // filenames are multibyte on Unix and probably widechar on Windows?
252 #if defined(__UNIX__) || defined(__BORLANDC__)
253 #define wxMBFILES 1
254 #else
255 #define wxMBFILES 0
256 #endif
257
258 #if wxMBFILES
259 #define wxFNCONV(name) wxConvFile.cWX2MB(name)
260 #define FNSTRINGCAST MBSTRINGCAST
261 #else
262 #define wxFNCONV(name) name
263 #define FNSTRINGCAST WXSTRINGCAST
264 #endif
265 #else//!wxUSE_WCHAR_T
266 class WXDLLEXPORT wxMBConv {};
267 WXDLLEXPORT_DATA(extern wxMBConv) wxConvLibc, wxConvFile;
268 #define wxConv_libc wxConvLibc
269 #define wxConv_file wxConvFile
270 WXDLLEXPORT_DATA(extern wxMBConv *) wxConvCurrent;
271 #define wxConv_current wxConvCurrent
272 #endif//wxUSE_WCHAR_T
273
274 // ---------------------------------------------------------------------------
275 // This is (yet another one) String class for C++ programmers. It doesn't use
276 // any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
277 // thus you should be able to compile it with practicaly any C++ compiler.
278 // This class uses copy-on-write technique, i.e. identical strings share the
279 // same memory as long as neither of them is changed.
280 //
281 // This class aims to be as compatible as possible with the new standard
282 // std::string class, but adds some additional functions and should be at
283 // least as efficient than the standard implementation.
284 //
285 // Performance note: it's more efficient to write functions which take "const
286 // String&" arguments than "const char *" if you assign the argument to
287 // another string.
288 //
289 // It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5.
290 //
291 // To do:
292 // - ressource support (string tables in ressources)
293 // - more wide character (UNICODE) support
294 // - regular expressions support
295 // ---------------------------------------------------------------------------
296
297 #ifdef WXSTRING_IS_WXOBJECT
298 class WXDLLEXPORT wxString : public wxObject
299 {
300 DECLARE_DYNAMIC_CLASS(wxString)
301 #else //WXSTRING_IS_WXOBJECT
302 class WXDLLEXPORT wxString
303 {
304 #endif //WXSTRING_IS_WXOBJECT
305
306 friend class WXDLLEXPORT wxArrayString;
307
308 // NB: special care was taken in arranging the member functions in such order
309 // that all inline functions can be effectively inlined, verify that all
310 // performace critical functions are still inlined if you change order!
311 private:
312 // points to data preceded by wxStringData structure with ref count info
313 wxChar *m_pchData;
314
315 // accessor to string data
316 wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
317
318 // string (re)initialization functions
319 // initializes the string to the empty value (must be called only from
320 // ctors, use Reinit() otherwise)
321 void Init() { m_pchData = (wxChar *)g_szNul; }
322 // initializaes the string with (a part of) C-string
323 void InitWith(const wxChar *psz, size_t nPos = 0, size_t nLen = wxSTRING_MAXLEN);
324 // as Init, but also frees old data
325 void Reinit() { GetStringData()->Unlock(); Init(); }
326
327 // memory allocation
328 // allocates memory for string of lenght nLen
329 void AllocBuffer(size_t nLen);
330 // copies data to another string
331 void AllocCopy(wxString&, int, int) const;
332 // effectively copies data to string
333 void AssignCopy(size_t, const wxChar *);
334
335 // append a (sub)string
336 void ConcatSelf(int nLen, const wxChar *src);
337
338 // functions called before writing to the string: they copy it if there
339 // are other references to our data (should be the only owner when writing)
340 void CopyBeforeWrite();
341 void AllocBeforeWrite(size_t);
342
343 // this method is not implemented - there is _no_ conversion from int to
344 // string, you're doing something wrong if the compiler wants to call it!
345 //
346 // try `s << i' or `s.Printf("%d", i)' instead
347 wxString(int);
348 wxString(long);
349
350 public:
351 // constructors and destructor
352 // ctor for an empty string
353 wxString() { Init(); }
354 // copy ctor
355 wxString(const wxString& stringSrc)
356 {
357 wxASSERT( stringSrc.GetStringData()->IsValid() );
358
359 if ( stringSrc.IsEmpty() ) {
360 // nothing to do for an empty string
361 Init();
362 }
363 else {
364 m_pchData = stringSrc.m_pchData; // share same data
365 GetStringData()->Lock(); // => one more copy
366 }
367 }
368 // string containing nRepeat copies of ch
369 wxString(wxChar ch, size_t nRepeat = 1);
370 // ctor takes first nLength characters from C string
371 // (default value of wxSTRING_MAXLEN means take all the string)
372 wxString(const wxChar *psz, size_t nLength = wxSTRING_MAXLEN)
373 { InitWith(psz, 0, nLength); }
374 #if wxUSE_UNICODE
375 // from multibyte string
376 // (NB: nLength is right now number of Unicode characters, not
377 // characters in psz! So try not to use it yet!)
378 wxString(const char *psz, wxMBConv& conv = wxConvLibc, size_t nLength = wxSTRING_MAXLEN);
379 // from wxWCharBuffer (i.e. return from wxGetString)
380 wxString(const wxWCharBuffer& psz)
381 { InitWith(psz, 0, wxSTRING_MAXLEN); }
382 #else
383 // from C string (for compilers using unsigned char)
384 wxString(const unsigned char* psz, size_t nLength = wxSTRING_MAXLEN)
385 { InitWith((const char*)psz, 0, nLength); }
386 // from multibyte string
387 wxString(const char *psz, wxMBConv& WXUNUSED(conv), size_t nLength = wxSTRING_MAXLEN)
388 { InitWith(psz, 0, nLength); }
389 #if wxUSE_WCHAR_T
390 // from wide (Unicode) string
391 wxString(const wchar_t *pwz);
392 #endif
393 // from wxCharBuffer
394 wxString(const wxCharBuffer& psz)
395 { InitWith(psz, 0, wxSTRING_MAXLEN); }
396 #endif
397 // dtor is not virtual, this class must not be inherited from!
398 ~wxString() { GetStringData()->Unlock(); }
399
400 // generic attributes & operations
401 // as standard strlen()
402 size_t Len() const { return GetStringData()->nDataLength; }
403 // string contains any characters?
404 bool IsEmpty() const { return Len() == 0; }
405 // empty string is "FALSE", so !str will return TRUE
406 bool operator!() const { return IsEmpty(); }
407 // empty string contents
408 void Empty()
409 {
410 if ( !IsEmpty() )
411 Reinit();
412
413 // should be empty
414 wxASSERT( GetStringData()->nDataLength == 0 );
415 }
416 // empty the string and free memory
417 void Clear()
418 {
419 if ( !GetStringData()->IsEmpty() )
420 Reinit();
421
422 wxASSERT( GetStringData()->nDataLength == 0 ); // should be empty
423 wxASSERT( GetStringData()->nAllocLength == 0 ); // and not own any memory
424 }
425
426 // contents test
427 // Is an ascii value
428 bool IsAscii() const;
429 // Is a number
430 bool IsNumber() const;
431 // Is a word
432 bool IsWord() const;
433
434 // data access (all indexes are 0 based)
435 // read access
436 wxChar GetChar(size_t n) const
437 { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
438 // read/write access
439 wxChar& GetWritableChar(size_t n)
440 { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
441 // write access
442 void SetChar(size_t n, wxChar ch)
443 { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; }
444
445 // get last character
446 wxChar Last() const
447 { wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; }
448 // get writable last character
449 wxChar& Last()
450 { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; }
451
452 // under Unix it is tested with configure, assume it works on other
453 // platforms (there might be overloading problems if size_t and int are
454 // the same type)
455 #if !defined(__UNIX__) || wxUSE_SIZE_T_STRING_OPERATOR
456 // operator version of GetChar
457 wxChar operator[](size_t n) const
458 { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
459 #endif
460
461 // operator version of GetChar
462 wxChar operator[](int n) const
463 { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
464 // operator version of GetWritableChar
465 wxChar& operator[](size_t n)
466 { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
467
468 // implicit conversion to C string
469 operator const wxChar*() const { return m_pchData; }
470 // explicit conversion to C string (use this with printf()!)
471 const wxChar* c_str() const { return m_pchData; }
472 // (and this with [wx]Printf()!)
473 const wxChar* wx_str() const { return m_pchData; }
474 //
475 const wxChar* GetData() const { return m_pchData; }
476 #if wxUSE_UNICODE
477 const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const { return conv.cWC2MB(m_pchData); }
478 const wxChar* wc_str(wxMBConv& WXUNUSED(conv) = wxConvLibc) const { return m_pchData; }
479 #if wxMBFILES
480 const wxCharBuffer fn_str() const { return mb_str(wxConvFile); }
481 #else
482 const wxChar* fn_str() const { return m_pchData; }
483 #endif
484 #else
485 const wxChar* mb_str(wxMBConv& WXUNUSED(conv) = wxConvLibc ) const { return m_pchData; }
486 #if wxUSE_WCHAR_T
487 const wxWCharBuffer wc_str(wxMBConv& conv) const { return conv.cMB2WC(m_pchData); }
488 #endif
489 const wxChar* fn_str() const { return m_pchData; }
490 #endif
491 // for convenience
492 const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }
493
494 // overloaded assignment
495 // from another wxString
496 wxString& operator=(const wxString& stringSrc);
497 // from a character
498 wxString& operator=(wxChar ch);
499 // from a C string
500 wxString& operator=(const wxChar *psz);
501 #if wxUSE_UNICODE
502 // from wxWCharBuffer
503 wxString& operator=(const wxWCharBuffer& psz) { return operator=((const wchar_t *)psz); }
504 #else
505 // from another kind of C string
506 wxString& operator=(const unsigned char* psz);
507 #if wxUSE_WCHAR_T
508 // from a wide string
509 wxString& operator=(const wchar_t *pwz);
510 #endif
511 // from wxCharBuffer
512 wxString& operator=(const wxCharBuffer& psz) { return operator=((const char *)psz); }
513 #endif
514
515 // string concatenation
516 // in place concatenation
517 /*
518 Concatenate and return the result. Note that the left to right
519 associativity of << allows to write things like "str << str1 << str2
520 << ..." (unlike with +=)
521 */
522 // string += string
523 wxString& operator<<(const wxString& s)
524 {
525 wxASSERT( s.GetStringData()->IsValid() );
526
527 ConcatSelf(s.Len(), s);
528 return *this;
529 }
530 // string += C string
531 wxString& operator<<(const wxChar *psz)
532 { ConcatSelf(wxStrlen(psz), psz); return *this; }
533 // string += char
534 wxString& operator<<(wxChar ch) { ConcatSelf(1, &ch); return *this; }
535
536 // string += string
537 void operator+=(const wxString& s) { (void)operator<<(s); }
538 // string += C string
539 void operator+=(const wxChar *psz) { (void)operator<<(psz); }
540 // string += char
541 void operator+=(wxChar ch) { (void)operator<<(ch); }
542
543 // string += buffer (i.e. from wxGetString)
544 #if wxUSE_UNICODE
545 wxString& operator<<(const wxWCharBuffer& s) { (void)operator<<((const wchar_t *)s); return *this; }
546 void operator+=(const wxWCharBuffer& s) { (void)operator<<((const wchar_t *)s); }
547 #else
548 wxString& operator<<(const wxCharBuffer& s) { (void)operator<<((const char *)s); return *this; }
549 void operator+=(const wxCharBuffer& s) { (void)operator<<((const char *)s); }
550 #endif
551
552 // string += C string
553 wxString& Append(const wxChar* psz)
554 { ConcatSelf(wxStrlen(psz), psz); return *this; }
555 // append count copies of given character
556 wxString& Append(wxChar ch, size_t count = 1u)
557 { wxString str(ch, count); return *this << str; }
558
559 // prepend a string, return the string itself
560 wxString& Prepend(const wxString& str)
561 { *this = str + *this; return *this; }
562
563 // non-destructive concatenation
564 //
565 friend wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2);
566 //
567 friend wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch);
568 //
569 friend wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string);
570 //
571 friend wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz);
572 //
573 friend wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string);
574
575 // stream-like functions
576 // insert an int into string
577 wxString& operator<<(int i);
578 // insert a float into string
579 wxString& operator<<(float f);
580 // insert a double into string
581 wxString& operator<<(double d);
582
583 // string comparison
584 // case-sensitive comparison (returns a value < 0, = 0 or > 0)
585 int Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); }
586 // same as Cmp() but not case-sensitive
587 int CmpNoCase(const wxChar *psz) const { return wxStricmp(c_str(), psz); }
588 // test for the string equality, either considering case or not
589 // (if compareWithCase then the case matters)
590 bool IsSameAs(const wxChar *psz, bool compareWithCase = TRUE) const
591 { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
592
593 // simple sub-string extraction
594 // return substring starting at nFirst of length nCount (or till the end
595 // if nCount = default value)
596 wxString Mid(size_t nFirst, size_t nCount = wxSTRING_MAXLEN) const;
597
598 // operator version of Mid()
599 wxString operator()(size_t start, size_t len) const
600 { return Mid(start, len); }
601
602 // get first nCount characters
603 wxString Left(size_t nCount) const;
604 // get last nCount characters
605 wxString Right(size_t nCount) const;
606 // get all characters before the first occurence of ch
607 // (returns the whole string if ch not found)
608 wxString BeforeFirst(wxChar ch) const;
609 // get all characters before the last occurence of ch
610 // (returns empty string if ch not found)
611 wxString BeforeLast(wxChar ch) const;
612 // get all characters after the first occurence of ch
613 // (returns empty string if ch not found)
614 wxString AfterFirst(wxChar ch) const;
615 // get all characters after the last occurence of ch
616 // (returns the whole string if ch not found)
617 wxString AfterLast(wxChar ch) const;
618
619 // for compatibility only, use more explicitly named functions above
620 wxString Before(wxChar ch) const { return BeforeLast(ch); }
621 wxString After(wxChar ch) const { return AfterFirst(ch); }
622
623 // case conversion
624 // convert to upper case in place, return the string itself
625 wxString& MakeUpper();
626 // convert to upper case, return the copy of the string
627 // Here's something to remember: BC++ doesn't like returns in inlines.
628 wxString Upper() const ;
629 // convert to lower case in place, return the string itself
630 wxString& MakeLower();
631 // convert to lower case, return the copy of the string
632 wxString Lower() const ;
633
634 // trimming/padding whitespace (either side) and truncating
635 // remove spaces from left or from right (default) side
636 wxString& Trim(bool bFromRight = TRUE);
637 // add nCount copies chPad in the beginning or at the end (default)
638 wxString& Pad(size_t nCount, wxChar chPad = _T(' '), bool bFromRight = TRUE);
639 // truncate string to given length
640 wxString& Truncate(size_t uiLen);
641
642 // searching and replacing
643 // searching (return starting index, or -1 if not found)
644 int Find(wxChar ch, bool bFromEnd = FALSE) const; // like strchr/strrchr
645 // searching (return starting index, or -1 if not found)
646 int Find(const wxChar *pszSub) const; // like strstr
647 // replace first (or all of bReplaceAll) occurences of substring with
648 // another string, returns the number of replacements made
649 size_t Replace(const wxChar *szOld,
650 const wxChar *szNew,
651 bool bReplaceAll = TRUE);
652
653 // check if the string contents matches a mask containing '*' and '?'
654 bool Matches(const wxChar *szMask) const;
655
656 // formated input/output
657 // as sprintf(), returns the number of characters written or < 0 on error
658 int Printf(const wxChar *pszFormat, ...);
659 // as vprintf(), returns the number of characters written or < 0 on error
660 int PrintfV(const wxChar* pszFormat, va_list argptr);
661
662 // raw access to string memory
663 // ensure that string has space for at least nLen characters
664 // only works if the data of this string is not shared
665 void Alloc(size_t nLen);
666 // minimize the string's memory
667 // only works if the data of this string is not shared
668 void Shrink();
669 // get writable buffer of at least nLen bytes. Unget() *must* be called
670 // a.s.a.p. to put string back in a reasonable state!
671 wxChar *GetWriteBuf(size_t nLen);
672 // call this immediately after GetWriteBuf() has been used
673 void UngetWriteBuf();
674
675 // wxWindows version 1 compatibility functions
676
677 // use Mid()
678 wxString SubString(size_t from, size_t to) const
679 { return Mid(from, (to - from + 1)); }
680 // values for second parameter of CompareTo function
681 enum caseCompare {exact, ignoreCase};
682 // values for first parameter of Strip function
683 enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
684
685 // use Printf()
686 int sprintf(const wxChar *pszFormat, ...);
687
688 // use Cmp()
689 inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const
690 { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
691
692 // use Len
693 size_t Length() const { return Len(); }
694 // Count the number of characters
695 int Freq(wxChar ch) const;
696 // use MakeLower
697 void LowerCase() { MakeLower(); }
698 // use MakeUpper
699 void UpperCase() { MakeUpper(); }
700 // use Trim except that it doesn't change this string
701 wxString Strip(stripType w = trailing) const;
702
703 // use Find (more general variants not yet supported)
704 size_t Index(const wxChar* psz) const { return Find(psz); }
705 size_t Index(wxChar ch) const { return Find(ch); }
706 // use Truncate
707 wxString& Remove(size_t pos) { return Truncate(pos); }
708 wxString& RemoveLast() { return Truncate(Len() - 1); }
709
710 wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); }
711
712 // use Find()
713 int First( const wxChar ch ) const { return Find(ch); }
714 int First( const wxChar* psz ) const { return Find(psz); }
715 int First( const wxString &str ) const { return Find(str); }
716 int Last( const wxChar ch ) const { return Find(ch, TRUE); }
717 bool Contains(const wxString& str) const { return Find(str) != -1; }
718
719 // use IsEmpty()
720 bool IsNull() const { return IsEmpty(); }
721
722 #ifdef wxSTD_STRING_COMPATIBILITY
723 // std::string compatibility functions
724
725 // an 'invalid' value for string index
726 static const size_t npos;
727
728 // constructors
729 // take nLen chars starting at nPos
730 wxString(const wxString& str, size_t nPos, size_t nLen)
731 {
732 wxASSERT( str.GetStringData()->IsValid() );
733 InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
734 }
735 // take all characters from pStart to pEnd
736 wxString(const void *pStart, const void *pEnd);
737
738 // lib.string.capacity
739 // return the length of the string
740 size_t size() const { return Len(); }
741 // return the length of the string
742 size_t length() const { return Len(); }
743 // return the maximum size of the string
744 size_t max_size() const { return wxSTRING_MAXLEN; }
745 // resize the string, filling the space with c if c != 0
746 void resize(size_t nSize, wxChar ch = _T('\0'));
747 // delete the contents of the string
748 void clear() { Empty(); }
749 // returns true if the string is empty
750 bool empty() const { return IsEmpty(); }
751
752 // lib.string.access
753 // return the character at position n
754 wxChar at(size_t n) const { return GetChar(n); }
755 // returns the writable character at position n
756 wxChar& at(size_t n) { return GetWritableChar(n); }
757
758 // lib.string.modifiers
759 // append a string
760 wxString& append(const wxString& str)
761 { *this += str; return *this; }
762 // append elements str[pos], ..., str[pos+n]
763 wxString& append(const wxString& str, size_t pos, size_t n)
764 { ConcatSelf(n, str.c_str() + pos); return *this; }
765 // append first n (or all if n == npos) characters of sz
766 wxString& append(const wxChar *sz, size_t n = npos)
767 { ConcatSelf(n == npos ? wxStrlen(sz) : n, sz); return *this; }
768
769 // append n copies of ch
770 wxString& append(size_t n, wxChar ch) { return Pad(n, ch); }
771
772 // same as `this_string = str'
773 wxString& assign(const wxString& str) { return (*this) = str; }
774 // same as ` = str[pos..pos + n]
775 wxString& assign(const wxString& str, size_t pos, size_t n)
776 { return *this = wxString((const wxChar *)str + pos, n); }
777 // same as `= first n (or all if n == npos) characters of sz'
778 wxString& assign(const wxChar *sz, size_t n = npos)
779 { return *this = wxString(sz, n); }
780 // same as `= n copies of ch'
781 wxString& assign(size_t n, wxChar ch)
782 { return *this = wxString(ch, n); }
783
784 // insert another string
785 wxString& insert(size_t nPos, const wxString& str);
786 // insert n chars of str starting at nStart (in str)
787 wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
788 { return insert(nPos, wxString((const wxChar *)str + nStart, n)); }
789
790 // insert first n (or all if n == npos) characters of sz
791 wxString& insert(size_t nPos, const wxChar *sz, size_t n = npos)
792 { return insert(nPos, wxString(sz, n)); }
793 // insert n copies of ch
794 wxString& insert(size_t nPos, size_t n, wxChar ch)
795 { return insert(nPos, wxString(ch, n)); }
796
797 // delete characters from nStart to nStart + nLen
798 wxString& erase(size_t nStart = 0, size_t nLen = npos);
799
800 // replaces the substring of length nLen starting at nStart
801 wxString& replace(size_t nStart, size_t nLen, const wxChar* sz);
802 // replaces the substring with nCount copies of ch
803 wxString& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch);
804 // replaces a substring with another substring
805 wxString& replace(size_t nStart, size_t nLen,
806 const wxString& str, size_t nStart2, size_t nLen2);
807 // replaces the substring with first nCount chars of sz
808 wxString& replace(size_t nStart, size_t nLen,
809 const wxChar* sz, size_t nCount);
810
811 // swap two strings
812 void swap(wxString& str);
813
814 // All find() functions take the nStart argument which specifies the
815 // position to start the search on, the default value is 0. All functions
816 // return npos if there were no match.
817
818 // find a substring
819 size_t find(const wxString& str, size_t nStart = 0) const;
820
821 // VC++ 1.5 can't cope with this syntax.
822 #if !defined(__VISUALC__) || defined(__WIN32__)
823 // find first n characters of sz
824 size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
825 #endif
826
827 // Gives a duplicate symbol (presumably a case-insensitivity problem)
828 #if !defined(__BORLANDC__)
829 // find the first occurence of character ch after nStart
830 size_t find(wxChar ch, size_t nStart = 0) const;
831 #endif
832 // rfind() family is exactly like find() but works right to left
833
834 // as find, but from the end
835 size_t rfind(const wxString& str, size_t nStart = npos) const;
836
837 // VC++ 1.5 can't cope with this syntax.
838 #if !defined(__VISUALC__) || defined(__WIN32__)
839 // as find, but from the end
840 size_t rfind(const wxChar* sz, size_t nStart = npos,
841 size_t n = npos) const;
842 // as find, but from the end
843 size_t rfind(wxChar ch, size_t nStart = npos) const;
844 #endif
845
846 // find first/last occurence of any character in the set
847
848 //
849 size_t find_first_of(const wxString& str, size_t nStart = 0) const;
850 //
851 size_t find_first_of(const wxChar* sz, size_t nStart = 0) const;
852 // same as find(char, size_t)
853 size_t find_first_of(wxChar c, size_t nStart = 0) const;
854 //
855 size_t find_last_of (const wxString& str, size_t nStart = npos) const;
856 //
857 size_t find_last_of (const wxChar* s, size_t nStart = npos) const;
858 // same as rfind(char, size_t)
859 size_t find_last_of (wxChar c, size_t nStart = npos) const;
860
861 // find first/last occurence of any character not in the set
862
863 //
864 size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
865 //
866 size_t find_first_not_of(const wxChar* s, size_t nStart = 0) const;
867 //
868 size_t find_first_not_of(wxChar ch, size_t nStart = 0) const;
869 //
870 size_t find_last_not_of(const wxString& str, size_t nStart=npos) const;
871 //
872 size_t find_last_not_of(const wxChar* s, size_t nStart = npos) const;
873 //
874 size_t find_last_not_of(wxChar ch, size_t nStart = npos) const;
875
876 // All compare functions return -1, 0 or 1 if the [sub]string is less,
877 // equal or greater than the compare() argument.
878
879 // just like strcmp()
880 int compare(const wxString& str) const { return Cmp(str); }
881 // comparison with a substring
882 int compare(size_t nStart, size_t nLen, const wxString& str) const;
883 // comparison of 2 substrings
884 int compare(size_t nStart, size_t nLen,
885 const wxString& str, size_t nStart2, size_t nLen2) const;
886 // just like strcmp()
887 int compare(const wxChar* sz) const { return Cmp(sz); }
888 // substring comparison with first nCount characters of sz
889 int compare(size_t nStart, size_t nLen,
890 const wxChar* sz, size_t nCount = npos) const;
891
892 // substring extraction
893 wxString substr(size_t nStart = 0, size_t nLen = npos) const;
894 #endif // wxSTD_STRING_COMPATIBILITY
895 };
896
897 // ----------------------------------------------------------------------------
898 // The string array uses it's knowledge of internal structure of the wxString
899 // class to optimize string storage. Normally, we would store pointers to
900 // string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is
901 // sizeof(char *)) we store these pointers instead. The cast to "wxString *" is
902 // really all we need to turn such pointer into a string!
903 //
904 // Of course, it can be called a dirty hack, but we use twice less memory and
905 // this approach is also more speed efficient, so it's probably worth it.
906 //
907 // Usage notes: when a string is added/inserted, a new copy of it is created,
908 // so the original string may be safely deleted. When a string is retrieved
909 // from the array (operator[] or Item() method), a reference is returned.
910 // ----------------------------------------------------------------------------
911 class WXDLLEXPORT wxArrayString
912 {
913 public:
914 // type of function used by wxArrayString::Sort()
915 typedef int (*CompareFunction)(const wxString& first,
916 const wxString& second);
917
918 // constructors and destructor
919 // default ctor
920 wxArrayString();
921 // copy ctor
922 wxArrayString(const wxArrayString& array);
923 // assignment operator
924 wxArrayString& operator=(const wxArrayString& src);
925 // not virtual, this class should not be derived from
926 ~wxArrayString();
927
928 // memory management
929 // empties the list, but doesn't release memory
930 void Empty();
931 // empties the list and releases memory
932 void Clear();
933 // preallocates memory for given number of items
934 void Alloc(size_t nCount);
935 // minimzes the memory usage (by freeing all extra memory)
936 void Shrink();
937
938 // simple accessors
939 // number of elements in the array
940 size_t GetCount() const { return m_nCount; }
941 // is it empty?
942 bool IsEmpty() const { return m_nCount == 0; }
943 // number of elements in the array (GetCount is preferred API)
944 size_t Count() const { return m_nCount; }
945
946 // items access (range checking is done in debug version)
947 // get item at position uiIndex
948 wxString& Item(size_t nIndex) const
949 { wxASSERT( nIndex < m_nCount ); return *(wxString *)&(m_pItems[nIndex]); }
950 // same as Item()
951 wxString& operator[](size_t nIndex) const { return Item(nIndex); }
952 // get last item
953 wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
954
955 // item management
956 // Search the element in the array, starting from the beginning if
957 // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
958 // sensitive (default). Returns index of the first item matched or
959 // wxNOT_FOUND
960 int Index (const wxChar *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
961 // add new element at the end
962 void Add(const wxString& str);
963 // add new element at given position
964 void Insert(const wxString& str, size_t uiIndex);
965 // remove first item matching this value
966 void Remove(const wxChar *sz);
967 // remove item by index
968 void Remove(size_t nIndex);
969
970 // sorting
971 // sort array elements in alphabetical order (or reversed alphabetical
972 // order if reverseOrder parameter is TRUE)
973 void Sort(bool reverseOrder = FALSE);
974 // sort array elements using specified comparaison function
975 void Sort(CompareFunction compareFunction);
976
977 private:
978 void Grow(); // makes array bigger if needed
979 void Free(); // free the string stored
980
981 void DoSort(); // common part of all Sort() variants
982
983 size_t m_nSize, // current size of the array
984 m_nCount; // current number of elements
985
986 wxChar **m_pItems; // pointer to data
987 };
988
989 // ---------------------------------------------------------------------------
990 // wxString comparison functions: operator versions are always case sensitive
991 // ---------------------------------------------------------------------------
992 //
993 inline bool operator==(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) == 0); }
994 //
995 inline bool operator==(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) == 0); }
996 //
997 inline bool operator==(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) == 0); }
998 //
999 inline bool operator!=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) != 0); }
1000 //
1001 inline bool operator!=(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) != 0); }
1002 //
1003 inline bool operator!=(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) != 0); }
1004 //
1005 inline bool operator< (const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) < 0); }
1006 //
1007 inline bool operator< (const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) < 0); }
1008 //
1009 inline bool operator< (const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) > 0); }
1010 //
1011 inline bool operator> (const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) > 0); }
1012 //
1013 inline bool operator> (const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) > 0); }
1014 //
1015 inline bool operator> (const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) < 0); }
1016 //
1017 inline bool operator<=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) <= 0); }
1018 //
1019 inline bool operator<=(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) <= 0); }
1020 //
1021 inline bool operator<=(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) >= 0); }
1022 //
1023 inline bool operator>=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) >= 0); }
1024 //
1025 inline bool operator>=(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) >= 0); }
1026 //
1027 inline bool operator>=(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) <= 0); }
1028
1029 wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2);
1030 wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch);
1031 wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string);
1032 wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz);
1033 wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string);
1034 #if wxUSE_UNICODE
1035 inline wxString WXDLLEXPORT operator+(const wxString& string, const wxWCharBuffer& buf)
1036 { return string + (const wchar_t *)buf; }
1037 inline wxString WXDLLEXPORT operator+(const wxWCharBuffer& buf, const wxString& string)
1038 { return (const wchar_t *)buf + string; }
1039 #else
1040 inline wxString WXDLLEXPORT operator+(const wxString& string, const wxCharBuffer& buf)
1041 { return string + (const char *)buf; }
1042 inline wxString WXDLLEXPORT operator+(const wxCharBuffer& buf, const wxString& string)
1043 { return (const char *)buf + string; }
1044 #endif
1045
1046 // ---------------------------------------------------------------------------
1047 // Implementation only from here until the end of file
1048 // ---------------------------------------------------------------------------
1049
1050 #ifdef wxSTD_STRING_COMPATIBILITY
1051
1052 #include "wx/ioswrap.h"
1053
1054 WXDLLEXPORT istream& operator>>(istream& is, wxString& str);
1055
1056 #endif // wxSTD_STRING_COMPATIBILITY
1057
1058 #endif // _WX_WXSTRINGH__
wxWidgets (Impactor)