]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dynarray.h
documented ConvertStringToArgs
[wxWidgets.git] / include / wx / dynarray.h
index cafb60d33ac4d9f8b62400cdbd5a3f70289d6e99..9a00c3a7bdc86aa2ff34aeec0a5d18ebdedade1b 100644 (file)
@@ -17,7 +17,6 @@
 #endif
 
 #include "wx/defs.h"
-#include "wx/debug.h"
 
 /** @name Dynamic arrays and object arrays (array which own their elements)
     @memo Arrays which grow on demand and do range checking (only in debug)
@@ -70,10 +69,6 @@ public:
     /// assignment operator
   wxBaseArray& operator=(const wxBaseArray& src);
     /// not virtual, see above
-    /// EXCEPT for Gnu compiler to reduce warnings...
-#ifdef __GNUG__
- virtual
-#endif
   ~wxBaseArray();
   //@}
 
@@ -123,6 +118,8 @@ protected:
   int Index(long lItem, bool bFromEnd = FALSE) const;
     /// search for an item using binary search in a sorted array
   int Index(long lItem, CMPFUNC fnCompare) const;
+    /// search for a place to insert the element into a sorted array
+  size_t IndexForInsert(long lItem, CMPFUNC fnCompare) const;
     /// add new element at the end
   void Add(long lItem);
     /// add item assuming the array is sorted with fnCompare function
@@ -165,6 +162,7 @@ private:
 //    { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
 // so using a temporary variable instead.
 // ----------------------------------------------------------------------------
+// __MAC_X__ added min ~name() below for compiling Mac X
 #define  _WX_DEFINE_ARRAY(T, name, classexp)                        \
 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2);       \
 classexp name : public wxBaseArray                                  \
@@ -177,6 +175,7 @@ public:                                                             \
     if ( type > sizelong )                                          \
       { wxFAIL_MSG( _WX_ERROR_SIZEOF ); }                           \
   }                                                                 \
+  ~name() {}                                                        \
                                                                     \
   name& operator=(const name& src)                                  \
     { wxBaseArray* temp = (wxBaseArray*) this;                      \
@@ -198,13 +197,12 @@ public:                                                             \
   void Insert(T Item, size_t uiIndex)                               \
     { wxBaseArray::Insert((long)Item, uiIndex) ; }                  \
                                                                     \
-  void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
   void RemoveAt(size_t uiIndex) { wxBaseArray::RemoveAt(uiIndex); } \
   void Remove(T Item)                                               \
     { int iIndex = Index(Item);                                     \
       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                  \
          _WX_ERROR_REMOVE);                                         \
-      wxBaseArray::Remove((size_t)iIndex); }                        \
+      wxBaseArray::RemoveAt((size_t)iIndex); }                      \
                                                                     \
   void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); }  \
 }
@@ -220,6 +218,10 @@ public:                                                             \
 //  3) it has no Sort() method because it's always sorted
 //  4) Index() method is much faster (the sorted arrays use binary search
 //     instead of linear one), but Add() is slower.
+//  5) there is no Insert() method because you can't insert an item into the
+//     given position in a sorted array but there is IndexForInsert()/AddAt()
+//     pair which may be used to optimize a common operation of "insert only if
+//     not found"
 //
 // Summary: use this class when the speed of Index() function is important, use
 // the normal arrays otherwise.
@@ -258,16 +260,22 @@ public:                                                             \
   int Index(T Item) const                                           \
     { return wxBaseArray::Index((long)Item, (CMPFUNC)m_fnCompare); }\
                                                                     \
+  size_t IndexForInsert(T Item) const                               \
+    { return wxBaseArray::IndexForInsert((long)Item,                \
+                                         (CMPFUNC)m_fnCompare); }   \
+                                                                    \
+  void AddAt(T item, size_t index)                                  \
+    { wxBaseArray::Insert((long)item, index); }                     \
+                                                                    \
   void Add(T Item)                                                  \
     { wxBaseArray::Add((long)Item, (CMPFUNC)m_fnCompare); }         \
                                                                     \
-  void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
   void RemoveAt(size_t uiIndex) { wxBaseArray::RemoveAt(uiIndex); } \
   void Remove(T Item)                                               \
     { int iIndex = Index(Item);                                     \
       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                  \
         _WX_ERROR_REMOVE );                                         \
-      wxBaseArray::Remove((size_t)iIndex); }                        \
+      wxBaseArray::RemoveAt((size_t)iIndex); }                      \
                                                                     \
 private:                                                            \
   SCMPFUNC##T m_fnCompare;                                          \
@@ -304,17 +312,18 @@ public:                                                             \
   void Insert(const T* pItem, size_t uiIndex)                       \
     { wxBaseArray::Insert((long)pItem, uiIndex); }                  \
                                                                     \
-  void Empty();                                                     \
+  void Empty() { DoEmpty(); wxBaseArray::Empty(); }                 \
+  void Clear() { DoEmpty(); wxBaseArray::Clear(); }                 \
                                                                     \
   T*   Detach(size_t uiIndex)                                       \
     { T* p = (T*)wxBaseArray::Item(uiIndex);                        \
-      wxBaseArray::Remove(uiIndex); return p; }                     \
-  void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
+      wxBaseArray::RemoveAt(uiIndex); return p; }                   \
   void RemoveAt(size_t uiIndex);                                    \
                                                                     \
   void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); }  \
                                                                     \
 private:                                                            \
+  void DoEmpty();                                                   \
   void DoCopy(const name& src);                                     \
 }
 
@@ -425,10 +434,27 @@ private:                                                            \
     typedef T _A##name;                                 \
     _WX_DEFINE_SORTED_ARRAY(_A##name, name, class WXDLLEXPORT)
 
+#define WX_DEFINE_EXPORTED_OBJARRAY(name)   WX_DEFINE_OBJARRAY(name)
 #define WX_DECLARE_EXPORTED_OBJARRAY(T, name)           \
     typedef T _L##name;                                 \
     _WX_DECLARE_OBJARRAY(_L##name, name, class WXDLLEXPORT)
 
+// ..and likewise these macros do very same thing as the ones above them too,
+// but allow the user to specify the export spec.  Needed if you have a dll
+// that wants to export a wxArray daubed with your own import/export goo.
+#define WX_DEFINE_USER_EXPORTED_ARRAY(T, name, usergoo)         \
+    typedef T _A##name;                                         \
+    _WX_DEFINE_ARRAY(_A##name, name, class usergoo)
+
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(T, name, usergoo)  \
+    typedef T _A##name;                                         \
+    _WX_DEFINE_SORTED_ARRAY(_A##name, name, class usergoo)
+
+#define WX_DEFINE_USER_EXPORTED_OBJARRAY(name)   WX_DEFINE_OBJARRAY(name)
+#define WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, usergoo)     \
+    typedef T _L##name;                                         \
+    _WX_DECLARE_OBJARRAY(_L##name, name, class usergoo)
+
 // ----------------------------------------------------------------------------
 /** @name Some commonly used predefined arrays */
 // ----------------------------------------------------------------------------
