don't crash if one of GetAllCommands() parameters is NULL (coverity checker CID 11)

[wxWidgets.git] / src / common / dynarray.cpp

diff --git a/src/common/dynarray.cpp b/src/common/dynarray.cpp
index e8efb32ecb06ed51d7bbcbf83ad490038ddad004..4fc0f8ce40d65314f62adfac9c873517039ce452 100644 (file)
--- a/src/common/dynarray.cpp
+++ b/src/common/dynarray.cpp
@@ -6,17 +6,13 @@
 // Created:     12.09.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     12.09.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ============================================================================
 
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ============================================================================
 

-#ifdef __GNUG__
-#pragma implementation "dynarray.h"
-#endif
-

 #include  "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include  "wx/wxprec.h"
 
 #ifdef __BORLANDC__


@@ -29,9 +25,10 @@
 #include <stdlib.h>
 #include <string.h> // for memmove
 
 #include <stdlib.h>
 #include <string.h> // for memmove
 

-#ifndef max
-  #define max(a, b)   (((a) > (b)) ? (a) : (b))
-#endif
+// we cast the value to long from which we cast it to void * in IndexForInsert:
+// this can't work if the pointers are not big enough
+wxCOMPILE_TIME_ASSERT( sizeof(wxUIntPtr) <= sizeof(void *),
+                       wxArraySizeOfPtrLessSizeOfLong ); // < 32 symbols

 
 // ============================================================================
 // constants
 
 // ============================================================================
 // constants


@@ -48,7 +45,65 @@
 // wxBaseArray - dynamic array of 'T's
 // ----------------------------------------------------------------------------
 
 // wxBaseArray - dynamic array of 'T's
 // ----------------------------------------------------------------------------
 

-#define _DECLARE_BASEARRAY(T, name)                                         \
+#define _WX_DEFINE_BASEARRAY_COMMON(T, name)                                \
+/* searches the array for an item (forward or backwards) */                 \
+int name::Index(T lItem, bool bFromEnd) const                               \
+{                                                                           \
+  if ( bFromEnd ) {                                                         \
+    if ( size() > 0 ) {                                                     \
+      size_t n = size();                                                    \
+      do {                                                                  \
+        if ( (*this)[--n] == lItem )                                        \
+          return n;                                                         \
+      }                                                                     \
+      while ( n != 0 );                                                     \
+    }                                                                       \
+  }                                                                         \
+  else {                                                                    \
+    for( size_t n = 0; n < size(); n++ ) {                                  \
+      if( (*this)[n] == lItem )                                             \
+        return n;                                                           \
+    }                                                                       \
+  }                                                                         \
+                                                                            \
+  return wxNOT_FOUND;                                                       \
+}                                                                           \
+                                                                            \
+/* add item assuming the array is sorted with fnCompare function */         \
+size_t name::Add(T lItem, CMPFUNC fnCompare)                                \
+{                                                                           \
+  size_t idx = IndexForInsert(lItem, fnCompare);                            \
+  Insert(lItem, idx);                                                       \
+  return idx;                                                               \
+}
+
+#if wxUSE_STL
+
+#define _WX_DEFINE_BASEARRAY_NOCOMMON(T, name)                              \
+size_t name::IndexForInsert(T lItem, CMPFUNC fnCompare) const               \
+{                                                                           \
+    Predicate p((SCMPFUNC)fnCompare);                                       \
+    const_iterator it = std::lower_bound(begin(), end(), lItem, p);         \
+    return it - begin();                                                    \
+}                                                                           \
+                                                                            \
+int name::Index(T lItem, CMPFUNC fnCompare) const                           \
+{                                                                           \
+    Predicate p((SCMPFUNC)fnCompare);                                       \
+    const_iterator it = std::lower_bound(begin(), end(), lItem, p);         \
+    return (it != end() && !p(lItem, *it)) ?                                \
+                             (int)(it - begin()) : wxNOT_FOUND;             \
+}                                                                           \
+                                                                            \
+void name::Shrink()                                                         \
+{                                                                           \
+    name tmp(*this);                                                        \
+    swap(tmp);                                                              \
+}
+
+#else // if !wxUSE_STL
+
+#define _WX_DEFINE_BASEARRAY_NOCOMMON(T, name)                              \

 /* ctor */                                                                  \
 name::name()                                                                \
 {                                                                           \
 /* ctor */                                                                  \
 name::name()                                                                \
 {                                                                           \


@@ -101,39 +156,76 @@ name& name::operator=(const name& src)                                      \
   return *this;                                                             \
 }                                                                           \
                                                                             \
   return *this;                                                             \
 }                                                                           \
                                                                             \

