Merge in from trunk r64802 - r68625

[wxWidgets.git] / src / dfb / dcclient.cpp

diff --git a/src/dfb/dcclient.cpp b/src/dfb/dcclient.cpp
index 36a57c83306344076d57d615b1e5d91edd94e17a..2a13ea7e2b1f07f51b9a297d4ea89106bd237eaa 100644 (file)
--- a/src/dfb/dcclient.cpp
+++ b/src/dfb/dcclient.cpp
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/dfb/dcclient.cpp
 /////////////////////////////////////////////////////////////////////////////
 // Name:        src/dfb/dcclient.cpp

-// Purpose:     wxWindowDC, wxClientDC and wxPaintDC
+// Purpose:     wxWindowDCImpl, wxClientDCImpl and wxPaintDC

 // Author:      Vaclav Slavik
 // Created:     2006-08-10
 // RCS-ID:      $Id$
 // Author:      Vaclav Slavik
 // Created:     2006-08-10
 // RCS-ID:      $Id$


@@ -23,105 +23,226 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#include "wx/dcclient.h"
-

 #ifndef WX_PRECOMP
     #include "wx/window.h"
 #ifndef WX_PRECOMP
     #include "wx/window.h"

+    #include "wx/nonownedwnd.h"

 #endif
 
 #endif
 

+#include "wx/dfb/dcclient.h"

 #include "wx/dfb/private.h"
 
 #include "wx/dfb/private.h"
 

+#define TRACE_PAINT  "paint"
+

 // ===========================================================================
 // implementation
 // ===========================================================================
 
 //-----------------------------------------------------------------------------
 // ===========================================================================
 // implementation
 // ===========================================================================
 
 //-----------------------------------------------------------------------------

-// wxWindowDC
+// helpers

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
-
-wxWindowDC::wxWindowDC(wxWindow *win)
-    : wxDC(win ? win->GetDfbSurface() : NULL)
+// Returns subrect of the window that is not outside of its parent's
+// boundaries ("hidden behind its borders"), recursively:
+static wxRect GetUncoveredWindowArea(wxWindow *win)

 {
 {

-    InitForWin(win);
-}
+    wxRect r(win->GetSize());

 
 

-void wxWindowDC::InitForWin(wxWindow *win)
-{
-    wxCHECK_RET( win, _T("invalid window") );
-
-    // FIXME: this should be made to work: we need to detect that the window
-    //        is not visible and in that case, a) ignore any drawing actions
-    //        and b) provide dummy surface that can still be used to get
-    //        information (e.g. text extents):
-    wxWindow *w = win;
-    for ( wxWindow *w = win; w; w = w->GetParent() )
-    {
-        // painting on hidden TLW when non-TLW windows are shown is OK,
-        // DirectFB manages that:
-        if ( w->IsTopLevel() )
-            break;
+    if ( win->IsTopLevel() )
+        return r;

 
 

-        wxASSERT_MSG( w->IsShown(),
-                      _T("painting on hidden window not implemented yet") );
-    }
+    wxWindow *parent = win->GetParent();
+    if ( !parent )
+        return r;

 
 

+    // intersect with parent's uncovered area, after offsetting it into win's
+    // coordinates; this will remove parts of 'r' that are outside of the
+    // parent's area:
+    wxRect rp(GetUncoveredWindowArea(parent));

 
 

-    SetFont(win->GetFont());
+    // normal windows cannot extend out of its parent's client area:
+    if ( !win->CanBeOutsideClientArea() )
+        rp.Intersect(parent->GetClientRect());
+
+    rp.Offset(-win->GetPosition());
+    rp.Offset(-parent->GetClientAreaOrigin());
+    r.Intersect(rp);
+
+    return r;
+}
+
+// creates a dummy surface that has the same format as the real window's
+// surface, but is not visible and so can be painted on even if the window
+// is hidden
+static
+wxIDirectFBSurfacePtr CreateDummySurface(wxWindow *win, const wxRect *rect)
+{
+    wxLogTrace(TRACE_PAINT, "%p ('%s'): creating dummy DC surface",
+               win, win->GetName().c_str());
+    wxSize size(rect ? rect->GetSize() : win->GetSize());
+
+    // we can't create a surface of 0 size but the size of the window may be 0,
+    // so ensure that we have at least a single pixel to draw on
+    size.IncTo(wxSize(1, 1));
+
+    return win->GetDfbSurface()->CreateCompatible
+           (
+             size,
+             wxIDirectFBSurface::CreateCompatible_NoBackBuffer
+           );

 }
 
 //-----------------------------------------------------------------------------
 }
 
 //-----------------------------------------------------------------------------

