interface/wx/arrstr.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        arrstr.h
   3 // Purpose:     interface of wxArrayString
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxArrayString
  11
  12     wxArrayString is an efficient container for storing wxString objects.
  13
  14     It has the same features as all wxArray classes, i.e. it dynamically expands
  15     when new items are added to it (so it is as easy to use as a linked list),
  16     but the access time to the elements is constant, instead of being linear in
  17     number of elements as in the case of linked lists. It is also very size
  18     efficient and doesn't take more space than a C array @e wxString[] type
  19     (wxArrayString uses its knowledge of internals of wxString class to achieve this).
  20
  21     This class is used in the same way as other dynamic arrays(), except that no
  22     ::WX_DEFINE_ARRAY declaration is needed for it.
  23     When a string is added or inserted in the array, a copy of the string is created,
  24     so the original string may be safely deleted (e.g. if it was a @e wxChar *
  25     pointer the memory it was using can be freed immediately after this).
  26     In general, there is no need to worry about string memory deallocation when using
  27     this class - it will always free the memory it uses itself.
  28
  29     The references returned by wxArrayString::Item, wxArrayString::Last or
  30     wxArrayString::operator[] are not constant, so the array elements may
  31     be modified in place like this:
  32
  33     @code
  34     array.Last().MakeUpper();
  35     @endcode
  36
  37     @note none of the methods of wxArrayString is virtual including its
  38           destructor, so this class should not be used as a base class.
  39
  40     Although this is not true strictly speaking, this class may be considered as
  41     a specialization of wxArray class for the wxString member data: it is not
  42     implemented like this, but it does have all of the wxArray functions.
  43
  44     @todo what about stl? how does it integrate?
  45
  46     @library{wxbase}
  47     @category{containers}
  48
  49     @see wxArray<T>, wxString, @ref overview_string
  50 */
  51 class wxArrayString : public wxArray
  52 {
  53 public:
  54     /**
  55         The function type used with wxArrayString::Sort function.
  56     */
  57     typedef int (*CompareFunction)(const wxString& first, const wxString& second);
  58
  59     /**
  60         Default constructor.
  61     */
  62     wxArrayString();
  63
  64     /**
  65         Copy constructor.
  66     */
  67     wxArrayString(const wxArrayString& array);
  68
  69     //@{
  70     /**
  71         Constructor from a C string array. Pass a size @a sz and an array @a arr.
  72     **/
  73     wxArrayString(size_t sz, const char** arr);
  74     wxArrayString(size_t sz, const wchar_t** arr);
  75     //@}
  76
  77     /**
  78         Constructor from a wxString array. Pass a size @a sz and array @a arr.
  79     */
  80     wxArrayString(size_t sz, const wxString* arr);
  81
  82     /**
  83         Destructor frees memory occupied by the array strings. For performance
  84         reasons it is not virtual, so this class should not be derived from.
  85     */
  86     ~wxArrayString();
  87
  88     /**
  89         Appends the given number of @a copies of the new item @a str to the
  90         array and returns the index of the first new item in the array.
  91
  92         @see Insert()
  93     */
  94     size_t Add(const wxString& str, size_t copies = 1);
  95
  96     /**
  97         Preallocates enough memory to store @a nCount items.
  98
  99         This function may be used to improve array class performance before
 100         adding a known number of items consecutively.
 101     */
 102     void Alloc(size_t nCount);
 103
 104     /**
 105         Clears the array contents and frees memory.
 106
 107         @see Empty()
 108     */
 109     void Clear();
 110
 111     /**
 112         Empties the array: after a call to this function GetCount() will return 0.
 113         However, this function does not free the memory used by the array and so
 114         should be used when the array is going to be reused for storing other strings.
 115         Otherwise, you should use Clear() to empty the array and free memory.
 116     */
 117     void Empty();
 118
 119     /**
 120         Returns the number of items in the array.
 121     */
 122     size_t GetCount() const;
 123
 124     /**
 125         Search the element in the array, starting from the beginning if @a bFromEnd
 126         is @false or from end otherwise. If @a bCase, comparison is case sensitive
 127         (default), otherwise the case is ignored.
 128
 129         This function uses linear search for wxArrayString.
 130         Returns index of the first item matched or @c wxNOT_FOUND if there is no match.
 131     */
 132     int Index(const wxString& sz, bool bCase = true, bool bFromEnd = false) const;
 133
 134     /**
 135         Insert the given number of @a copies of the new element in the array before the
 136         position @a nIndex. Thus, for example, to insert the string in the beginning of
 137         the array you would write:
 138
 139         @code
 140         Insert("foo", 0);
 141         @endcode
 142
 143         If @a nIndex is equal to GetCount() this function behaves as Add().
 144     */
 145     void Insert(wxString lItem, size_t nIndex, size_t copies = 1);
 146
 147     /**
 148         Returns @true if the array is empty, @false otherwise. This function returns the
 149         same result as GetCount() == 0 but is probably easier to read.
 150     */
 151     bool IsEmpty() const;
 152
 153     /**
 154         Return the array element at position @a nIndex. An assert failure will
 155         result from an attempt to access an element beyond the end of array in debug
 156         mode, but no check is done in release mode.
 157
 158         @see operator[] for the operator version.
 159     */
 160     wxString& Item(size_t nIndex) const;
 161
 162     /**
 163         Returns the last element of the array. Attempt to access the last element of
 164         an empty array will result in assert failure in debug build, however no checks
 165         are done in release mode.
 166     */
 167     wxString& Last() const;
 168
 169     /**
 170         Removes the first item matching this value. An assert failure is provoked by
 171         an attempt to remove an element which does not exist in debug build.
 172
 173         @see Index()
 174     */
 175     void Remove(const wxString& sz);
 176
 177     /**
 178         Removes @a count items starting at position @a nIndex from the array.
 179     */
 180     void RemoveAt(size_t nIndex, size_t count = 1);
 181
 182     /**
 183         Releases the extra memory allocated by the array.
 184         This function is useful to minimize the array memory consumption.
 185
 186         @see Alloc()
 187     */
 188     void Shrink();
 189
 190     /**
 191         Sorts the array in alphabetical order or in reverse alphabetical order if
 192         @a reverseOrder is @true. The sort is case-sensitive.
 193     */
 194     void Sort(bool reverseOrder = false);
 195
 196     /**
 197         Sorts the array using the specified @a compareFunction for item comparison.
 198         @a CompareFunction is defined as a function taking two <em>const wxString&</em>
 199         parameters and returning an @e int value less than, equal to or greater
 200         than 0 if the first string is less than, equal to or greater than the
 201         second one.
 202
 203         Example:
 204         The following example sorts strings by their length.
 205
 206         @code
 207         static int CompareStringLen(const wxString& first, const wxString& second)
 208         {
 209             return first.length() - second.length();
 210         }
 211
 212         ...
 213
 214         wxArrayString array;
 215
 216         array.Add("one");
 217         array.Add("two");
 218         array.Add("three");
 219         array.Add("four");
 220
 221         array.Sort(CompareStringLen);
 222         @endcode
 223     */
 224     void Sort(CompareFunction compareFunction);
 225
 226     /**
 227         Compares 2 arrays respecting the case. Returns @true if the arrays have
 228         different number of elements or if the elements don't match pairwise.
 229     */
 230     bool operator !=(const wxArrayString& array) const;
 231
 232     /**
 233         Assignment operator.
 234     */
 235     wxArrayString& operator=(const wxArrayString&);
 236
 237     /**
 238         Compares 2 arrays respecting the case. Returns @true only if the arrays have
 239         the same number of elements and the same strings in the same order.
 240     */
 241     bool operator ==(const wxArrayString& array) const;
 242
 243     /**
 244         Return the array element at position @a nIndex. An assert failure will
 245         result from an attempt to access an element beyond the end of array in
 246         debug mode, but no check is done in release mode.
 247
 248         This is the operator version of the Item() method.
 249     */
 250     wxString& operator[](size_t nIndex) const;
 251 };
 252
 253
 254 /**
 255     @class wxSortedArrayString
 256
 257     wxSortedArrayString is an efficient container for storing wxString objects
 258     which always keeps the string in alphabetical order.
 259
 260     wxSortedArrayString uses binary search in its wxArrayString::Index() function
 261     (instead of linear search for wxArrayString::Index()) which makes it much more
 262     efficient if you add strings to the array rarely (because, of course, you have
 263     to pay for Index() efficiency by having Add() be slower) but search for them
 264     often. Several methods should not be used with sorted array (basically, all
 265     those which break the order of items) which is mentioned in their description.
 266
 267     @todo what about STL? who does it integrates?
 268
 269     @library{wxbase}
 270     @category{containers}
 271
 272     @see wxArray, wxString, @ref overview_string
 273 */
 274 class wxSortedArrayString : public wxArrayString
 275 {
 276 public:
 277
 278     /**
 279         Copy constructor. Note that when an array is assigned to a sorted array,
 280         its contents is automatically sorted during construction.
 281     */
 282     wxArrayString(const wxArrayString& array);
 283
 284     /**
 285         @copydoc wxArrayString::Add()
 286
 287         @warning
 288         For sorted arrays, the index of the inserted item will not be, in general,
 289         equal to GetCount() - 1 because the item is inserted at the correct position
 290         to keep the array sorted and not appended.
 291     */
 292     size_t Add(const wxString& str, size_t copies = 1);
 293
 294
 295     /**
 296         @copydoc wxArrayString::Index()
 297
 298         This function uses binary search for wxSortedArrayString, but it ignores
 299         the @a bCase and @a bFromEnd parameters.
 300     */
 301     int Index(const wxString& sz, bool bCase = true,
 302               bool bFromEnd = false) const;
 303
 304     /**
 305         @warning This function should not be used with sorted arrays because it
 306                  could break the order of items and, for example, subsequent calls
 307                  to Index() would then not work!
 308     */
 309     void Insert(const wxString& str, size_t nIndex,
 310                 size_t copies = 1);
 311
 312     //@{
 313     /**
 314         @warning This function should not be used with sorted array because it could
 315                  break the order of items and, for example, subsequent calls to Index()
 316                  would then not work! Also, sorting a wxSortedArrayString doesn't make
 317                  sense because its elements are always already sorted.
 318     */
 319     void Sort(bool reverseOrder = false);
 320     void Sort(CompareFunction compareFunction);
 321     //@}
 322 };
 323
 324
 325 // ============================================================================
 326 // Global functions/macros
 327 // ============================================================================
 328
 329 /** @addtogroup group_funcmacro_string */
 330 //@{
 331
 332 /**
 333     Splits the given wxString object using the separator @a sep and returns the
 334     result as a wxArrayString.
 335
 336     If the @a escape character is non-@NULL, then the occurrences of @a sep
 337     immediately prefixed with @a escape are not considered as separators.
 338     Note that empty tokens will be generated if there are two or more adjacent
 339     separators.
 340
 341     @see wxJoin()
 342
 343     @header{wx/arrstr.h}
 344 */
 345 wxArrayString wxSplit(const wxString& str, const wxChar sep,
 346                       const wxChar escape = '\\');
 347
 348 /**
 349     Concatenate all lines of the given wxArrayString object using the separator
 350     @a sep and returns the result as a wxString.
 351
 352     If the @a escape character is non-@NULL, then it's used as prefix for each
 353     occurrence of @a sep in the strings contained in @a arr before joining them
 354     which is necessary in order to be able to recover the original array
 355     contents from the string later using wxSplit().
 356
 357     @see wxSplit()
 358
 359     @header{wx/arrstr.h}
 360 */
 361 wxString wxJoin(const wxArrayString& arr, const wxChar sep,
 362                 const wxChar escape = '\\');
 363
 364 //@}
 365