+/* allocate new buffer of the given size and move our data to it */         \
+bool name::Realloc(size_t nSize)                                            \
+{                                                                           \
+  T *pNew = new T[nSize];                                                   \
+  /* only grow if allocation succeeded */                                   \
+  if ( !pNew )                                                              \
+      return false;                                                         \
+                                                                            \
+  m_nSize = nSize;                                                          \
+  /* copy data to new location */                                           \
+  memcpy(pNew, m_pItems, m_nCount*sizeof(T));                               \
+  delete [] m_pItems;                                                       \
+  m_pItems = pNew;                                                          \
+                                                                            \
+  return true;                                                              \
+}                                                                           \
+                                                                            \

 /* grow the array */                                                        \
 /* grow the array */                                                        \

-void name::Grow()                                                           \
+void name::Grow(size_t nIncrement)                                          \

 {                                                                           \
   /* only do it if no more place */                                         \
 {                                                                           \
   /* only do it if no more place */                                         \

-  if( m_nCount == m_nSize ) {                                               \
+  if( (m_nCount == m_nSize) || ((m_nSize - m_nCount) < nIncrement) ) {      \

     if( m_nSize == 0 ) {                                                    \
     if( m_nSize == 0 ) {                                                    \

-        /* was empty, alloc some memory */                                  \
-      m_pItems = new T[WX_ARRAY_DEFAULT_INITIAL_SIZE];                      \
+      /* was empty, determine initial size */                               \
+      size_t size = WX_ARRAY_DEFAULT_INITIAL_SIZE;                          \
+      if (size < nIncrement) size = nIncrement;                             \
+      /* allocate some memory */                                            \
+      m_pItems = new T[size];                                               \

       /* only grow if allocation succeeded */                               \
       if ( m_pItems ) {                                                     \
       /* only grow if allocation succeeded */                               \
       if ( m_pItems ) {                                                     \

-          m_nSize = WX_ARRAY_DEFAULT_INITIAL_SIZE;                          \
+          m_nSize = size;                                                   \

       }                                                                     \
     }                                                                       \
     else                                                                    \
     {                                                                       \
       }                                                                     \
     }                                                                       \
     else                                                                    \
     {                                                                       \

-      /* add 50% but not too much */                                        \
-      size_t nIncrement = m_nSize < WX_ARRAY_DEFAULT_INITIAL_SIZE           \
-                         ? WX_ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1;    \
-      if ( nIncrement > ARRAY_MAXSIZE_INCREMENT )                           \
-        nIncrement = ARRAY_MAXSIZE_INCREMENT;                               \
-      T *pNew = new T[m_nSize + nIncrement];                                \
-      /* only grow if allocation succeeded */                               \
-      if ( pNew ) {                                                         \
-          m_nSize += nIncrement;                                            \
-          /* copy data to new location */                                   \
-          memcpy(pNew, m_pItems, m_nCount*sizeof(T));                       \
-          delete [] m_pItems;                                               \
-          m_pItems = pNew;                                                  \
-      }                                                                     \
+      /* add at least 50% but not too much */                               \
+      size_t ndefIncrement = m_nSize < WX_ARRAY_DEFAULT_INITIAL_SIZE        \
+                            ? WX_ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1; \
+      if ( ndefIncrement > ARRAY_MAXSIZE_INCREMENT )                        \
+        ndefIncrement = ARRAY_MAXSIZE_INCREMENT;                            \
+      if ( nIncrement < ndefIncrement )                                     \
+        nIncrement = ndefIncrement;                                         \
+      Realloc(m_nSize + nIncrement);                                        \

     }                                                                       \
   }                                                                         \
 }                                                                           \
                                                                             \
     }                                                                       \
   }                                                                         \
 }                                                                           \
                                                                             \

