Guard against comparing invalid iterators, which produces an assertion

[wxWidgets.git] / src / generic / splitter.cpp

diff --git a/src/generic/splitter.cpp b/src/generic/splitter.cpp
index 4269063c1d7a14f4d835476b613af11816a760e5..5ba2ae92b875939132c8fafa3cbba992d98eaeca 100644 (file)
--- a/src/generic/splitter.cpp
+++ b/src/generic/splitter.cpp
@@ -9,24 +9,23 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "splitter.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 

-#if wxUSE_SPLITTER
-

 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 

+#if wxUSE_SPLITTER
+
+#include "wx/splitter.h"
+

 #ifndef WX_PRECOMP
     #include "wx/string.h"
     #include "wx/utils.h"
     #include "wx/log.h"
 
 #ifndef WX_PRECOMP
     #include "wx/string.h"
     #include "wx/utils.h"
     #include "wx/log.h"
 

+    #include "wx/dcclient.h"

     #include "wx/dcscreen.h"
 
     #include "wx/window.h"
     #include "wx/dcscreen.h"
 
     #include "wx/window.h"


@@ -38,8 +37,6 @@
 
 #include "wx/renderer.h"
 
 
 #include "wx/renderer.h"
 

-#include "wx/splitter.h"
-

 #include <stdlib.h>
 
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED)
 #include <stdlib.h>
 
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED)


@@ -50,12 +47,12 @@ DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_UNSPLIT)
 IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow)
 
 /*
 IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow)
 
 /*

-       TODO PROPERTIES
-               style wxSP_3D
-               sashpos (long , 0 )
-               minsize (long -1 )
-               object, object_ref
-               orientation
+    TODO PROPERTIES
+        style wxSP_3D
+        sashpos (long , 0 )
+        minsize (long -1 )
+        object, object_ref
+        orientation

 */
 
 IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxNotifyEvent)
 */
 
 IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxNotifyEvent)


@@ -72,7 +69,7 @@ BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow)
     WX_EVENT_TABLE_CONTROL_CONTAINER(wxSplitterWindow)
 END_EVENT_TABLE()
 
     WX_EVENT_TABLE_CONTROL_CONTAINER(wxSplitterWindow)
 END_EVENT_TABLE()
 

-WX_DELEGATE_TO_CONTROL_CONTAINER(wxSplitterWindow);
+WX_DELEGATE_TO_CONTROL_CONTAINER(wxSplitterWindow)

 
 bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
                                    const wxPoint& pos,
 
 bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
                                    const wxPoint& pos,


@@ -90,8 +87,21 @@ bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
         return false;
 
     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
         return false;
 

+    if (size.x >= 0)
+        m_lastSize.x = size.x;
+    if (size.y >= 0)
+        m_lastSize.y = size.y;
+    

     m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
 
     m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
 

+    // FIXME: with this line the background is not erased at all under GTK1,
+    //        so temporary avoid it there
+#if !defined(__WXGTK__) || defined(__WXGTK20__)
+    // don't erase the splitter background, it's pointless as we overwrite it
+    // anyhow
+    SetBackgroundStyle(wxBG_STYLE_CUSTOM);
+#endif
+

     return true;
 }
 
     return true;
 }
 


@@ -109,6 +119,9 @@ void wxSplitterWindow::Init()
     m_firstX = 0;
     m_firstY = 0;
     m_sashPosition = m_requestedSashPosition = 0;
     m_firstX = 0;
     m_firstY = 0;
     m_sashPosition = m_requestedSashPosition = 0;

+    m_sashGravity = 0.0;
+    m_sashSize = -1; // -1 means use the native sash size
+    m_lastSize = wxSize(0,0);

     m_checkRequestedSashPosition = false;
     m_minimumPaneSize = 0;
     m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);
     m_checkRequestedSashPosition = false;
     m_minimumPaneSize = 0;
     m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);


@@ -183,7 +196,7 @@ void wxSplitterWindow::OnInternalIdle()
         SizeWindows();
         return; // it won't needUpdating in this case
     }
         SizeWindows();
         return; // it won't needUpdating in this case
     }

-    
+

     if (m_needUpdating)
         SizeWindows();
 }
     if (m_needUpdating)
         SizeWindows();
 }


@@ -200,15 +213,18 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
     // following the mouse movement while it drags the sash, without it we only
     // draw the sash at the new position but only resize the windows when the
     // dragging is finished
     // following the mouse movement while it drags the sash, without it we only
     // draw the sash at the new position but only resize the windows when the
     // dragging is finished

