]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dynarray.h
test
[wxWidgets.git] / include / wx / dynarray.h
index caf4b814d1e2241ee043022b7e205381c11e912a..fc49a0f260c5399e89f6f0b6d34e712352b05293 100644 (file)
  callback compare function for quick sort
  must return negative value, 0 or positive value if pItem1 <, = or > pItem2
  */
-
-#if defined(__VISUALC__)
-  #define   CMPFUNC_CONV    _cdecl
-#elif defined(__VISAGECPP__)
-  #define   CMPFUNC_CONV    _Optlink
-#else   // !Visual C++
-  #define   CMPFUNC_CONV
-#endif  // compiler
-typedef int (CMPFUNC_CONV *CMPFUNC)(const void* pItem1, const void* pItem2);
+typedef int (wxCMPFUNC_CONV *CMPFUNC)(const void* pItem1, const void* pItem2);
 
 // ----------------------------------------------------------------------------
 /**
@@ -140,7 +132,7 @@ protected:
     /// remove first item matching this value
   void Remove(long lItem);
     /// remove item by index
-  void Remove(size_t uiIndex);
+  void RemoveAt(size_t uiIndex);
   //@}
 
   /// sort array elements using given compare function
@@ -159,6 +151,11 @@ private:
 // template classes
 // ============================================================================
 
+// resolves the name conflict between the wxT() macor and T typedef: we can't
+// use wxT() inside WX_DEFINE_ARRAY!
+#define _WX_ERROR_SIZEOF   wxT("illegal use of DEFINE_ARRAY")
+#define _WX_ERROR_REMOVE   wxT("removing inexisting element in wxArray::Remove")
+
 // ----------------------------------------------------------------------------
 // This macro generates a new array class. It is intended for storage of simple
 // types of sizeof()<=sizeof(long) or pointers if sizeof(pointer)<=sizeof(long)
@@ -168,9 +165,9 @@ private:
 //    { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
 // so using a temporary variable instead.
 // ----------------------------------------------------------------------------
-#define  _WX_DEFINE_ARRAY(T, name)                                  \
+#define  _WX_DEFINE_ARRAY(T, name, classexp)                        \
 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2);       \
-class WXDLLEXPORT name : public wxBaseArray                         \
+classexp name : public wxBaseArray                                  \
 {                                                                   \
 public:                                                             \
   name()                                                            \
@@ -178,7 +175,7 @@ public:                                                             \
     size_t type = sizeof(T);                                        \
     size_t sizelong = sizeof(long);                                 \
     if ( type > sizelong )                                          \
-      { wxFAIL_MSG( _T("illegal use of DEFINE_ARRAY") ); }          \
+      { wxFAIL_MSG( _WX_ERROR_SIZEOF ); }                           \
   }                                                                 \
                                                                     \
   name& operator=(const name& src)                                  \
@@ -201,12 +198,13 @@ public:                                                             \
   void Insert(T Item, size_t uiIndex)                               \
     { wxBaseArray::Insert((long)Item, uiIndex) ; }                  \
                                                                     \
-  void Remove(size_t uiIndex) { wxBaseArray::Remove(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,                  \
-        _T("removing inexisting element in wxArray::Remove") );     \
-      wxBaseArray::Remove((size_t)iIndex); }                        \
+         _WX_ERROR_REMOVE);                                         \
+      wxBaseArray::RemoveAt((size_t)iIndex); }                      \
                                                                     \
   void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); }  \
 }
@@ -231,16 +229,16 @@ public:                                                             \
 //    { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
 // so using a temporary variable instead.
 // ----------------------------------------------------------------------------
-#define  _WX_DEFINE_SORTED_ARRAY(T, name)                           \
+#define  _WX_DEFINE_SORTED_ARRAY(T, name, classexp)                 \
 typedef int (CMPFUNC_CONV *SCMPFUNC##T)(T pItem1, T pItem2);        \
-class WXDLLEXPORT name : public wxBaseArray                         \
+classexp name : public wxBaseArray                                  \
 {                                                                   \
 public:                                                             \
   name(SCMPFUNC##T fn)                                              \
   { size_t type = sizeof(T);                                        \
     size_t sizelong = sizeof(long);                                 \
     if ( type > sizelong )                                          \
-      { wxFAIL_MSG( _T("illegal use of DEFINE_ARRAY") ); }          \
+      { wxFAIL_MSG( _WX_ERROR_SIZEOF ); }                           \
     m_fnCompare = fn;                                               \
   }                                                                 \
                                                                     \
@@ -263,12 +261,13 @@ public:                                                             \
   void Add(T Item)                                                  \
     { wxBaseArray::Add((long)Item, (CMPFUNC)m_fnCompare); }         \
                                                                     \
-  void Remove(size_t uiIndex) { wxBaseArray::Remove(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,                  \
-        _T("removing inexisting element in wxArray::Remove") );     \
-      wxBaseArray::Remove((size_t)iIndex); }                        \
+        _WX_ERROR_REMOVE );                                         \
+      wxBaseArray::RemoveAt((size_t)iIndex); }                      \
                                                                     \
 private:                                                            \
   SCMPFUNC##T m_fnCompare;                                          \
@@ -277,9 +276,9 @@ private:                                                            \
 // ----------------------------------------------------------------------------
 // see WX_DECLARE_OBJARRAY and WX_DEFINE_OBJARRAY
 // ----------------------------------------------------------------------------
-#define _WX_DECLARE_OBJARRAY(T, name)                               \
+#define _WX_DECLARE_OBJARRAY(T, name, classexp)                     \
 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T** pItem1, T** pItem2);     \
-class WXDLLEXPORT name : public wxBaseArray                         \
+classexp name : public wxBaseArray                                  \
 {                                                                   \
 public:                                                             \
   name() { }                                                        \
@@ -309,8 +308,9 @@ public:                                                             \
                                                                     \
   T*   Detach(size_t uiIndex)                                       \
     { T* p = (T*)wxBaseArray::Item(uiIndex);                        \
-      wxBaseArray::Remove(uiIndex); return p; }                     \
-  void Remove(size_t uiIndex);                                      \
+      wxBaseArray::RemoveAt(uiIndex); return p; }                   \
+  void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
+  void RemoveAt(size_t uiIndex);                                    \
                                                                     \
   void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); }  \
                                                                     \
@@ -343,15 +343,17 @@ private:                                                            \
 
    @memo declare and define array class 'name' containing elements of type 'T'
   */