+/* make sure that the array has at least count elements */                  \
+void name::SetCount(size_t count, T defval)                                 \
+{                                                                           \
+    if ( m_nSize < count )                                                  \
+    {                                                                       \
+        /* need to realloc memory: don't overallocate it here as if */      \
+        /* SetCount() is called, it probably means that the caller  */      \
+        /* knows in advance how many elements there will be in the  */      \
+        /* array and so it won't be necessary to realloc it later   */      \
+        if ( !Realloc(count) )                                              \
+        {                                                                   \
+            /* out of memory -- what can we do? */                          \
+            return;                                                         \
+        }                                                                   \
+    }                                                                       \
+                                                                            \
+    /* add new elements if we extend the array */                           \
+    while ( m_nCount < count )                                              \
+    {                                                                       \
+        m_pItems[m_nCount++] = defval;                                      \
+    }                                                                       \
+}                                                                           \
+                                                                            \

 /* dtor */                                                                  \
 name::~name()                                                               \
 {                                                                           \
 /* dtor */                                                                  \
 name::~name()                                                               \
 {                                                                           \


@@ -179,31 +271,40 @@ void name::Shrink()                                                         \
         memcpy(pNew, m_pItems, m_nCount*sizeof(T));                         \
         delete [] m_pItems;                                                 \
         m_pItems = pNew;                                                    \
         memcpy(pNew, m_pItems, m_nCount*sizeof(T));                         \
         delete [] m_pItems;                                                 \
         m_pItems = pNew;                                                    \

+                                                                            \
+        /* update the size of the new block */                              \
+        m_nSize = m_nCount;                                                 \

     }                                                                       \
     }                                                                       \

+    /* else: don't do anything, better keep old memory block! */            \

   }                                                                         \
 }                                                                           \
                                                                             \
   }                                                                         \
 }                                                                           \
                                                                             \

-/* searches the array for an item (forward or backwards) */                 \
-int name::Index(T lItem, bool bFromEnd) const                               \
+/* add item at the end */                                                   \
+void name::Add(T lItem, size_t nInsert)                                     \

 {                                                                           \
 {                                                                           \

-  if ( bFromEnd ) {                                                         \
-    if ( m_nCount > 0 ) {                                                   \
-      size_t n = m_nCount;                                                  \
-      do {                                                                  \
-        if ( m_pItems[--n] == lItem )                                       \
-          return n;                                                         \
-      }                                                                     \
-      while ( n != 0 );                                                     \
-    }                                                                       \
-  }                                                                         \
-  else {                                                                    \
-    for( size_t n = 0; n < m_nCount; n++ ) {                                \
-      if( m_pItems[n] == lItem )                                            \
-        return n;                                                           \
-    }                                                                       \
-  }                                                                         \
+  if (nInsert == 0)                                                         \
+      return;                                                               \
+  Grow(nInsert);                                                            \
+  for (size_t i = 0; i < nInsert; i++)                                      \
+      m_pItems[m_nCount++] = lItem;                                         \
+}                                                                           \

                                                                             \
                                                                             \

-  return wxNOT_FOUND;                                                       \
+/* add item at the given position */                                        \
+void name::Insert(T lItem, size_t nIndex, size_t nInsert)                   \
+{                                                                           \
+  wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArray::Insert") );   \
+  wxCHECK_RET( m_nCount <= m_nCount + nInsert,                              \
+               wxT("array size overflow in wxArray::Insert") );             \
+                                                                            \
+  if (nInsert == 0)                                                         \
+      return;                                                               \
+  Grow(nInsert);                                                            \
+                                                                            \
+  memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex],                   \
+          (m_nCount - nIndex)*sizeof(T));                                   \
+  for (size_t i = 0; i < nInsert; i++)                                      \
+      m_pItems[nIndex + i] = lItem;                                         \
+  m_nCount += nInsert;                                                      \

 }                                                                           \
                                                                             \
 /* search for a place to insert item into sorted array (binary search) */   \
 }                                                                           \
                                                                             \
 /* search for a place to insert item into sorted array (binary search) */   \


