Minor clarification

[wxWidgets.git] / interface / arrstr.h

diff --git a/interface/arrstr.h b/interface/arrstr.h
index b60f2f332154964f45e7addb896acdcfb6b1ce3f..34652fe1448082316bacb58c84108dd88bf343d7 100644 (file)
--- a/interface/arrstr.h
+++ b/interface/arrstr.h
@@ -1,76 +1,89 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        arrstr.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        arrstr.h

-// Purpose:     documentation for wxArrayString class
+// Purpose:     interface of wxArrayString

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    @todo
+    the following functions are not documented; do they need to be?
+    WXDLLIMPEXP_BASE int wxCMPFUNC_CONV wxStringSortAscending(wxString*, wxString*);
+    WXDLLIMPEXP_BASE int wxCMPFUNC_CONV wxStringSortDescending(wxString*, wxString*);
+*/
+

 /**
     @class wxArrayString
     @wxheader{arrstr.h}
 
 /**
     @class wxArrayString
     @wxheader{arrstr.h}
 

-    wxArrayString is an efficient container for storing
-    wxString objects. It has the same features as all
-    wxArray classes, i.e. it dynamically expands when new items
-    are added to it (so it is as easy to use as a linked list), but the access
-    time to the elements is constant, instead of being linear in number of
-    elements as in the case of linked lists. It is also very size efficient and
-    doesn't take more space than a C array @e wxString[] type (wxArrayString
-    uses its knowledge of internals of wxString class to achieve this).
-
-    This class is used in the same way as other dynamic arrays,
-    except that no @e WX_DEFINE_ARRAY declaration is needed for it. When a
-    string is added or inserted in the array, a copy of the string is created, so
-    the original string may be safely deleted (e.g. if it was a @e wxChar *
-    pointer the memory it was using can be freed immediately after this). In
-    general, there is no need to worry about string memory deallocation when using
+    wxArrayString is an efficient container for storing wxString objects.
+
+    It has the same features as all wxArray classes, i.e. it dynamically expands
+    when new items are added to it (so it is as easy to use as a linked list),
+    but the access time to the elements is constant, instead of being linear in
+    number of elements as in the case of linked lists. It is also very size
+    efficient and doesn't take more space than a C array @e wxString[] type
+    (wxArrayString uses its knowledge of internals of wxString class to achieve this).
+
+    This class is used in the same way as other dynamic arrays(), except that no
+    ::WX_DEFINE_ARRAY declaration is needed for it.
+    When a string is added or inserted in the array, a copy of the string is created,
+    so the original string may be safely deleted (e.g. if it was a @e wxChar *
+    pointer the memory it was using can be freed immediately after this).
+    In general, there is no need to worry about string memory deallocation when using

     this class - it will always free the memory it uses itself.
 
     this class - it will always free the memory it uses itself.
 

-    The references returned by wxArrayString::Item,
-    wxArrayString::Last or
-    @ref wxArrayString::operatorindex operator[] are not constant, so the
-    array elements may be modified in place like this
+    The references returned by wxArrayString::Item, wxArrayString::Last or
+    wxArrayString::operator[] are not constant, so the array elements may
+    be modified in place like this:

 
     @code
     array.Last().MakeUpper();
     @endcode
 
 
     @code
     array.Last().MakeUpper();
     @endcode
 

-    There is also a variant of wxArrayString called wxSortedArrayString which has
-    exactly the same methods as wxArrayString, but which always keeps the string
-    in it in (alphabetical) order. wxSortedArrayString uses binary search in its
-    wxArrayString::Index function (instead of linear search for
-    wxArrayString::Index) which makes it much more efficient if you add strings to
-    the array rarely (because, of course, you have to pay for Index() efficiency
-    by having Add() be slower) but search for them often. Several methods should
-    not be used with sorted array (basically, all which break the order of items)
-    which is mentioned in their description.
+    @note none of the methods of wxArrayString is virtual including its
+          destructor, so this class should not be used as a base class.

 
 

-    Final word: none of the methods of wxArrayString is virtual including its
-    destructor, so this class should not be used as a base class.
+    Although this is not true strictly speaking, this class may be considered as
+    a specialization of wxArray class for the wxString member data: it is not
+    implemented like this, but it does have all of the wxArray functions.
+
+    @todo what about stl? how does it integrate?

 
     @library{wxbase}
     @category{containers}
 
 
     @library{wxbase}
     @category{containers}
 

-    @seealso
-    wxArray, wxString, @ref overview_wxstringoverview "wxString overview"
+    @see wxArray, wxString, @ref overview_string

 */
 class wxArrayString : public wxArray
 {
 public:
 */
 class wxArrayString : public wxArray
 {
 public:

-    //@{

     /**
     /**

-        Constructor from a wxString array. Pass a size @a sz and array @e arr.
+        Default constructor.

     */
     wxArrayString();
     */
     wxArrayString();

+
+    /**
+        Copy constructor.
+    */

     wxArrayString(const wxArrayString& array);
     wxArrayString(const wxArrayString& array);

+
+    //@{
+    /**
+        Constructor from a C string array. Pass a size @a sz and an array @a arr.
+    **/

     wxArrayString(size_t sz, const char** arr);
     wxArrayString(size_t sz, const wchar_t** arr);
     wxArrayString(size_t sz, const char** arr);
     wxArrayString(size_t sz, const wchar_t** arr);

-    wxArrayString(size_t sz, const wxString* arr);

     //@}
 
     /**
     //@}
 
     /**

-        Destructor frees memory occupied by the array strings. For the performance
+        Constructor from a wxString array. Pass a size @a sz and array @a arr.
+    */
+    wxArrayString(size_t sz, const wxString* arr);
+
+    /**
+        Destructor frees memory occupied by the array strings. For performance

         reasons it is not virtual, so this class should not be derived from.
     */
     ~wxArrayString();
         reasons it is not virtual, so this class should not be derived from.
     */
     ~wxArrayString();


@@ -78,11 +91,8 @@ public:
     /**
         Appends the given number of @a copies of the new item @a str to the
         array and returns the index of the first new item in the array.
     /**
         Appends the given number of @a copies of the new item @a str to the
         array and returns the index of the first new item in the array.

-        @b Warning: For sorted arrays, the index of the inserted item will not be,
-        in general, equal to GetCount() - 1 because
-        the item is inserted at the correct position to keep the array sorted and not
-        appended.
-        See also: Insert()
+
+        @see Insert()

     */
     size_t Add(const wxString& str, size_t copies = 1);
 
     */
     size_t Add(const wxString& str, size_t copies = 1);
 


@@ -90,23 +100,25 @@ public:
         Preallocates enough memory to store @a nCount items. This function may be
         used to improve array class performance before adding a known number of items
         consecutively.
         Preallocates enough memory to store @a nCount items. This function may be
         used to improve array class performance before adding a known number of items
         consecutively.

-        See also: @ref wxArray::memorymanagement "Dynamic array memory management"
+
+        @todo FIX THIS LINK
+
+        @see @ref wxArray::memorymanagement "Dynamic array memory management"

     */
     void Alloc(size_t nCount);
 
     /**
         Clears the array contents and frees memory.
     */
     void Alloc(size_t nCount);
 
     /**
         Clears the array contents and frees memory.

-        See also: Empty()
+
+        @see Empty()

     */
     void Clear();
 
     /**
     */
     void Clear();
 
     /**

-        Empties the array: after a call to this function
-        GetCount() will return 0. However, this
-        function does not free the memory used by the array and so should be used when
-        the array is going to be reused for storing other strings. Otherwise, you
-        should use Clear() to empty the array and free
-        memory.
+        Empties the array: after a call to this function GetCount() will return 0.
+        However, this function does not free the memory used by the array and so
+        should be used when the array is going to be reused for storing other strings.
+        Otherwise, you should use Clear() to empty the array and free memory.

     */
     void Empty();
 
     */
     void Empty();
 


@@ -116,57 +128,56 @@ public:
     size_t GetCount() const;
 
     /**
     size_t GetCount() const;
 
     /**

-        Search the element in the array, starting from the beginning if
-        @a bFromEnd is @false or from end otherwise. If @e bCase, comparison is
-        case sensitive (default), otherwise the case is ignored.
-        This function uses linear search for wxArrayString and binary search for
-        wxSortedArrayString, but it ignores the @a bCase and @a bFromEnd
-        parameters in the latter case.
+        Search the element in the array, starting from the beginning if @a bFromEnd
+        is @false or from end otherwise. If @a bCase, comparison is case sensitive
+        (default), otherwise the case is ignored.
+
+        This function uses linear search for wxArrayString.

         Returns index of the first item matched or @c wxNOT_FOUND if there is no match.
     */
         Returns index of the first item matched or @c wxNOT_FOUND if there is no match.
     */

-    int Index(const wxString& sz, bool bCase = true,
-              bool bFromEnd = false);
+    int Index(const wxString& sz, bool bCase = true, bool bFromEnd = false) const;

 
     /**
         Insert the given number of @a copies of the new element in the array before the
 
     /**
         Insert the given number of @a copies of the new element in the array before the

-        position @e nIndex. Thus, for
-        example, to insert the string in the beginning of the array you would write
-        
-        If @a nIndex is equal to @e GetCount() this function behaves as
-        Add().
-        @b Warning: this function should not be used with sorted arrays because it
-        could break the order of items and, for example, subsequent calls to
-        Index() would then not work!
+        position @a nIndex. Thus, for example, to insert the string in the beginning of
+        the array you would write:
+
+        @code
+        Insert("foo", 0);
+        @endcode
+
+        If @a nIndex is equal to GetCount() this function behaves as Add().

     */
     void Insert(const wxString& str, size_t nIndex,
                 size_t copies = 1);
 
     /**
         Returns @true if the array is empty, @false otherwise. This function returns the
     */
     void Insert(const wxString& str, size_t nIndex,
                 size_t copies = 1);
 
     /**
         Returns @true if the array is empty, @false otherwise. This function returns the

-        same result as @e GetCount() == 0 but is probably easier to read.
+        same result as GetCount() == 0 but is probably easier to read.

     */
     */

-    bool IsEmpty();
+    bool IsEmpty() const;

 
     /**
 
     /**

-        Return the array element at position @e nIndex. An assert failure will
+        Return the array element at position @a nIndex. An assert failure will

         result from an attempt to access an element beyond the end of array in debug
         mode, but no check is done in release mode.
         result from an attempt to access an element beyond the end of array in debug
         mode, but no check is done in release mode.

-        See also @ref operatorindex() operator[] for the operator
-        version.
+
+        @see operator[] for the operator version.

     */
     */

-    wxString Item(size_t nIndex) const;
+    wxString& Item(size_t nIndex) const;

 
     /**
         Returns the last element of the array. Attempt to access the last element of
         an empty array will result in assert failure in debug build, however no checks
         are done in release mode.
     */
 
     /**
         Returns the last element of the array. Attempt to access the last element of
         an empty array will result in assert failure in debug build, however no checks
         are done in release mode.
     */

-    wxString Last();
+    wxString& Last() const;

 
     /**
         Removes the first item matching this value. An assert failure is provoked by
         an attempt to remove an element which does not exist in debug build.
 
     /**
         Removes the first item matching this value. An assert failure is provoked by
         an attempt to remove an element which does not exist in debug build.

-        See also: Index()
+
+        @see Index()

     */
     void Remove(const wxString& sz);
 
     */
     void Remove(const wxString& sz);
 


@@ -178,23 +189,49 @@ public:
     /**
         Releases the extra memory allocated by the array. This function is useful to
         minimize the array memory consumption.
     /**
         Releases the extra memory allocated by the array. This function is useful to
         minimize the array memory consumption.

-        See also: Alloc(), @ref wxArray::memorymanagement "Dynamic array memory
+
+        @todo FIX THIS LINK
+
+        @see Alloc(), @ref wxArray::memorymanagement "Dynamic array memory

         management"
     */
     void Shrink();
 
         management"
     */
     void Shrink();
 

-    //@{
+    /**
+        Sorts the array in alphabetical order or in reverse alphabetical order if
+        @a reverseOrder is @true. The sort is case-sensitive.
+    */
+    void Sort(bool reverseOrder = false);
+

     /**
         Sorts the array using the specified @a compareFunction for item comparison.
     /**
         Sorts the array using the specified @a compareFunction for item comparison.

-        @e CompareFunction is defined as a function taking two @e const
-        wxString parameters and returning an @e int value less than, equal to or
-        greater than 0 if the first string is less than, equal to or greater than the
+        @a CompareFunction is defined as a function taking two @e const wxString
+        parameters and returning an @e int value less than, equal to or greater
+        than 0 if the first string is less than, equal to or greater than the

         second one.
         second one.

+
+        Example:
+        The following example sorts strings by their length.
+
+        @code
+        static int CompareStringLen(const wxString& first, const wxString& second)
+        {
+            return first.length() - second.length();
+        }
+
+        ...
+
+        wxArrayString array;
+
+        array.Add("one");
+        array.Add("two");
+        array.Add("three");
+        array.Add("four");
+
+        array.Sort(CompareStringLen);
+        @endcode

     */
     */

-    void Sort(bool reverseOrder = false);
-Warning:

     void Sort(CompareFunction compareFunction);
     void Sort(CompareFunction compareFunction);

-    //@}

 
     /**
         Compares 2 arrays respecting the case. Returns @true if the arrays have
 
     /**
         Compares 2 arrays respecting the case. Returns @true if the arrays have


@@ -205,7 +242,7 @@ Warning:
     /**
         Assignment operator.
     */
     /**
         Assignment operator.
     */

-    wxArrayString operator =(const wxArrayString& array);
+    wxArrayString& operator=(const wxArrayString&);

 
     /**
         Compares 2 arrays respecting the case. Returns @true only if the arrays have
 
     /**
         Compares 2 arrays respecting the case. Returns @true only if the arrays have


@@ -214,12 +251,85 @@ Warning:
     bool operator ==(const wxArrayString& array) const;
 
     /**
     bool operator ==(const wxArrayString& array) const;
 
     /**

-        Return the array element at position @e nIndex. An assert failure will
-        result from an attempt to access an element beyond the end of array in debug
-        mode, but no check is done in release mode.
-        This is the operator version of Item() method.
+        Return the array element at position @a nIndex. An assert failure will
+        result from an attempt to access an element beyond the end of array in
+        debug mode, but no check is done in release mode.
+
+        This is the operator version of the Item() method.

     */
     */

-    wxString operator[](size_t nIndex);
+    wxString& operator[](size_t nIndex) const;
+};
+
+
+/**
+    @class wxSortedArrayString
+    @wxheader{arrstr.h}
+
+    wxSortedArrayString is an efficient container for storing wxString objects
+    which always keeps the string in alphabetical order.
+
+    wxSortedArrayString uses binary search in its wxArrayString::Index() function
+    (instead of linear search for wxArrayString::Index()) which makes it much more
+    efficient if you add strings to the array rarely (because, of course, you have
+    to pay for Index() efficiency by having Add() be slower) but search for them
+    often. Several methods should not be used with sorted array (basically, all
+    those which break the order of items) which is mentioned in their description.
+
+    @todo what about STL? who does it integrates?
+
+    @library{wxbase}
+    @category{containers}
+
+    @see wxArray, wxString, @ref overview_string
+*/
+class wxSortedArrayString : public wxArrayString
+{
+public:
+
+    /**
+        Copy constructor. Note that when an array is assigned to a sorted array,
+        its contents is automatically sorted during construction.
+    */
+    wxArrayString(const wxArrayString& array);
+
+    /**
+        @copydoc wxArrayString::Add()
+
+        @warning
+        For sorted arrays, the index of the inserted item will not be, in general,
+        equal to GetCount() - 1 because the item is inserted at the correct position
+        to keep the array sorted and not appended.
+    */
+    size_t Add(const wxString& str, size_t copies = 1);
+
+
+    /**
+        @copydoc wxArrayString::Index()
+
+        This function uses binary search for wxSortedArrayString, but it ignores
+        the @a bCase and @a bFromEnd parameters.
+    */
+    int Index(const wxString& sz, bool bCase = true,
+              bool bFromEnd = false);
+
+    /**
+        @warning this function should not be used with sorted arrays because it
+                 could break the order of items and, for example, subsequent calls
+                 to Index() would then not work!
+    */
+    void Insert(const wxString& str, size_t nIndex,
+                size_t copies = 1);
+
+    //@{
+    /**
+        @warning this function should not be used with sorted array because it could
+                 break the order of items and, for example, subsequent calls to Index()
+                 would then not work! Also, sorting a wxSortedArrayString doesn't make
+                 sense because its elements are always already sorted.
+    */
+    void Sort(bool reverseOrder = false);
+    void Sort(CompareFunction compareFunction);
+    //@}

 };
 
 
 };
 
 