-#define WX_DEFINE_ARRAY(T, name)  typedef T _A##name;                        \
-                                  _WX_DEFINE_ARRAY(_A##name, name)
+#define WX_DEFINE_ARRAY(T, name)                \
+    typedef T _A##name;                         \
+    _WX_DEFINE_ARRAY(_A##name, name, class)
 
   /**
    This macro does the same as WX_DEFINE_ARRAY except that the array will be
    sorted with the specified compare function.
    */
-#define WX_DEFINE_SORTED_ARRAY(T, name)  typedef T _A##name;                 \
-                                  _WX_DEFINE_SORTED_ARRAY(_A##name, name)
+#define WX_DEFINE_SORTED_ARRAY(T, name)             \
+    typedef T _A##name;                             \
+    _WX_DEFINE_SORTED_ARRAY(_A##name, name, class)
 
   /**
    This macro generates a new objarrays class which owns the objects it
@@ -388,8 +390,10 @@ private:                                                            \
 
    @memo declare objarray class 'name' containing elements of type 'T'
   */
-#define WX_DECLARE_OBJARRAY(T, name)  typedef T _L##name;                 \
-                                      _WX_DECLARE_OBJARRAY(_L##name, name)
+#define WX_DECLARE_OBJARRAY(T, name)            \
+    typedef T _L##name;                         \
+    _WX_DECLARE_OBJARRAY(_L##name, name, class)
+
   /**
     To use an objarray class you must
     <ll>
@@ -410,18 +414,32 @@ private:                                                            \
 #define WX_DEFINE_OBJARRAY(name)       "don't forget to include arrimpl.cpp!"
 //@}
 
+// these macros do the same thing as the WX_XXX ones above, but should be used
+// inside the library for user visible classes because otherwise they wouldn't
+// be visible from outside (when using wxWindows as DLL under Windows)
+#define WX_DEFINE_EXPORTED_ARRAY(T, name)               \
+    typedef T _A##name;                                 \
+    _WX_DEFINE_ARRAY(_A##name, name, class WXDLLEXPORT)
+
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY(T, name)        \
+    typedef T _A##name;                                 \
+    _WX_DEFINE_SORTED_ARRAY(_A##name, name, class WXDLLEXPORT)
+
+#define WX_DECLARE_EXPORTED_OBJARRAY(T, name)           \
+    typedef T _L##name;                                 \
+    _WX_DECLARE_OBJARRAY(_L##name, name, class WXDLLEXPORT)
+
 // ----------------------------------------------------------------------------
 /** @name Some commonly used predefined arrays */
-// # overhead if not used?
 // ----------------------------------------------------------------------------
 
 //@{
   /** @name ArrayInt */
-WX_DEFINE_ARRAY(int,    wxArrayInt);
+WX_DEFINE_EXPORTED_ARRAY(int, wxArrayInt);
   /** @name ArrayLong */
-WX_DEFINE_ARRAY(long,   wxArrayLong);
+WX_DEFINE_EXPORTED_ARRAY(long, wxArrayLong);
   /** @name ArrayPtrVoid */
-WX_DEFINE_ARRAY(void *, wxArrayPtrVoid);
+WX_DEFINE_EXPORTED_ARRAY(void *, wxArrayPtrVoid);
 //@}
 
 //@}
@@ -446,5 +464,6 @@ WX_DEFINE_ARRAY(void *, wxArrayPtrVoid);
                                                                               \
         array.Empty();                                                        \
     }
+
 #endif // _DYNARRAY_H