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