@@ -445,9 +471,19 @@ WX_DEFINE_EXPORTED_ARRAY(void *, wxArrayPtrVoid);
 //@}
 
 // -----------------------------------------------------------------------------
-// convinience macros
+// convenience macros
 // -----------------------------------------------------------------------------
 
+// append all element of one array to another one
+#define WX_APPEND_ARRAY(array, other)                                         \
+    {                                                                         \
+        size_t count = (other).Count();                                       \
+        for ( size_t n = 0; n < count; n++ )                                  \
+        {                                                                     \
+            (array).Add((other)[n]);                                          \
+        }                                                                     \
+    }
+
 // delete all array elements
 //
 // NB: the class declaration of the array elements must be visible from the
@@ -456,13 +492,13 @@ WX_DEFINE_EXPORTED_ARRAY(void *, wxArrayPtrVoid);
 //     count on it)!
 #define WX_CLEAR_ARRAY(array)                                                 \
     {                                                                         \
-        size_t count = array.Count();                                         \
+        size_t count = (array).Count();                                       \
         for ( size_t n = 0; n < count; n++ )                                  \
         {                                                                     \
-            delete array[n];                                                  \
+            delete (array)[n];                                                \
         }                                                                     \
                                                                               \
-        array.Empty();                                                        \
+        (array).Empty();                                                      \
     }
 
 #endif // _DYNARRAY_H