-// base class for wxClientDC and wxPaintDC
+// wxWindowDCImpl

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-wxClientDCBase::wxClientDCBase(wxWindow *win)
+IMPLEMENT_ABSTRACT_CLASS(wxWindowDCImpl, wxDFBDCImpl)
+
+wxWindowDCImpl::wxWindowDCImpl(wxDC *owner, wxWindow *win)
+              : wxDFBDCImpl(owner)

 {
 {

-    wxCHECK_RET( win, _T("invalid window") );
+    InitForWin(win, NULL);
+}

 
 

-    wxRect rect = win->GetClientRect();
-    DFBRectangle dfbrect = { rect.x, rect.y, rect.width, rect.height };
+void wxWindowDCImpl::InitForWin(wxWindow *win, const wxRect *rect)
+{
+    wxCHECK_RET( win, "invalid window" );
+
+    m_window = win;
+
+    // obtain the surface used for painting:
+    wxPoint origin;
+    wxIDirectFBSurfacePtr surface;
+
+    wxRect rectOrig(rect ? *rect : wxRect(win->GetSize()));
+    wxRect r;
+
+    if ( !win->IsShownOnScreen() )
+    {
+        // leave 'r' rectangle empty to indicate the window is not visible,
+        // see below (below "create the surface:") for how is this case handled
+    }
+    else
+    {
+        // compute painting rectangle after clipping if we're in PaintWindow
+        // code, otherwise paint on the entire window:
+        r = rectOrig;
+
+        const wxRegion& updateRegion = win->GetUpdateRegion();
+        if ( win->GetTLW()->IsPainting() && !updateRegion.IsEmpty() )
+        {
+            r.Intersect(updateRegion.AsRect());
+            wxCHECK_RET( !r.IsEmpty(), "invalid painting rectangle" );
+
+            // parent TLW will flip the entire surface when painting is done
+            m_shouldFlip = false;
+        }
+        else
+        {
+            // One of two things happened:
+            // (1) the TLW is not being painted by PaintWindow() now; or
+            // (2) we're drawing on some window other than the one that is
+            //     currently painted on by PaintWindow()
+            // In either case, we need to flip the surface when we're done
+            // painting and we don't have to use updateRegion for clipping.
+            // OTOH, if the window is (partially) hidden by being
+            // out of its parent's area, we must clip the surface accordingly.
+            r.Intersect(GetUncoveredWindowArea(win));
+            m_shouldFlip = true; // paint the results immediately
+        }
+    }

 
 

-    wxIDirectFBSurfacePtr subsurf(
-            win->GetDfbSurface()->GetSubSurface(&dfbrect));
-    if ( !subsurf )
+    // create the surface:
+    if ( r.IsEmpty() )
+    {
+        // we're painting on invisible window: the changes won't have any
+        // effect, as the window will be repainted anyhow when it is shown,
+        // but we still need a valid DC so that e.g. text extents can be
+        // measured, so let's create a dummy surface that has the same
+        // format as the real one would have and let the code paint on it:
+        surface = CreateDummySurface(win, rect);
+
+        // painting on hidden window has no effect on TLW's surface, don't
+        // waste time flipping the dummy surface:
+        m_shouldFlip = false;
+    }
+    else
+    {
+        m_winRect = r;
+        DFBRectangle dfbrect = { r.x, r.y, r.width, r.height };
+        surface = win->GetDfbSurface()->GetSubSurface(&dfbrect);
+
+        // if the DC was clipped thanks to rectPaint, we must adjust the
+        // origin accordingly; but we do *not* adjust for 'rect', because
+        // rect.GetPosition() has coordinates (0,0) in the DC:
+        origin.x = rectOrig.x - r.x;
+        origin.y = rectOrig.y - r.y;
+
+        // m_shouldFlip was set in the "if" block above this one
+    }
+
+    if ( !surface )

         return;
 
         return;
 

-    Init(subsurf);
-    InitForWin(win);
+    wxLogTrace(TRACE_PAINT,
+               "%p ('%s'): creating DC for area [%i,%i,%i,%i], clipped to [%i,%i,%i,%i], origin [%i,%i]",
+               win, win->GetName().c_str(),
+               rectOrig.x, rectOrig.y, rectOrig.GetRight(), rectOrig.GetBottom(),
+               r.x, r.y, r.GetRight(), r.GetBottom(),
+               origin.x, origin.y);
+
+    DFBInit(surface);
+    SetFont(win->GetFont());

 
     // offset coordinates to account for subsurface's origin coordinates:
 
     // offset coordinates to account for subsurface's origin coordinates:

-    SetDeviceOrigin(rect.x, rect.y);
+    SetDeviceOrigin(origin.x, origin.y);
+}
+
+wxWindowDCImpl::~wxWindowDCImpl()
+{
+    wxIDirectFBSurfacePtr surface(GetDirectFBSurface());
+    if ( !surface )
+        return;
+
+    // if no painting was done on the DC, we don't have to flip the surface:
+    if ( !m_isBBoxValid )
+        return;
+
+    if ( m_shouldFlip )
+    {
+        // paint overlays on top of the surface being drawn to by this DC
+        // before showing anything on the screen:
+        GetWindow()->PaintOverlays(m_winRect);
+
+        DFBSurfaceCapabilities caps = DSCAPS_NONE;
+        surface->GetCapabilities(&caps);
+        if ( caps & DSCAPS_DOUBLE )
+        {
+            // FIXME: flip only modified parts of the surface
+            surface->FlipToFront();
+        }
+        // else: the surface is not double-buffered and so cannot be flipped
+    }
+    // else: don't flip the surface, wxTLW will do it when it finishes
+    //       painting of its invalidated areas

 }
 
 //-----------------------------------------------------------------------------
 }
 
 //-----------------------------------------------------------------------------