+#if defined( __WXMAC__ ) && TARGET_API_MAC_OSX == 1
+    bool isLive = true ;
+#else

     bool isLive = (GetWindowStyleFlag() & wxSP_LIVE_UPDATE) != 0;
     bool isLive = (GetWindowStyleFlag() & wxSP_LIVE_UPDATE) != 0;

-
+#endif

     if (event.LeftDown())
     {
         if ( SashHitTest(x, y) )
         {
             // Start the drag now
             m_dragMode = wxSPLIT_DRAG_DRAGGING;
     if (event.LeftDown())
     {
         if ( SashHitTest(x, y) )
         {
             // Start the drag now
             m_dragMode = wxSPLIT_DRAG_DRAGGING;

-            
+

             // Capture mouse and set the cursor
             CaptureMouse();
             SetResizeCursor();
             // Capture mouse and set the cursor
             CaptureMouse();
             SetResizeCursor();


@@ -233,7 +249,7 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
     {
         // We can stop dragging now and see what we've got.
         m_dragMode = wxSPLIT_DRAG_NONE;
     {
         // We can stop dragging now and see what we've got.
         m_dragMode = wxSPLIT_DRAG_NONE;

-        
+

         // Release mouse and unset the cursor
         ReleaseMouse();
         SetCursor(* wxSTANDARD_CURSOR);
         // Release mouse and unset the cursor
         ReleaseMouse();
         SetCursor(* wxSTANDARD_CURSOR);


@@ -273,9 +289,9 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
                 m_windowOne = m_windowTwo;
                 m_windowTwo = (wxWindow *) NULL;
                 OnUnsplit(removedWindow);
                 m_windowOne = m_windowTwo;
                 m_windowTwo = (wxWindow *) NULL;
                 OnUnsplit(removedWindow);

-                wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
-                event.m_data.win = removedWindow;
-                (void)DoSendEvent(event);
+                wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
+                eventUnsplit.m_data.win = removedWindow;
+                (void)DoSendEvent(eventUnsplit);

                 SetSashPositionAndNotify(0);
             }
             else if ( posSashNew == GetWindowSize() )
                 SetSashPositionAndNotify(0);
             }
             else if ( posSashNew == GetWindowSize() )


@@ -284,9 +300,9 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
                 wxWindow *removedWindow = m_windowTwo;
                 m_windowTwo = (wxWindow *) NULL;
                 OnUnsplit(removedWindow);
                 wxWindow *removedWindow = m_windowTwo;
                 m_windowTwo = (wxWindow *) NULL;
                 OnUnsplit(removedWindow);

-                wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
-                event.m_data.win = removedWindow;
-                (void)DoSendEvent(event);
+                wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
+                eventUnsplit.m_data.win = removedWindow;
+                (void)DoSendEvent(eventUnsplit);

                 SetSashPositionAndNotify(0);
             }
             else
                 SetSashPositionAndNotify(0);
             }
             else


@@ -365,7 +381,7 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
         }
         else
         {
         }
         else
         {

-            SetSashPositionAndNotify(posSashNew);
+            DoSetSashPosition(posSashNew);

             m_needUpdating = true;
         }
     }
             m_needUpdating = true;
         }
     }


@@ -397,6 +413,8 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event)
 
     if ( iconized )
     {
 
     if ( iconized )
     {

+        m_lastSize = wxSize(0,0);
+

         event.Skip();
 
         return;
         event.Skip();
 
         return;


@@ -408,13 +426,36 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event)
         GetClientSize(&w, &h);
 
         int size = m_splitMode == wxSPLIT_VERTICAL ? w : h;
         GetClientSize(&w, &h);
 
         int size = m_splitMode == wxSPLIT_VERTICAL ? w : h;

+
+        int old_size = m_splitMode == wxSPLIT_VERTICAL ? m_lastSize.x : m_lastSize.y;
+        if ( old_size != 0 )
+        {
+            int delta = (int) ( (size - old_size)*m_sashGravity );
+            if ( delta != 0 )
+            {
+                int newPosition = m_sashPosition + delta;
+                if( newPosition < m_minimumPaneSize )
+                    newPosition = m_minimumPaneSize;
+                SetSashPositionAndNotify(newPosition);
+            }
+        }
+

         if ( m_sashPosition >= size - 5 )
             SetSashPositionAndNotify(wxMax(10, size - 40));
         if ( m_sashPosition >= size - 5 )
             SetSashPositionAndNotify(wxMax(10, size - 40));

+        m_lastSize = wxSize(w,h);

     }
 
     SizeWindows();
 }
 
     }
 
     SizeWindows();
 }
 