@@ -217,7 +318,8 @@ size_t name::IndexForInsert(T lItem, CMPFUNC fnCompare) const               \
   while ( lo < hi ) {                                                       \
     i = (lo + hi)/2;                                                        \
                                                                             \
   while ( lo < hi ) {                                                       \
     i = (lo + hi)/2;                                                        \
                                                                             \

-    res = (*fnCompare)((const void *)&lItem, (const void *)&(m_pItems[i])); \
+    res = (*fnCompare)((const void *)(wxUIntPtr)lItem,                      \
+                       (const void *)(wxUIntPtr)(m_pItems[i]));             \

     if ( res < 0 )                                                          \
       hi = i;                                                               \
     else if ( res > 0 )                                                     \
     if ( res < 0 )                                                          \
       hi = i;                                                               \
     else if ( res > 0 )                                                     \


@@ -236,43 +338,23 @@ int name::Index(T lItem, CMPFUNC fnCompare) const                           \
 {                                                                           \
     size_t n = IndexForInsert(lItem, fnCompare);                            \
                                                                             \
 {                                                                           \
     size_t n = IndexForInsert(lItem, fnCompare);                            \
                                                                             \

-    return n < m_nCount && m_pItems[n] == lItem ? (int)n : wxNOT_FOUND;     \
-}                                                                           \
-                                                                            \
-/* add item at the end */                                                   \
-void name::Add(T lItem)                                                     \
-{                                                                           \
-  Grow();                                                                   \
-  m_pItems[m_nCount++] = lItem;                                             \
-}                                                                           \
-                                                                            \
-/* add item assuming the array is sorted with fnCompare function */         \
-void name::Add(T lItem, CMPFUNC fnCompare)                                  \
-{                                                                           \
-  Insert(lItem, IndexForInsert(lItem, fnCompare));                          \
-}                                                                           \
-                                                                            \
-/* add item at the given position */                                        \
-void name::Insert(T lItem, size_t nIndex)                                   \
-{                                                                           \
-  wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArray::Insert") );   \
-                                                                            \
-  Grow();                                                                   \
-                                                                            \
-  memmove(&m_pItems[nIndex + 1], &m_pItems[nIndex],                         \
-          (m_nCount - nIndex)*sizeof(T));                                   \
-  m_pItems[nIndex] = lItem;                                                 \
-  m_nCount++;                                                               \
+    return (n >= m_nCount ||                                                \
+           (*fnCompare)((const void *)(wxUIntPtr)lItem,                     \
+                        ((const void *)(wxUIntPtr)m_pItems[n])))            \
+                        ? wxNOT_FOUND                                       \
+                        : (int)n;                                           \

 }                                                                           \
                                                                             \
 /* removes item from array (by index) */                                    \
 }                                                                           \
                                                                             \
 /* removes item from array (by index) */                                    \

-void name::RemoveAt(size_t nIndex)                                          \
+void name::RemoveAt(size_t nIndex, size_t nRemove)                          \

 {                                                                           \
 {                                                                           \

-  wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArray::RemoveAt") ); \
+  wxCHECK_RET( nIndex < m_nCount, wxT("bad index in wxArray::RemoveAt") );  \
+  wxCHECK_RET( nIndex + nRemove <= m_nCount,                                \
+               wxT("removing too many elements in wxArray::RemoveAt") );    \

                                                                             \
                                                                             \

-  memmove(&m_pItems[nIndex], &m_pItems[nIndex + 1],                         \
-          (m_nCount - nIndex - 1)*sizeof(T));                               \
-  m_nCount--;                                                               \
+  memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove],                   \
+          (m_nCount - nIndex - nRemove)*sizeof(T));                         \
+  m_nCount -= nRemove;                                                      \

 }                                                                           \
                                                                             \
 /* removes item from array (by value) */                                    \
 }                                                                           \
                                                                             \
 /* removes item from array (by value) */                                    \


@@ -290,11 +372,169 @@ void name::Remove(T lItem)                                                  \
 void name::Sort(CMPFUNC fCmp)                                               \
 {                                                                           \
   qsort(m_pItems, m_nCount, sizeof(T), fCmp);                               \
 void name::Sort(CMPFUNC fCmp)                                               \
 {                                                                           \
   qsort(m_pItems, m_nCount, sizeof(T), fCmp);                               \

+}                                                                           \
+                                                                            \
+void name::assign(const_iterator first, const_iterator last)                \
+{                                                                           \
+  clear();                                                                  \
+  reserve(last - first);                                                    \
+  for(; first != last; ++first)                                             \
+    push_back(*first);                                                      \
+}                                                                           \
+                                                                            \
+void name::assign(size_type n, const_reference v)                           \
+{                                                                           \
+  clear();                                                                  \
+  reserve(n);                                                               \
+  for( size_type i = 0; i < n; ++i )                                        \
+    push_back(v);                                                           \
+}                                                                           \
+                                                                            \
+void name::insert(iterator it, const_iterator first, const_iterator last)   \
+{                                                                           \
+  size_t nInsert = last - first, nIndex = it - begin();                     \
+  if (nInsert == 0)                                                         \
+      return;                                                               \
+  Grow(nInsert);                                                            \
+                                                                            \
+  memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex],                   \
+          (m_nCount - nIndex)*sizeof(T));                                   \
+  for (size_t i = 0; i < nInsert; ++i, ++it, ++first)                       \
+      *it = *first;                                                         \
+  m_nCount += nInsert;                                                      \

 }
 
 }
 