@@ -227,31 +337,40 @@ Warning:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

+/** @ingroup group_funcmacro_string */
+//@{
+

 /**
     Splits the given wxString object using the separator @a sep and returns the
     result as a wxArrayString.
 /**
     Splits the given wxString object using the separator @a sep and returns the
     result as a wxArrayString.

+

     If the @a escape character is non-@NULL, then the occurrences of @a sep
     If the @a escape character is non-@NULL, then the occurrences of @a sep

-    immediately prefixed
-    with @a escape are not considered as separators.
+    immediately prefixed with @a escape are not considered as separators.

     Note that empty tokens will be generated if there are two or more adjacent
     separators.
 
     Note that empty tokens will be generated if there are two or more adjacent
     separators.
 

-    @see wxJoin
+    @see wxJoin()
+
+    @header{wx/arrstr.h}

 */
 wxArrayString wxSplit(const wxString& str, const wxChar sep,
 */
 wxArrayString wxSplit(const wxString& str, const wxChar sep,

-                      const wxChar escape = '
-                                            ');
+                      const wxChar escape = '\\');

 
 /**
 
 /**

-    Concatenate all lines of the given wxArrayString object using the separator @a
-    sep and returns
-    the result as a wxString.
+    Concatenate all lines of the given wxArrayString object using the separator
+    @a sep and returns the result as a wxString.
+

     If the @a escape character is non-@NULL, then it's used as prefix for each
     If the @a escape character is non-@NULL, then it's used as prefix for each

-    occurrence of @e sep
-    in the strings contained in @a arr before joining them which is necessary
-    in order to be able to recover the original array contents from the string
-    later using wxSplit.
+    occurrence of @a sep in the strings contained in @a arr before joining them
+    which is necessary in order to be able to recover the original array
+    contents from the string later using wxSplit().
+
+    @see wxSplit()
+
+    @header{wx/arrstr.h}

 */
 wxString wxJoin(const wxArrayString& arr, const wxChar sep,
 */
 wxString wxJoin(const wxArrayString& arr, const wxChar sep,

-                const wxChar escape = '\');
+                const wxChar escape = '\\');
+
+//@}