+void wxSplitterWindow::SetSashGravity(double gravity)
+{
+    wxCHECK_RET( gravity >= 0. && gravity <= 1.,
+                    _T("invalid gravity value") );
+
+    m_sashGravity = gravity;
+}
+

 bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
 {
     if ( m_windowTwo == NULL || m_sashPosition == 0)
 bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
 {
     if ( m_windowTwo == NULL || m_sashPosition == 0)


@@ -423,13 +464,13 @@ bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
     int z = m_splitMode == wxSPLIT_VERTICAL ? x : y;
     int hitMin = m_sashPosition - tolerance;
     int hitMax = m_sashPosition + GetSashSize() + tolerance;
     int z = m_splitMode == wxSPLIT_VERTICAL ? x : y;
     int hitMin = m_sashPosition - tolerance;
     int hitMax = m_sashPosition + GetSashSize() + tolerance;

-    
+

     return z >=  hitMin && z <= hitMax;
 }
 
 int wxSplitterWindow::GetSashSize() const
 {
     return z >=  hitMin && z <= hitMax;
 }
 
 int wxSplitterWindow::GetSashSize() const
 {

-    return wxRendererNative::Get().GetSplitterParams(this).widthSash;
+    return m_sashSize > -1 ? m_sashSize : wxRendererNative::Get().GetSplitterParams(this).widthSash;

 }
 
 int wxSplitterWindow::GetBorderSize() const
 }
 
 int wxSplitterWindow::GetBorderSize() const


@@ -464,7 +505,7 @@ void wxSplitterWindow::DrawSash(wxDC& dc)
                                 m_sashPosition,
                                 m_splitMode == wxSPLIT_VERTICAL ? wxVERTICAL
                                                                 : wxHORIZONTAL,
                                 m_sashPosition,
                                 m_splitMode == wxSPLIT_VERTICAL ? wxVERTICAL
                                                                 : wxHORIZONTAL,

-                                m_isHot ? wxCONTROL_CURRENT : 0
+                                m_isHot ? (int)wxCONTROL_CURRENT : 0

                             );
 }
 
                             );
 }
 


@@ -530,8 +571,6 @@ int wxSplitterWindow::GetWindowSize() const
 
 int wxSplitterWindow::AdjustSashPosition(int sashPos) const
 {
 
 int wxSplitterWindow::AdjustSashPosition(int sashPos) const
 {

-    int window_size = GetWindowSize();
-

     wxWindow *win;
 
     win = GetWindow1();
     wxWindow *win;
 
     win = GetWindow1();


@@ -560,8 +599,8 @@ int wxSplitterWindow::AdjustSashPosition(int sashPos) const
         if ( minSize == -1 || m_minimumPaneSize > minSize )
             minSize = m_minimumPaneSize;
 
         if ( minSize == -1 || m_minimumPaneSize > minSize )
             minSize = m_minimumPaneSize;
 

-        int maxSize = window_size - minSize - GetBorderSize();
-        if ( sashPos > maxSize )
+        int maxSize = GetWindowSize() - minSize - GetBorderSize() - GetSashSize();
+        if ( maxSize > 0 && sashPos > maxSize )

             sashPos = maxSize;
     }
 
             sashPos = maxSize;
     }
 


@@ -582,13 +621,21 @@ bool wxSplitterWindow::DoSetSashPosition(int sashPos)
 
 void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
 {
 
 void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
 {

-    if ( DoSetSashPosition(sashPos) )
-    {
-        wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this);
-        event.m_data.pos = m_sashPosition;
+    // we must reset the request here, otherwise the sash would be stuck at
+    // old position if the user attempted to move the sash after invalid
+    // (e.g. smaller than minsize) sash position was requested using
+    // SetSashPosition():
+    m_requestedSashPosition = INT_MAX;

 
 

-        (void)DoSendEvent(event);
-    }
+    // note that we must send the event in any case, i.e. even if the sash
+    // position hasn't changed and DoSetSashPosition() returns false because we
+    // must generate a CHANGED event at the end of resizing
+    DoSetSashPosition(sashPos);
+
+    wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this);
+    event.m_data.pos = m_sashPosition;
+
+    (void)DoSendEvent(event);

 }
 
 // Position and size subwindows.
 }
 
 // Position and size subwindows.


@@ -649,8 +696,8 @@ void wxSplitterWindow::SizeWindows()
             y2 = size2;
         }
 
             y2 = size2;
         }
 

-        GetWindow1()->SetSize(border, border, w1, h1);

         GetWindow2()->SetSize(x2, y2, w2, h2);
         GetWindow2()->SetSize(x2, y2, w2, h2);

+        GetWindow1()->SetSize(border, border, w1, h1);

     }
 
     wxClientDC dc(this);
     }
 
     wxClientDC dc(this);


