]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/sizer.cpp
Fixed some potential buffer overruns
[wxWidgets.git] / src / common / sizer.cpp
index cbf684cdf36453a208b720ce68952d57d8f71456..93f988572eb338ac246e4937a3d04889b3d3fa8f 100644 (file)
@@ -7,7 +7,7 @@
 // Created:
 // RCS-ID:      $Id$
 // Copyright:   (c) Robin Dunn, Robert Roebling
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #include "wx/sizer.h"
 #include "wx/utils.h"
 #include "wx/statbox.h"
-#include "wx/notebook.h"
 #include "wx/listimpl.cpp"
+#if WXWIN_COMPATIBILITY_2_4
+    #include "wx/notebook.h"
+#endif
 
 #ifdef __WXMAC__
 #   include "wx/mac/uma.h"
@@ -41,51 +43,64 @@ IMPLEMENT_CLASS(wxBoxSizer, wxSizer)
 #if wxUSE_STATBOX
 IMPLEMENT_CLASS(wxStaticBoxSizer, wxBoxSizer)
 #endif
-#if wxUSE_BOOKCTRL
-IMPLEMENT_CLASS(wxBookCtrlSizer, wxSizer)
-#if wxUSE_NOTEBOOK
-IMPLEMENT_CLASS(wxNotebookSizer, wxBookCtrlSizer)
-#endif // wxUSE_NOTEBOOK
-#endif // wxUSE_BOOKCTRL
 
 WX_DEFINE_EXPORTED_LIST( wxSizerItemList );
 
 /*
-       TODO PROPERTIES
-         sizeritem
-           object
-               object_ref
-                 minsize
-                 option
-                 flag
-                 border
+    TODO PROPERTIES
+      sizeritem
+        object
+        object_ref
+          minsize
+          option
+          flag
+          border
      spacer
-               option
-               flag
-               borfder
-       boxsizer
-          orient
+        option
+        flag
+        borfder
+    boxsizer
+       orient
     staticboxsizer
-          orient
-          label
-       gridsizer
-          rows
-          cols
-          vgap
-          hgap
-       flexgridsizer
-          rows
-          cols
-          vgap
-          hgap
-          growablerows
-          growablecols
+       orient
+       label
+    gridsizer
+       rows
+       cols
+       vgap
+       hgap
+    flexgridsizer
+       rows
+       cols
+       vgap
+       hgap
+       growablerows
+       growablecols
     minsize
 */
+
 //---------------------------------------------------------------------------
 // wxSizerItem
 //---------------------------------------------------------------------------
 
+void wxSizerItem::Init()
+{
+    m_window = NULL;
+    m_sizer = NULL;
+    m_show = true;
+    m_userData = NULL;
+    m_zoneRect = wxRect( 0, 0, 0, 0 );
+}
+
+void wxSizerItem::Init(const wxSizerFlags& flags)
+{
+    Init();
+
+    m_proportion = flags.GetProportion();
+    m_flag = flags.GetFlags();
+    m_border = flags.GetBorderInPixels();
+}
+
 wxSizerItem::wxSizerItem( int width, int height, int proportion, int flag, int border, wxObject* userData )
     : m_window( NULL )
     , m_sizer( NULL )