-// wxClientDC
+// wxClientDCImpl

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
+IMPLEMENT_ABSTRACT_CLASS(wxClientDCImpl, wxWindowDCImpl)

 
 

-wxClientDC::~wxClientDC()
+wxClientDCImpl::wxClientDCImpl(wxDC *owner, wxWindow *win)
+              : wxWindowDCImpl(owner, win)

 {
 {

-    // flip to surface so that the changes become visible
-    wxIDirectFBSurfacePtr surface(GetDirectFBSurface());
+    wxCHECK_RET( win, "invalid window" );

 
 

-    // FIXME: do this only if the surface was modified (as opposed to e.g.
-    //        used only to obtain text metrics)
-    if ( surface )
-        surface->Flip(NULL, DSFLIP_NONE);
+    wxRect rect = win->GetClientRect();
+    InitForWin(win, &rect);

 }
 
 //-----------------------------------------------------------------------------
 // wxPaintDC
 //-----------------------------------------------------------------------------
 
 }
 
 //-----------------------------------------------------------------------------
 // wxPaintDC
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC)
-
-#warning "wxPaintDC ctor must respect m_updateRegion"
-
-wxPaintDC::~wxPaintDC()
-{
-    // NB: do *not* flip the surface: wxPaintDC is used with EVT_PAINT and the
-    //     surface will be flipped for the entire TLW once all children are
-    //     repainted
-}
+IMPLEMENT_ABSTRACT_CLASS(wxPaintDCImpl, wxWindowDCImpl)