@@ -662,9 +709,12 @@ void wxSplitterWindow::SizeWindows()
 // Set pane for unsplit window
 void wxSplitterWindow::Initialize(wxWindow *window)
 {
 // Set pane for unsplit window
 void wxSplitterWindow::Initialize(wxWindow *window)
 {

-    wxASSERT_MSG( window && window->GetParent() == this,
+    wxASSERT_MSG( (!window || (window && window->GetParent() == this)),

                   _T("windows in the splitter should have it as parent!") );
 
                   _T("windows in the splitter should have it as parent!") );
 

+    if (window && !window->IsShown())
+        window->Show();
+

     m_windowOne = window;
     m_windowTwo = (wxWindow *) NULL;
     DoSetSashPosition(0);
     m_windowOne = window;
     m_windowTwo = (wxWindow *) NULL;
     DoSetSashPosition(0);


@@ -686,6 +736,11 @@ bool wxSplitterWindow::DoSplit(wxSplitMode mode,
     wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
                   _T("windows in the splitter should have it as parent!") );
 
     wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
                   _T("windows in the splitter should have it as parent!") );
 

+    if (! window1->IsShown())
+        window1->Show();
+    if (! window2->IsShown())
+        window2->Show();
+

     m_splitMode = mode;
     m_windowOne = window1;
     m_windowTwo = window2;
     m_splitMode = mode;
     m_windowOne = window1;
     m_windowTwo = window2;


@@ -694,7 +749,7 @@ bool wxSplitterWindow::DoSplit(wxSplitMode mode,
     // right now (e.g. because the window is too small)
     m_requestedSashPosition = sashPosition;
     m_checkRequestedSashPosition = false;
     // right now (e.g. because the window is too small)
     m_requestedSashPosition = sashPosition;
     m_checkRequestedSashPosition = false;

-    
+

     DoSetSashPosition(ConvertSashPosition(sashPosition));
 
     SizeWindows();
     DoSetSashPosition(ConvertSashPosition(sashPosition));
 
     SizeWindows();


@@ -792,7 +847,7 @@ void wxSplitterWindow::SetSashPosition(int position, bool redraw)
     // right now (e.g. because the window is too small)
     m_requestedSashPosition = position;
     m_checkRequestedSashPosition = false;
     // right now (e.g. because the window is too small)
     m_requestedSashPosition = position;
     m_checkRequestedSashPosition = false;

-    
+

     DoSetSashPosition(ConvertSashPosition(position));
 
     if ( redraw )
     DoSetSashPosition(ConvertSashPosition(position));
 
     if ( redraw )


@@ -801,11 +856,61 @@ void wxSplitterWindow::SetSashPosition(int position, bool redraw)
     }
 }
 
     }
 }
 

+// Make sure the child window sizes are updated. This is useful
+// for reducing flicker by updating the sizes before a
+// window is shown, if you know the overall size is correct.
+void wxSplitterWindow::UpdateSize()
+{
+    m_checkRequestedSashPosition = true;
+    SizeWindows();
+    m_checkRequestedSashPosition = false;
+}
+

 bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
 {
     return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed();
 }
 
 bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
 {
     return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed();
 }
 

+wxSize wxSplitterWindow::DoGetBestSize() const
+{
+    // get best sizes of subwindows
+    wxSize size1, size2;
+    if ( m_windowOne )
+        size1 = m_windowOne->GetAdjustedBestSize();
+    if ( m_windowTwo )
+        size2 = m_windowTwo->GetAdjustedBestSize();
+
+    // sum them
+    //
+    // pSash points to the size component to which sash size must be added
+    int *pSash;
+    wxSize sizeBest;
+    if ( m_splitMode == wxSPLIT_VERTICAL )
+    {
+        sizeBest.y = wxMax(size1.y, size2.y);
+        sizeBest.x = wxMax(size1.x, m_minimumPaneSize) +
+                        wxMax(size2.x, m_minimumPaneSize);
+
+        pSash = &sizeBest.x;
+    }
+    else // wxSPLIT_HORIZONTAL
+    {
+        sizeBest.x = wxMax(size1.x, size2.x);
+        sizeBest.y = wxMax(size1.y, m_minimumPaneSize) +
+                        wxMax(size2.y, m_minimumPaneSize);
+
+        pSash = &sizeBest.y;
+    }
+
+    // account for the border and the sash
+    int border = 2*GetBorderSize();
+    *pSash += GetSashSize();
+    sizeBest.x += border;
+    sizeBest.y += border;
+
+    return sizeBest;
+}
+

 // ---------------------------------------------------------------------------
 // wxSplitterWindow virtual functions: they now just generate the events
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // wxSplitterWindow virtual functions: they now just generate the events
 // ---------------------------------------------------------------------------