@@ -94,6 +109,7 @@ wxSizerItem::wxSizerItem( int width, int height, int proportion, int flag, int b
     , m_proportion( proportion )
     , m_border( border )
     , m_flag( flag )
+    , m_zoneRect( 0, 0, 0, 0 )
     , m_show( true )
     , m_userData( userData )
 {
@@ -103,13 +119,17 @@ wxSizerItem::wxSizerItem( int width, int height, int proportion, int flag, int b
 wxSizerItem::wxSizerItem( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
     : m_window( window )
     , m_sizer( NULL )
-    , m_minSize( window->GetSize() )    // minimal size is the initial size
     , m_proportion( proportion )
     , m_border( border )
     , m_flag( flag )
+    , m_zoneRect( 0, 0, 0, 0 )
     , m_show( true )
     , m_userData( userData )
 {
+    if (flag & wxFIXED_MINSIZE)
+        window->SetMinSize(window->GetSize());
+    m_minSize = window->GetSize();
+
     // aspect ratio calculated from initial size
     SetRatio( m_minSize );
 
@@ -122,6 +142,7 @@ wxSizerItem::wxSizerItem( wxSizer *sizer, int proportion, int flag, int border,
     , m_proportion( proportion )
     , m_border( border )
     , m_flag( flag )
+    , m_zoneRect( 0, 0, 0, 0 )
     , m_show( true )
     , m_ratio( 0.0 )
     , m_userData( userData )
@@ -131,15 +152,12 @@ wxSizerItem::wxSizerItem( wxSizer *sizer, int proportion, int flag, int border,
 }
 
 wxSizerItem::wxSizerItem()
-    : m_window( NULL )
-    , m_sizer( NULL )
-    , m_proportion( 0 )
-    , m_border( 0 )
-    , m_flag( 0 )
-    , m_show( true )
-    , m_ratio( 0.0 )
-    , m_userData( NULL )
 {
+    Init();
+
+    m_proportion = 0;
+    m_border = 0;
+    m_flag = 0;
 }
 
 wxSizerItem::~wxSizerItem()
@@ -181,33 +199,29 @@ wxSize wxSizerItem::GetSize() const
 
 wxSize wxSizerItem::CalcMin()
 {
-    wxSize ret;
     if (IsSizer())
     {
-        ret = m_sizer->GetMinSize();
+        m_minSize = m_sizer->GetMinSize();
 
         // if we have to preserve aspect ratio _AND_ this is
         // the first-time calculation, consider ret to be initial size
         if ((m_flag & wxSHAPED) && !m_ratio)
-            SetRatio(ret);
+            SetRatio(m_minSize);
     }
-    else
+    else if ( IsWindow() )
     {
-        if ( IsWindow() && !(m_flag & wxFIXED_MINSIZE) )
-        {
-            // Since the size of the window may change during runtime, we
-            // should use the current minimal size.  If there is a MinSize,
-            // use it, otherwise use the BestSize.
-            wxSize min  = m_window->GetMinSize();
-            wxSize best = m_window->GetBestSize();
-            if (min.x == -1) min.x =  best.x;
-            if (min.y == -1) min.y =  best.y;
-            m_minSize = min;
-        }
-
-        ret = m_minSize;
+        // Since the size of the window may change during runtime, we
+        // should use the current minimal/best size.
+        m_minSize = m_window->GetBestFittingSize();
     }
 
+    return GetMinSizeWithBorder();
+}
+
+wxSize wxSizerItem::GetMinSizeWithBorder() const
+{
+    wxSize ret = m_minSize;
+
     if (m_flag & wxWEST)
         ret.x += m_border;
     if (m_flag & wxEAST)
@@ -220,6 +234,7 @@ wxSize wxSizerItem::CalcMin()
     return ret;
 }
 
+
 void wxSizerItem::SetDimension( wxPoint pos, wxSize size )
 {
     if (m_flag & wxSHAPED)
@@ -276,6 +291,7 @@ void wxSizerItem::SetDimension( wxPoint pos, wxSize size )
     if (IsSizer())
         m_sizer->SetDimension( pos.x, pos.y, size.x, size.y );
 
+    m_zoneRect = wxRect(pos, size);
     if (IsWindow())
         m_window->SetSize( pos.x, pos.y, size.x, size.y, wxSIZE_ALLOW_MINUS_ONE );
 
@@ -346,95 +362,14 @@ wxSizer::~wxSizer()
     WX_CLEAR_LIST(wxSizerItemList, m_children);
 }
 
-void wxSizer::Add( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
-{
-    m_children.Append( new wxSizerItem( window, proportion, flag, border, userData ) );
-    window->SetContainingSizer( this );
-}
-
-void wxSizer::Add( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
-{
-    m_children.Append( new wxSizerItem( sizer, proportion, flag, border, userData ) );
-}
-
-void wxSizer::Add( int width, int height, int proportion, int flag, int border, wxObject* userData )
-{
-    m_children.Append( new wxSizerItem( width, height, proportion, flag, border, userData ) );
-}
-
-void wxSizer::Add( wxSizerItem *item )
-{
-    m_children.Append( item );
-
-    if( item->GetWindow() )
-        item->GetWindow()->SetContainingSizer( this );
-}
-
-void wxSizer::Prepend( wxWindow *window, int proportion, int flag, int border, wxObject* userData )
-{
-    m_children.Insert( new wxSizerItem( window, proportion, flag, border, userData ) );
-    window->SetContainingSizer( this );
-}
-
-void wxSizer::Prepend( wxSizer *sizer, int proportion, int flag, int border, wxObject* userData )
-{
-    m_children.Insert( new wxSizerItem( sizer, proportion, flag, border, userData ) );
-}
-
-void wxSizer::Prepend( int width, int height, int proportion, int flag, int border, wxObject* userData )
-{
-    m_children.Insert( new wxSizerItem( width, height, proportion, flag, border, userData ) );
-}
-
-void wxSizer::Prepend( wxSizerItem *item )
-{
-    m_children.Insert( item );
-
-    if( item->GetWindow() )
-        item->GetWindow()->SetContainingSizer( this );
-}
-
-void wxSizer::Insert( size_t index,
-                      wxWindow *window,
-                      int proportion,
-                      int flag,
-                      int border,
-                      wxObject* userData )
-{
-    m_children.Insert( index,
-                       new wxSizerItem( window, proportion, flag, border, userData ) );
-    window->SetContainingSizer( this );
-}
-
-void wxSizer::Insert( size_t index,
-                      wxSizer *sizer,
-                      int proportion,
-                      int flag,
-                      int border,
-                      wxObject* userData )
-{
-    m_children.Insert( index,
-                       new wxSizerItem( sizer, proportion, flag, border, userData ) );
-}
-
-void wxSizer::Insert( size_t index,
-                      int width,
-                      int height,
-                      int proportion,
-                      int flag,
-                      int border,
-                      wxObject* userData )
-{
-    m_children.Insert( index,
-                       new wxSizerItem( width, height, proportion, flag, border, userData ) );
-}
-
-void wxSizer::Insert( size_t index, wxSizerItem *item )
+wxSizerItem* wxSizer::Insert( size_t index, wxSizerItem *item )
 {
     m_children.Insert( index, item );
 
     if( item->GetWindow() )
         item->GetWindow()->SetContainingSizer( this );
+
+    return item;
 }
 
 bool wxSizer::Remove( wxWindow *window )
@@ -606,7 +541,11 @@ void wxSizer::FitInside( wxWindow *window )
 
 void wxSizer::Layout()
 {
+    // (re)calculates minimums needed for each item and other preparations
+    // for layout
     CalcMin();
+
+    // Applies the layout and repositions/resizes the items
     RecalcSizes();
 }
 
@@ -663,9 +602,9 @@ wxSize wxSizer::FitSize( wxWindow *window )
 
     // Limit the size if sizeMax != wxDefaultSize
 
-    if ( size.x > sizeMax.x && sizeMax.x != -1 )
+    if ( size.x > sizeMax.x && sizeMax.x != wxDefaultCoord )
         size.x = sizeMax.x;
-    if ( size.y > sizeMax.y && sizeMax.y != -1 )
+    if ( size.y > sizeMax.y && sizeMax.y != wxDefaultCoord )
         size.y = sizeMax.y;
 
     return size;
@@ -699,9 +638,9 @@ wxSize wxSizer::VirtualFitSize( wxWindow *window )
 
     // Limit the size if sizeMax != wxDefaultSize
 
-    if ( size.x > sizeMax.x && sizeMax.x != -1 )
+    if ( size.x > sizeMax.x && sizeMax.x != wxDefaultCoord )
         size.x = sizeMax.x;
-    if ( size.y > sizeMax.y && sizeMax.y != -1 )
+    if ( size.y > sizeMax.y && sizeMax.y != wxDefaultCoord )
         size.y = sizeMax.y;
 
     return size;
@@ -821,16 +760,16 @@ bool wxSizer::DoSetItemMinSize( size_t index, int width, int height )
     }
     else
     {
-        // ... but the minimal size of spacers and windows in stored in them
+        // ... but the minimal size of spacers and windows is stored via the item
         item->SetMinSize( width, height );
     }
 
     return true;
 }
 
-void wxSizer::Show( wxWindow *window, bool show )
+wxSizerItem* wxSizer::GetItem( wxWindow *window, bool recursive )
 {
-    wxASSERT_MSG( window, _T("Show for NULL window") );
+    wxASSERT_MSG( window, _T("GetItem for NULL window") );
 
     wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
     while (node)
@@ -839,37 +778,93 @@ void wxSizer::Show( wxWindow *window, bool show )
 
         if (item->GetWindow() == window)
         {
-            item->Show( show );
-            break;
+            return item;
+        }
+        else if (recursive && item->IsSizer())
+        {
+            wxSizerItem *subitem = item->GetSizer()->GetItem( window, true );
+            if (subitem)
+                return subitem;
         }
+
         node = node->GetNext();
     }
+
+    return NULL;
 }
 
-void wxSizer::Show( wxSizer *sizer, bool show )
+wxSizerItem* wxSizer::GetItem( wxSizer *sizer, bool recursive )
 {
-    wxASSERT_MSG( sizer, _T("Show for NULL sizer") );
+    wxASSERT_MSG( sizer, _T("GetItem for NULL sizer") );
 
     wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
     while (node)
     {
-        wxSizerItem     *item = node->GetData();
+        wxSizerItem *item = node->GetData();
 
         if (item->GetSizer() == sizer)
         {
-            item->Show( show );
-            break;
+            return item;
         }
+        else if (recursive && item->IsSizer())
+        {
+            wxSizerItem *subitem = item->GetSizer()->GetItem( sizer, true );
+            if (subitem)
+                return subitem;
+        }
+
         node = node->GetNext();
     }
+
+    return NULL;
+}
+
+wxSizerItem* wxSizer::GetItem( size_t index )
+{
+    wxCHECK_MSG( index < m_children.GetCount(),
+                 NULL,
+                 _T("GetItem index is out of range") );
+
+    return m_children.Item( index )->GetData();
+}
+
+bool wxSizer::Show( wxWindow *window, bool show, bool recursive )
+{
+    wxSizerItem *item = GetItem( window, recursive );
+
+    if ( item )
+    {
+         item->Show( show );
+         return true;
+    }
+
+    return false;
+}
+
+bool wxSizer::Show( wxSizer *sizer, bool show, bool recursive )
+{
+    wxSizerItem *item = GetItem( sizer, recursive );
+
+    if ( item )
+    {
+         item->Show( show );
+         return true;
+    }
+
+    return false;
 }
 
-void wxSizer::Show( size_t index, bool show )
+bool wxSizer::Show( size_t index, bool show)
 {
-    wxCHECK_RET( index < m_children.GetCount(),
-                 _T("Show index is out of range") );
+    wxSizerItem *item = GetItem( index );
+
+    if ( item )
+    {
+         item->Show( show );
+         return true;
+    }
 
-    m_children.Item( index )->GetData()->Show( show );
+    return false;
 }
 
 void wxSizer::ShowItems( bool show )
@@ -1042,7 +1037,7 @@ wxSize wxGridSizer::CalcMin()
 void wxGridSizer::SetItemBounds( wxSizerItem *item, int x, int y, int w, int h )
 {
     wxPoint pt( x,y );
-    wxSize sz( item->CalcMin() );
+    wxSize sz( item->GetMinSizeWithBorder() );
     int flag = item->GetFlag();
 
     if ((flag & wxEXPAND) || (flag & wxSHAPED))
@@ -1053,20 +1048,20 @@ void wxGridSizer::SetItemBounds( wxSizerItem *item, int x, int y, int w, int h )
     {
         if (flag & wxALIGN_CENTER_HORIZONTAL)
         {
-            pt.x = x + (w - sz.x - m_hgap) / 2;
+            pt.x = x + (w - sz.x) / 2;
         }
         else if (flag & wxALIGN_RIGHT)
         {
-            pt.x = x + (w - sz.x - m_hgap);
+            pt.x = x + (w - sz.x);
         }
 
         if (flag & wxALIGN_CENTER_VERTICAL)
         {
-            pt.y = y + (h - sz.y - m_vgap) / 2;
+            pt.y = y + (h - sz.y) / 2;
         }
         else if (flag & wxALIGN_BOTTOM)
         {
-            pt.y = y + (h - sz.y - m_vgap);
+            pt.y = y + (h - sz.y);
         }
     }
 
@@ -1103,9 +1098,8 @@ void wxFlexGridSizer::RecalcSizes()
 
     wxPoint pt( GetPosition() );
     wxSize sz( GetSize() );
-    wxSize minsz( CalcMin() );
 
-    AdjustForGrowables(sz, minsz, nrows, ncols);
+    AdjustForGrowables(sz, m_calculatedMinSize, nrows, ncols);
 
     sz = wxSize( pt.x + sz.x, pt.y + sz.y );
 
@@ -1177,7 +1171,7 @@ wxSize wxFlexGridSizer::CalcMin()
     }
 
     AdjustForFlexDirection();
-    
+
     // Sum total minimum size, including gaps between rows/columns.
     // -1 is used as a magic number meaning empty column.
     int width = 0;
@@ -1190,7 +1184,8 @@ wxSize wxFlexGridSizer::CalcMin()
         if ( m_rowHeights[ row ] != -1 )
             height += m_rowHeights[ row ] + ( row == nrows-1 ? 0 : m_vgap );
 
-    return wxSize( width, height );
+    m_calculatedMinSize = wxSize( width, height );
+    return m_calculatedMinSize;
 }
 
 void wxFlexGridSizer::AdjustForFlexDirection()
@@ -1220,7 +1215,7 @@ void wxFlexGridSizer::AdjustForFlexDirection()
             array[n] = largest;
         }
     }
-}    
+}
 
 
 void wxFlexGridSizer::AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