-_DECLARE_BASEARRAY(void *, wxBaseArrayPtrVoid)
-_DECLARE_BASEARRAY(short,  wxBaseArrayShort)
-_DECLARE_BASEARRAY(int,    wxBaseArrayInt)
-_DECLARE_BASEARRAY(long,   wxBaseArrayLong)
-_DECLARE_BASEARRAY(double, wxBaseArrayDouble)
+#endif
+
+#define _WX_DEFINE_BASEARRAY(T, name)                                       \
+        _WX_DEFINE_BASEARRAY_COMMON(T, name)                                \
+        _WX_DEFINE_BASEARRAY_NOCOMMON(T, name)
+
+#ifdef __INTELC__
+    #pragma warning(push)
+    #pragma warning(disable: 1684)
+    #pragma warning(disable: 1572)
+#endif
+
+_WX_DEFINE_BASEARRAY(const void *, wxBaseArrayPtrVoid)
+_WX_DEFINE_BASEARRAY(short,        wxBaseArrayShort)
+_WX_DEFINE_BASEARRAY(int,          wxBaseArrayInt)
+_WX_DEFINE_BASEARRAY(long,         wxBaseArrayLong)
+_WX_DEFINE_BASEARRAY(size_t,       wxBaseArraySizeT)
+_WX_DEFINE_BASEARRAY(double,       wxBaseArrayDouble)
+
+#ifdef __INTELC__
+    #pragma warning(pop)
+#endif
+
+#if wxUSE_STL
+#include "wx/arrstr.h"
+
+#include "wx/beforestd.h"
+#include <functional>
+#include "wx/afterstd.h"
+
+_WX_DEFINE_BASEARRAY(wxString, wxBaseArrayStringBase)
+
+// some compilers (Sun CC being the only known example) distinguish between
+// extern "C" functions and the functions with C++ linkage and ptr_fun and
+// wxStringCompareLess can't take wxStrcmp/wxStricmp directly as arguments in
+// this case, we need the wrappers below to make this work
+inline int wxStrcmpCppWrapper(const wxChar *p, const wxChar *q)
+{
+    return wxStrcmp(p, q);
+}
+
+inline int wxStricmpCppWrapper(const wxChar *p, const wxChar *q)
+{
+    return wxStricmp(p, q);
+}
+
+int wxArrayString::Index(const wxChar* sz, bool bCase, bool WXUNUSED(bFromEnd)) const
+{
+    wxArrayString::const_iterator it;
+
+    if (bCase)
+    {
+        it = std::find_if(begin(), end(),
+                          std::not1(
+                              std::bind2nd(
+                                  std::ptr_fun(wxStrcmpCppWrapper), sz)));
+    }
+    else // !bCase
+    {
+        it = std::find_if(begin(), end(),
+                          std::not1(
+                              std::bind2nd(
+                                  std::ptr_fun(wxStricmpCppWrapper), sz)));
+    }

 
 

+    return it == end() ? wxNOT_FOUND : it - begin();
+}
+
+template<class F>
+class wxStringCompareLess
+{
+public:
+    wxStringCompareLess(F f) : m_f(f) { }
+    bool operator()(const wxChar* s1, const wxChar* s2)
+        { return m_f(s1, s2) < 0; }
+    bool operator()(const wxString& s1, const wxString& s2)
+        { return m_f(s1, s2) < 0; }
+private:
+    F m_f;
+};
+
+template<class F>
+wxStringCompareLess<F> wxStringCompare(F f)
+{
+    return wxStringCompareLess<F>(f);
+}
+
+void wxArrayString::Sort(CompareFunction function)
+{
+    std::sort(begin(), end(), wxStringCompare(function));
+}
+
+void wxArrayString::Sort(bool reverseOrder)
+{
+    if (reverseOrder)
+    {
+        std::sort(begin(), end(), std::greater<wxString>());
+    }
+    else
+    {
+        std::sort(begin(), end());
+    }
+}
+
+int wxSortedArrayString::Index(const wxChar* sz, bool bCase, bool WXUNUSED(bFromEnd)) const
+{
+    wxSortedArrayString::const_iterator it;
+    wxString s(sz);
+
+    if (bCase)
+        it = std::lower_bound(begin(), end(), s,
+                              wxStringCompare(wxStrcmpCppWrapper));
+    else
+        it = std::lower_bound(begin(), end(), s,
+                              wxStringCompare(wxStricmpCppWrapper));
+
+    if (it == end())
+        return wxNOT_FOUND;
+
+    if (bCase)
+    {
+        if (wxStrcmp(it->c_str(), sz) != 0)
+            return wxNOT_FOUND;
+    }
+    else
+    {
+        if (wxStricmp(it->c_str(), sz) != 0)
+            return wxNOT_FOUND;
+    }
+
+    return it - begin();
+}
+
+#endif