X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..801d040762d0d875126935b79d660d4e2fe1b177:/docs/latex/wx/array.tex?ds=sidebyside diff --git a/docs/latex/wx/array.tex b/docs/latex/wx/array.tex index 733e548d5d..e9a534de72 100644 --- a/docs/latex/wx/array.tex +++ b/docs/latex/wx/array.tex @@ -22,7 +22,7 @@ but the price is preallocating the memory in advance. In the \helpref{memory man you may find some useful hints about optimizing wxArray memory usage. As for executable size, all wxArray functions are inline, so they do not take {\it any space at all}. -wxWindows has three different kinds of array. All of them derive from +wxWidgets has three different kinds of array. All of them derive from wxBaseArray class which works with untyped data and can not be used directly. The standard macros WX\_DEFINE\_ARRAY(), WX\_DEFINE\_SORTED\_ARRAY() and WX\_DEFINE\_OBJARRAY() are used to define a new class deriving from it. The @@ -39,14 +39,14 @@ deleted when the element is removed from the array. It should be noted that all of wxArray's functions are inline, so it costs strictly nothing to define as many array types as you want (either in terms of the executable size or the speed) as long as at least one of them is defined and this is always the case -because wxArrays are used by wxWindows internally. This class has one serious +because wxArrays are used by wxWidgets internally. This class has one serious limitation: it can only be used for storing integral types (bool, char, short, int, long and their unsigned variants) or pointers (of any kind). An attempt to use with objects of sizeof() greater than sizeof(long) will provoke a runtime assertion failure, however declaring a wxArray of floats will not (on the machines where sizeof(float) <= sizeof(long)), yet it will {\bf not} work, please use wxObjArray for storing floats and doubles (NB: a more efficient -wxArrayDouble class is scheduled for the next release of wxWindows). +wxArrayDouble class is scheduled for the next release of wxWidgets). wxSortedArray is a wxArray variant which should be used when searching in the array is a frequently used operation. It requires you to define an additional @@ -97,7 +97,7 @@ class MyDirectory // now that we have MyDirectory declaration in scope we may finish the // definition of ArrayOfDirectories -- note that this expands into some C++ // code and so should only be compiled once (i.e., don't put this in the -// header, but into a source file or you will get linkin errors) +// header, but into a source file or you will get linking errors) #include // this is a magic incantation which must be done! WX_DEFINE_OBJARRAY(ArrayOfDirectories); @@ -117,10 +117,14 @@ Things are much simpler for wxArray and wxSortedArray however: it is enough just to write \begin{verbatim} -WX_DEFINE_ARRAY(MyDirectory *, ArrayOfDirectories); -WX_DEFINE_SORTED_ARRAY(MyFile *, ArrayOfFiles); +WX_DEFINE_ARRAY(int, ArrayOfDirectories); +WX_DEFINE_SORTED_ARRAY(int, ArrayOfFiles); \end{verbatim} +i.e. there is only one {\tt DEFINE} macro and no need for separate +{\tt DECLARE} one. + + \wxheading{See also:} \helpref{Container classes overview}{wxcontaineroverview}, \helpref{wxList}{wxlist} @@ -142,10 +146,26 @@ WX\_DEFINE\_OBJARRAY macro. \helpref{WX\_DEFINE\_ARRAY}{wxdefinearray}\\ \helpref{WX\_DEFINE\_EXPORTED\_ARRAY}{wxdefinearray}\\ +\helpref{WX\_DEFINE\_USER\_EXPORTED\_ARRAY}{wxdefinearray}\\ \helpref{WX\_DEFINE\_SORTED\_ARRAY}{wxdefinesortedarray}\\ \helpref{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\ +\helpref{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY}{wxdefinesortedarray}\\ \helpref{WX\_DECLARE\_EXPORTED\_OBJARRAY}{wxdeclareobjarray}\\ -\helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray} +\helpref{WX\_DECLARE\_USER\_EXPORTED\_OBJARRAY}{wxdeclareobjarray}\\ +\helpref{WX\_DEFINE\_OBJARRAY}{wxdefineobjarray}\\ +\helpref{WX\_DEFINE\_EXPORTED\_OBJARRAY}{wxdefineobjarray}\\ +\helpref{WX\_DEFINE\_USER\_EXPORTED\_OBJARRAY}{wxdefineobjarray} + +To slightly complicate the matters even further, the operator $->$ defined by +default for the array iterators by these macros only makes sense if the array +element type is not a pointer itself and, although it still works, this +provokes warnings from some compilers and to avoid them you should use the +{\tt \_PTR} versions of the macros above. For example, to define an array of +pointers to {\tt double} you should use + +\begin{verbatim} +WX_DEFINE_ARRAY_PTR(double *, MyArrayOfDoublePointers); +\end{verbatim} \membersection{Constructors and destructors} @@ -172,7 +192,7 @@ amount, but no more than some maximal number which is defined by ARRAY\_MAXSIZE\_INCREMENT constant. Of course, this may lead to some memory being wasted (ARRAY\_MAXSIZE\_INCREMENT in the worst case, i.e. 4Kb in the current implementation), so the \helpref{Shrink()}{wxarrayshrink} function is -provided to unallocate the extra memory. The \helpref{Alloc()}{wxarrayalloc} +provided to deallocate the extra memory. The \helpref{Alloc()}{wxarrayalloc} function can also be quite useful if you know in advance how many items you are going to put in the array and will prevent the array code from reallocating the memory more times than needed. @@ -196,6 +216,7 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method. \helpref{Add}{wxarrayadd}\\ \helpref{Insert}{wxarrayinsert}\\ +\helpref{SetCount}{wxarraysetcount}\\ \helpref{WX\_APPEND\_ARRAY}{wxappendarray} \membersection{Removing items} @@ -224,9 +245,13 @@ does exactly the same as \helpref{Item()}{wxarrayitem} method. \func{}{WX\_DEFINE\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}} +\func{}{WX\_DEFINE\_USER\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}, \param{}{exportspec}} + This macro defines a new array class named {\it name} and containing the -elements of type {\it T}. The second form is used when compiling DLL -under Windows and array needs to be visible outside the DLL. +elements of type {\it T}. The second form is used when compiling wxWidgets as +a DLL under Windows and array needs to be visible outside the DLL. The third is +needed for exporting an array from a user DLL. + Example: \begin{verbatim} @@ -236,7 +261,7 @@ class MyClass; WX_DEFINE_ARRAY(MyClass *, wxArrayOfMyClass); \end{verbatim} -Note that wxWindows predefines the following standard array classes: wxArrayInt, +Note that wxWidgets predefines the following standard array classes: wxArrayInt, wxArrayLong and wxArrayPtrVoid. \membersection{WX\_DEFINE\_SORTED\_ARRAY}\label{wxdefinesortedarray} @@ -245,9 +270,12 @@ wxArrayLong and wxArrayPtrVoid. \func{}{WX\_DEFINE\_SORTED\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}} +\func{}{WX\_DEFINE\_SORTED\_USER\_EXPORTED\_ARRAY}{\param{}{T}, \param{}{name}} + This macro defines a new sorted array class named {\it name} and containing -the elements of type {\it T}. The second form is used when compiling DLL -under Windows and array needs to be visible outside the DLL. +the elements of type {\it T}. The second form is used when compiling wxWidgets as +a DLL under Windows and array needs to be visible outside the DLL. The third is +needed for exporting an array from a user DLL. Example: @@ -284,15 +312,18 @@ wxArrayOfMyClass another(CompareMyClassObjects); \func{}{WX\_DECLARE\_EXPORTED\_OBJARRAY}{\param{}{T}, \param{}{name}} +\func{}{WX\_DECLARE\_USER\_EXPORTED\_OBJARRAY}{\param{}{T}, \param{}{name}} + This macro declares a new object array class named {\it name} and containing -the elements of type {\it T}. The second form is used when compiling DLL -under Windows and array needs to be visible outside the DLL. +the elements of type {\it T}. The second form is used when compiling wxWidgets as +a DLL under Windows and array needs to be visible outside the DLL. The third is +needed for exporting an array from a user DLL. Example: \begin{verbatim} class MyClass; -WX_DEFINE_OBJARRAY(MyClass, wxArrayOfMyClass); // note: not "MyClass *"! +WX_DECLARE_OBJARRAY(MyClass, wxArrayOfMyClass); // note: not "MyClass *"! \end{verbatim} You must use \helpref{WX\_DEFINE\_OBJARRAY()}{wxdefineobjarray} macro to define @@ -302,6 +333,10 @@ the array class - otherwise you would get link errors. \func{}{WX\_DEFINE\_OBJARRAY}{\param{}{name}} +\func{}{WX\_DEFINE\_EXPORTED\_OBJARRAY}{\param{}{name}} + +\func{}{WX\_DEFINE\_USER\_EXPORTED\_OBJARRAY}{\param{}{name}} + This macro defines the methods of the array class {\it name} not defined by the \helpref{WX\_DECLARE\_OBJARRAY()}{wxdeclareobjarray} macro. You must include the file before using this macro and you must have the full @@ -309,7 +344,8 @@ declaration of the class of array elements in scope! If you forget to do the first, the error will be caught by the compiler, but, unfortunately, many compilers will not give any warnings if you forget to do the second - but the objects of the class will not be copied correctly and their real destructor will -not be called. +not be called. The latter two forms are merely aliases of the first to satisfy +some people's sense of symmetry when using the exported declarations. Example of usage: @@ -393,14 +429,14 @@ done by wxArray and wxSortedArray versions - you may use \membersection{wxArray::Add}\label{wxarrayadd} -\func{void}{Add}{\param{T }{item}} +\func{void}{Add}{\param{T }{item}, \param{size\_t}{ copies = $1$}} \func{void}{Add}{\param{T *}{item}} -\func{void}{Add}{\param{T \&}{item}} +\func{void}{Add}{\param{T \&}{item}, \param{size\_t}{ copies = $1$}} -Appends a new element to the array (where {\it T} is the type of the array -elements.) +Appends the given number of {\it copies} of the {\it item} to the array +consisting of the elements of type {\it T}. The first version is used with wxArray and wxSortedArray. The second and the third are used with wxObjArray. There is an important difference between @@ -408,10 +444,14 @@ them: if you give a pointer to the array, it will take ownership of it, i.e. will delete it when the item is deleted from the array. If you give a reference to the array, however, the array will make a copy of the item and will not take ownership of the original item. Once again, it only makes sense for wxObjArrays -because the other array types never take ownership of their elements. +because the other array types never take ownership of their elements. Also note +that you cannot append more than one pointer as reusing it would lead to +deleting it twice (or more) and hence to a crash. You may also use \helpref{WX\_APPEND\_ARRAY}{wxappendarray} macro to append all -elements of one array to another one. +elements of one array to another one but it is more efficient to use +{\it copies} parameter and modify the elements in place later if you plan to +append a lot of items. \membersection{wxArray::Alloc}\label{wxarrayalloc} @@ -461,7 +501,7 @@ Return the number of items in the array. \membersection{wxArray::Index}\label{wxarrayindex} -\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = FALSE}} +\func{int}{Index}{\param{T\& }{item}, \param{bool }{searchFromEnd = false}} \func{int}{Index}{\param{T\& }{item}} @@ -485,15 +525,15 @@ in the array. \membersection{wxArray::Insert}\label{wxarrayinsert} -\func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}} +\func{void}{Insert}{\param{T }{item}, \param{size\_t }{n}, \param{size\_t }{copies = $1$}} \func{void}{Insert}{\param{T *}{item}, \param{size\_t }{n}} -\func{void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}} +\func{void}{Insert}{\param{T \&}{item}, \param{size\_t }{n}, \param{size\_t }{copies = $1$}} -Insert a new item into the array before the item {\it n} - thus, {\it Insert(something, 0u)} will -insert an item in such way that it will become the -first array element. +Insert the given number of {\it copies} of the {\it item} into the array before +the existing item {\it n} - thus, {\it Insert(something, 0u)} will insert an +item in such way that it will become the first array element. Please see \helpref{Add()}{wxarrayadd} for explanation of the differences between the overloaded versions of this function. @@ -502,7 +542,7 @@ between the overloaded versions of this function. \constfunc{bool}{IsEmpty}{\void} -Returns TRUE if the array is empty, FALSE otherwise. +Returns true if the array is empty, false otherwise. \membersection{wxArray::Item}\label{wxarrayitem} @@ -549,13 +589,13 @@ elements of a wxArray (supposed to contain pointers). \membersection{wxArray::RemoveAt}\label{wxarrayremoveat} -\func{\void}{RemoveAt}{\param{size\_t }{index}} +\func{\void}{RemoveAt}{\param{size\_t }{index}, \param{size\_t }{count = $1$}} -Removes an element from the array by index. When an element -is removed from wxObjArray it is deleted by the array - use -\helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On the -other hand, when an object is removed from a wxArray nothing happens - you -should delete it manually if required: +Removes {\it count} elements starting at {\it index} from the array. When an +element is removed from wxObjArray it is deleted by the array - use +\helpref{Detach()}{wxobjarraydetach} if you don't want this to happen. On +the other hand, when an object is removed from a wxArray nothing happens - +you should delete it manually if required: \begin{verbatim} T *item = array[n]; @@ -566,6 +606,19 @@ array.RemoveAt(n) See also \helpref{WX\_CLEAR\_ARRAY}{wxcleararray} macro which deletes all elements of a wxArray (supposed to contain pointers). +\membersection{wxArray::SetCount}\label{wxarraysetcount} + +\func{void}{SetCount}{\param{size\_t }{count}, \param{T }{defval = T($0$)}} + +This function ensures that the number of array elements is at least +{\it count}. If the array has already {\it count} or mroe items, nothing is +done. Otherwise, {\tt count - GetCount()} elements are added and initialized to +the value {\it defval}. + +\wxheading{See also} + +\helpref{GetCount}{wxarraygetcount} + \membersection{wxArray::Shrink}\label{wxarrayshrink} \func{void}{Shrink}{\void}