@@ -1240,7 +1235,7 @@ void wxFlexGridSizer::AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
             // requested growable rows/columns are still valid.
             if (m_growableRows[idx] >= nrows)
                 continue;
-            
+
             // If all items in a row/column are hidden, that row/column will
             // have a dimension of -1.  This causes the row/column to be
             // hidden completely.
@@ -1292,7 +1287,7 @@ void wxFlexGridSizer::AdjustForGrowables(const wxSize& sz, const wxSize& minsz,
             // requested growable rows/columns are still valid.
             if (m_growableCols[idx] >= ncols)
                 continue;
-            
+
             // If all items in a row/column are hidden, that row/column will
             // have a dimension of -1.  This causes the column to be hidden
             // completely.
@@ -1385,7 +1380,7 @@ void wxBoxSizer::RecalcSizes()
 
         if (item->IsShown())
         {
-            wxSize size( item->CalcMin() );
+            wxSize size( item->GetMinSizeWithBorder() );
 
             if (m_orient == wxVERTICAL)
             {
@@ -1398,7 +1393,7 @@ void wxBoxSizer::RecalcSizes()
                 }
 
                 wxPoint child_pos( pt );
-                wxSize  child_size( wxSize( size.x, height) );
+                wxSize  child_size( size.x, height );
 
                 if (item->GetFlag() & (wxEXPAND | wxSHAPED))
                     child_size.x = m_size.x;
@@ -1424,7 +1419,7 @@ void wxBoxSizer::RecalcSizes()
                 }
 
                 wxPoint child_pos( pt );
-                wxSize  child_size( wxSize(width, size.y) );
+                wxSize  child_size( width, size.y );
 
                 if (item->GetFlag() & (wxEXPAND | wxSHAPED))
                     child_size.y = m_size.y;
@@ -1456,11 +1451,15 @@ wxSize wxBoxSizer::CalcMin()
     m_fixedWidth = 0;
     m_fixedHeight = 0;
 
+    // precalc item minsizes and count proportions
     wxSizerItemList::compatibility_iterator node = m_children.GetFirst();
     while (node)
     {
         wxSizerItem *item = node->GetData();
 
+        if (item->IsShown())
+            item->CalcMin();  // result is stored in the item
+
         if (item->IsShown() && item->GetProportion() != 0)
             m_stretchable += item->GetProportion();
 
@@ -1478,9 +1477,9 @@ wxSize wxBoxSizer::CalcMin()
         if (item->IsShown() && item->GetProportion() != 0)
         {
             int stretch = item->GetProportion();
-            wxSize size( item->CalcMin() );
+            wxSize size( item->GetMinSizeWithBorder() );
             int minSize;
-            
+
             // Integer division rounded up is (a + b - 1) / b
             // Round up needed in order to guarantee that all
             // all items will have size not less then their min size
@@ -1488,7 +1487,7 @@ wxSize wxBoxSizer::CalcMin()
                 minSize = ( size.x*m_stretchable + stretch - 1)/stretch;
             else
                 minSize = ( size.y*m_stretchable + stretch - 1)/stretch;
-            
+
             if (minSize > maxMinSize)
                 maxMinSize = minSize;
         }
@@ -1503,7 +1502,7 @@ wxSize wxBoxSizer::CalcMin()
 
         if (item->IsShown())
         {
-            wxSize size( item->CalcMin() );
+            wxSize size( item->GetMinSizeWithBorder() );
             if (item->GetProportion() != 0)
             {
                 if (m_orient == wxHORIZONTAL)
@@ -1580,7 +1579,7 @@ static void GetStaticBoxBorders( wxStaticBox *box,
             // pixels (otherwise overlapping occurs at the top). The "other"
             // border has to be 11.
             extraTop = 11;
-            other = 11; 
+            other = 11;
         }
 
     }
@@ -1590,7 +1589,7 @@ static void GetStaticBoxBorders( wxStaticBox *box,
 
 #else
 #ifdef __WXGTK__
-    if ( box->GetLabel().IsEmpty() )
+    if ( box->GetLabel().empty() )
         *borderTop = 5;
     else
 #endif // __WXGTK__
@@ -1640,13 +1639,23 @@ void wxStaticBoxSizer::ShowItems( bool show )
 
 #endif // wxUSE_STATBOX
 
+
+#if WXWIN_COMPATIBILITY_2_4
+
 // ----------------------------------------------------------------------------
 // wxNotebookSizer
 // ----------------------------------------------------------------------------
 
 #if wxUSE_BOOKCTRL
+IMPLEMENT_CLASS(wxBookCtrlSizer, wxSizer)
+#if wxUSE_NOTEBOOK
+IMPLEMENT_CLASS(wxNotebookSizer, wxBookCtrlSizer)
+#endif // wxUSE_NOTEBOOK
+#endif // wxUSE_BOOKCTRL
 
-wxBookCtrlSizer::wxBookCtrlSizer(wxBookCtrl *bookctrl)
+#if wxUSE_BOOKCTRL
+
+wxBookCtrlSizer::wxBookCtrlSizer(wxBookCtrlBase *bookctrl)
                : m_bookctrl(bookctrl)
 {
     wxASSERT_MSG( bookctrl, wxT("wxBookCtrlSizer needs a control") );
@@ -1695,14 +1704,15 @@ wxSize wxBookCtrlSizer::CalcMin()
     return wxSize( maxX, maxY ) + sizeBorder;
 }
 
-
 #if wxUSE_NOTEBOOK
 
 wxNotebookSizer::wxNotebookSizer(wxNotebook *nb)
-    : wxBookCtrlSizer(nb)
 {
+    wxASSERT_MSG( nb, wxT("wxNotebookSizer needs a control") );
+    m_bookctrl = nb;
 }
 
 #endif // wxUSE_NOTEBOOOK
 #endif // wxUSE_BOOKCTRL
 
+#endif // WXWIN_COMPATIBILITY_2_4