src/dfb/nonownedwnd.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/dfb/nonownedwnd.cpp
   3 // Purpose:     implementation of wxNonOwnedWindow
   4 // Author:      Vaclav Slavik
   5 // Created:     2006-12-24
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2006 REA Elektronik GmbH
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // For compilers that support precompilation, includes "wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #include "wx/toplevel.h"
  15
  16 #ifndef WX_PRECOMP
  17     #include "wx/app.h"
  18 #endif // WX_PRECOMP
  19
  20 #include "wx/hashmap.h"
  21 #include "wx/evtloop.h"
  22 #include "wx/dfb/private.h"
  23
  24 #define TRACE_EVENTS _T("events")
  25 #define TRACE_PAINT  _T("paint")
  26
  27 // ============================================================================
  28 // globals
  29 // ============================================================================
  30
  31 // mapping of DirectFB windows to wxTLWs:
  32 WX_DECLARE_HASH_MAP(DFBWindowID, wxNonOwnedWindow*,
  33                     wxIntegerHash, wxIntegerEqual,
  34                     wxDfbWindowsMap);
  35 static wxDfbWindowsMap gs_dfbWindowsMap;
  36
  37 // ============================================================================
  38 // helpers
  39 // ============================================================================
  40
  41 // Queue of paint requests
  42 class wxDfbQueuedPaintRequests
  43 {
  44 public:
  45     ~wxDfbQueuedPaintRequests() { Clear(); }
  46
  47     // Adds paint request to the queue
  48     void Add(const wxRect& rect)
  49     {
  50         // We use a simple implementation here for now: all refresh requests
  51         // are merged together into single rectangle that is superset of
  52         // all the requested rectangles. This wastes some blitting and painting
  53         // time, but OTOH, EVT_PAINT handler is called only once per window.
  54         m_invalidated.Union(rect);
  55     }
  56
  57     // Is the queue empty?
  58     bool IsEmpty() const { return m_invalidated.IsEmpty(); }
  59
  60     // Empties the queue
  61     void Clear() { m_invalidated = wxRect(); }
  62
  63     // Gets the next request in the queue, returns true if there was one,
  64     // false if the queue was empty
  65     bool GetNext(wxRect& rect)
  66     {
  67         if ( m_invalidated.IsEmpty() )
  68             return false;
  69
  70         rect = m_invalidated;
  71         Clear(); // there's only one item in the queue
  72         return true;
  73     }
  74
  75 private:
  76     // currently invalidated region
  77     wxRect m_invalidated;
  78 };
  79
  80 // ============================================================================
  81 // wxNonOwnedWindow
  82 // ============================================================================
  83
  84 // ----------------------------------------------------------------------------
  85 // creation & destruction
  86 // ----------------------------------------------------------------------------
  87
  88 void wxNonOwnedWindow::Init()
  89 {
  90     m_isShown = false;
  91     m_sizeSet = false;
  92     m_opacity = 255;
  93     m_toPaint = new wxDfbQueuedPaintRequests;
  94     m_isPainting = false;
  95 }
  96
  97 bool wxNonOwnedWindow::Create(wxWindow *parent,
  98                                  wxWindowID id,
  99                                  const wxPoint& pos,
 100                                  const wxSize& size,
 101                                  long style,
 102                                  const wxString &name)
 103 {
 104     wxCHECK_MSG( pos.x >= 0 && pos.y >= 0, false, _T("invalid position") );
 105     wxCHECK_MSG( size.x > 0 && size.y > 0, false, _T("invalid size") );
 106
 107     m_tlw = this;
 108
 109     // create DirectFB window:
 110     wxIDirectFBDisplayLayerPtr layer(wxIDirectFB::Get()->GetDisplayLayer());
 111     wxCHECK_MSG( layer, false, _T("no display layer") );
 112
 113     DFBWindowDescription desc;
 114     desc.flags = (DFBWindowDescriptionFlags)
 115                    (DWDESC_CAPS |
 116                     DWDESC_WIDTH | DWDESC_HEIGHT | DWDESC_POSX | DWDESC_POSY);
 117     desc.caps = DWCAPS_DOUBLEBUFFER;
 118     desc.posx = pos.x;
 119     desc.posy = pos.y;
 120     desc.width = size.x;
 121     desc.height = size.y;
 122     m_dfbwin = layer->CreateWindow(&desc);
 123     if ( !m_dfbwin )
 124         return false;
 125
 126     // add the new TLW to DFBWindowID->wxTLW map:
 127     DFBWindowID winid;
 128     if ( !m_dfbwin->GetID(&winid) )
 129         return false;
 130     gs_dfbWindowsMap[winid] = this;
 131
 132     // TLWs are created initially hidden:
 133     if ( !m_dfbwin->SetOpacity(wxALPHA_TRANSPARENT) )
 134         return false;
 135
 136     if ( !wxWindow::Create(NULL, id, pos, size, style, name) )
 137         return false;
 138
 139     SetParent(parent);
 140     if ( parent )
 141         parent->AddChild(this);
 142
 143     if ( style & (wxSTAY_ON_TOP | wxPOPUP_WINDOW) )
 144     {
 145         m_dfbwin->SetStackingClass(DWSC_UPPER);
 146     }
 147
 148     // direct events in this window to the global event buffer:
 149     m_dfbwin->AttachEventBuffer(wxEventLoop::GetDirectFBEventBuffer());
 150
 151     return true;
 152 }
 153
 154 wxNonOwnedWindow::~wxNonOwnedWindow()
 155 {
 156     m_isBeingDeleted = true;
 157
 158     // destroy all children before we destroy the underlying DirectFB window,
 159     // so that if any of them does something with the TLW, it will still work:
 160     DestroyChildren();
 161
 162     // it's safe to delete the underlying DirectFB window now:
 163     wxDELETE(m_toPaint);
 164
 165     if ( !m_dfbwin )
 166         return;
 167
 168     // remove the TLW from DFBWindowID->wxTLW map:
 169     DFBWindowID winid;
 170     if ( m_dfbwin->GetID(&winid) )
 171         gs_dfbWindowsMap.erase(winid);
 172
 173     m_dfbwin->Destroy();
 174     m_dfbwin.Reset();
 175 }
 176
 177 // ----------------------------------------------------------------------------
 178 // window size & position
 179 // ----------------------------------------------------------------------------
 180
 181 void wxNonOwnedWindow::DoGetPosition(int *x, int *y) const
 182 {
 183     m_dfbwin->GetPosition(x, y);
 184 }
 185
 186 void wxNonOwnedWindow::DoGetSize(int *width, int *height) const
 187 {
 188     m_dfbwin->GetSize(width, height);
 189 }
 190
 191 void wxNonOwnedWindow::DoMoveWindow(int x, int y, int width, int height)
 192 {
 193     wxPoint curpos = GetPosition();
 194     if ( curpos.x != x || curpos.y != y )
 195     {
 196         m_dfbwin->MoveTo(x, y);
 197     }
 198
 199     wxSize cursize = GetSize();
 200     if ( cursize.x != width || cursize.y != height )
 201     {
 202         // changing window's size changes its surface:
 203         InvalidateDfbSurface();
 204
 205         m_dfbwin->Resize(width, height);
 206
 207         // we must repaint the window after it changed size:
 208         if ( IsShown() )
 209             DoRefreshWindow();
 210     }
 211 }
 212
 213 // ----------------------------------------------------------------------------
 214 // showing and hiding
 215 // ----------------------------------------------------------------------------
 216
 217 bool wxNonOwnedWindow::Show(bool show)
 218 {
 219     // NB: this calls wxWindow::Show() and so ensures DoRefreshWindow() is
 220     //     called on the window -- we'll need that below
 221     if ( !wxWindow::Show(show) )
 222         return false;
 223
 224     // If this is the first time Show was called, send size event,
 225     // so that the frame can adjust itself (think auto layout or single child)
 226     if ( !m_sizeSet )
 227     {
 228         m_sizeSet = true;
 229         wxSizeEvent event(GetSize(), GetId());
 230         event.SetEventObject(this);
 231         GetEventHandler()->ProcessEvent(event);
 232     }
 233
 234     // make sure the window is fully painted, with all pending updates, before
 235     // DFB WM shows it, otherwise it would attempt to show either empty (=
 236     // black) window surface (if shown for the first time) or it would show
 237     // window with outdated content; note that the window was already refreshed
 238     // in the wxWindow::Show() call above:
 239     if ( show )
 240         Update();
 241
 242     // hide/show the window by setting its opacity to 0/full:
 243     m_dfbwin->SetOpacity(show ? m_opacity : 0);
 244
 245     if ( show )
 246     {
 247         wxWindow *focused = FindFocus();
 248         if ( focused && focused->GetTLW() == this )
 249         {
 250             // focus is on this frame or its children, apply it to DirectFB
 251             SetDfbFocus();
 252         }
 253         // else: don't do anything, if this is wxFrame or wxDialog that should
 254         //       get focus when it's shown,
 255         //       wxTopLevelWindowDFB::HandleFocusEvent() will do it as soon as
 256         //       the event loop starts
 257     }
 258
 259     return true;
 260 }
 261
 262 // ----------------------------------------------------------------------------
 263 // surfaces and painting
 264 // ----------------------------------------------------------------------------
 265
 266 wxIDirectFBSurfacePtr wxNonOwnedWindow::ObtainDfbSurface() const
 267 {
 268     return m_dfbwin->GetSurface();
 269 }
 270
 271 void wxNonOwnedWindow::HandleQueuedPaintRequests()
 272 {
 273     if ( m_toPaint->IsEmpty() )
 274         return; // nothing to do
 275
 276     if ( IsFrozen() || !IsShown() )
 277     {
 278         // nothing to do if the window is frozen or hidden; clear the queue
 279         // and return (note that it's OK to clear the queue even if the window
 280         // is frozen, because Thaw() calls Refresh()):
 281         m_toPaint->Clear();
 282         return;
 283     }
 284
 285     // process queued paint requests:
 286     wxRect winRect(wxPoint(0, 0), GetSize());
 287     wxRect paintedRect;
 288
 289     // important note: all DCs created from now until m_isPainting is reset to
 290     // false will not update the front buffer as this flag indicates that we'll
 291     // blit the entire back buffer to front soon
 292     m_isPainting = true;
 293
 294 #ifdef __WXDEBUG__
 295     int requestsCount = 0;
 296 #endif
 297
 298     wxRect request;
 299     while ( m_toPaint->GetNext(request) )
 300     {
 301 #ifdef __WXDEBUG__
 302         requestsCount++;
 303 #endif
 304         wxRect clipped(request);
 305         clipped.Intersect(winRect);
 306         if ( clipped.IsEmpty() )
 307             continue; // nothing to refresh
 308
 309         wxLogTrace(TRACE_PAINT,
 310                    _T("%p ('%s'): processing paint request [%i,%i,%i,%i]"),
 311                    this, GetName().c_str(),
 312                    clipped.x, clipped.y, clipped.GetRight(), clipped.GetBottom());
 313
 314         PaintWindow(clipped);
 315
 316         // remember rectangle covering all repainted areas:
 317         if ( paintedRect.IsEmpty() )
 318             paintedRect = clipped;
 319         else
 320             paintedRect.Union(clipped);
 321     }
 322
 323     m_isPainting = false;
 324
 325     m_toPaint->Clear();
 326
 327     if ( paintedRect.IsEmpty() )
 328         return; // no painting occurred, no need to flip
 329
 330     // Flip the surface to make the changes visible. Note that the rectangle we
 331     // flip is *superset* of the union of repainted rectangles (created as
 332     // "rectangles union" by wxRect::Union) and so some parts of the back
 333     // buffer that we didn't touch in this HandleQueuedPaintRequests call will
 334     // be copied to the front buffer as well. This is safe/correct thing to do
 335     // *only* because wx always use wxIDirectFBSurface::FlipToFront() and so
 336     // the back and front buffers contain the same data.
 337     //
 338     // Note that we do _not_ split m_toPaint into disjoint rectangles and
 339     // do FlipToFront() for each of them, because that could result in visible
 340     // updating of the screen; instead, we prefer to flip everything at once.
 341
 342     DFBRegion r = {paintedRect.GetLeft(), paintedRect.GetTop(),
 343                    paintedRect.GetRight(), paintedRect.GetBottom()};
 344     DFBRegion *rptr = (winRect == paintedRect) ? NULL : &r;
 345
 346     GetDfbSurface()->FlipToFront(rptr);
 347
 348     wxLogTrace(TRACE_PAINT,
 349                _T("%p ('%s'): processed %i paint requests, flipped surface: [%i,%i,%i,%i]"),
 350                this, GetName().c_str(),
 351                requestsCount,
 352                paintedRect.x, paintedRect.y,
 353                paintedRect.GetRight(), paintedRect.GetBottom());
 354 }
 355
 356 void wxNonOwnedWindow::DoRefreshRect(const wxRect& rect)
 357 {
 358     // don't overlap outside of the window (NB: 'rect' is in window coords):
 359     wxRect r(rect);
 360     r.Intersect(wxRect(GetSize()));
 361     if ( r.IsEmpty() )
 362         return;
 363
 364     wxLogTrace(TRACE_PAINT,
 365                _T("%p ('%s'): [TLW] refresh rect [%i,%i,%i,%i]"),
 366                this, GetName().c_str(),
 367                rect.x, rect.y, rect.GetRight(), rect.GetBottom());
 368
 369     // defer painting until idle time or until Update() is called:
 370     m_toPaint->Add(rect);
 371 }
 372
 373 void wxNonOwnedWindow::Update()
 374 {
 375     HandleQueuedPaintRequests();
 376 }
 377
 378 // ---------------------------------------------------------------------------
 379 // events handling
 380 // ---------------------------------------------------------------------------
 381
 382 namespace
 383 {
 384
 385 static wxNonOwnedWindow *gs_insideDFBFocusHandlerOf = NULL;
 386
 387 struct InsideDFBFocusHandlerSetter
 388 {
 389     InsideDFBFocusHandlerSetter(wxNonOwnedWindow *win)
 390     {
 391         wxASSERT( gs_insideDFBFocusHandlerOf == NULL );
 392         gs_insideDFBFocusHandlerOf = win;
 393     }
 394     ~InsideDFBFocusHandlerSetter()
 395     {
 396         gs_insideDFBFocusHandlerOf = NULL;
 397     }
 398 };
 399
 400 } // anonymous namespace
 401
 402
 403 void wxNonOwnedWindow::SetDfbFocus()
 404 {
 405     wxCHECK_RET( IsShown(), _T("cannot set focus to hidden window") );
 406     wxASSERT_MSG( FindFocus() && FindFocus()->GetTLW() == this,
 407                   _T("setting DirectFB focus to unexpected window") );
 408
 409     // Don't set DirectFB focus if we're called from HandleFocusEvent() on
 410     // this window, because we already have the focus in that case. Not only
 411     // would it be unnecessary, it would be harmful: RequestFocus() adds
 412     // an event to DirectFB event queue and calling it when in
 413     // HandleFocusEvent() could result in a window being focused when it
 414     // should not be. Consider this example:
 415     //
 416     //     tlw1->SetFocus(); // (1)
 417     //     tlw2->SetFocus(); // (2)
 418     //
 419     // This results in adding these events to DFB queue:
 420     //
 421     //     DWET_GOTFOCUS(tlw1)
 422     //     DWET_LOSTFOCUS(tlw1)
 423     //     DWET_GOTFOCUS(tlw2)
 424     //
 425     // Note that the events are processed by event loop, i.e. not between
 426     // execution of lines (1) and (2) above. So by the time the first
 427     // DWET_GOTFOCUS event is handled, tlw2->SetFocus() was already executed.
 428     // If we onconditionally called RequestFocus() from here, handling the
 429     // first event would result in this change to the event queue:
 430     //
 431     //     DWET_LOSTFOCUS(tlw1)
 432     //     DWET_GOTFOCUS(tlw2) // (3)
 433     //     DWET_LOSTFOCUS(tlw2)
 434     //     DWET_GOTFOCUS(tlw1)
 435     //
 436     // And the focus would get back to tlw1 even though that's not what we
 437     // wanted.
 438
 439     if ( gs_insideDFBFocusHandlerOf == this )
 440         return;
 441
 442     GetDirectFBWindow()->RequestFocus();
 443 }
 444
 445 /* static */
 446 void wxNonOwnedWindow::HandleDFBWindowEvent(const wxDFBWindowEvent& event_)
 447 {
 448     const DFBWindowEvent& event = event_;
 449
 450     if ( gs_dfbWindowsMap.find(event.window_id) == gs_dfbWindowsMap.end() )
 451     {
 452         wxLogTrace(TRACE_EVENTS,
 453                    _T("received event for unknown DirectFB window, ignoring"));
 454         return;
 455     }
 456
 457     wxNonOwnedWindow *tlw = gs_dfbWindowsMap[event.window_id];
 458
 459     switch ( event.type )
 460     {
 461         case DWET_KEYDOWN:
 462         case DWET_KEYUP:
 463         {
 464             wxWindow *recipient = wxWindow::FindFocus();
 465             if ( !recipient )
 466             {
 467                 wxLogTrace(TRACE_EVENTS,
 468                            _T("ignoring event: no recipient window"));
 469                 return;
 470             }
 471
 472             wxCHECK_RET( recipient && recipient->GetTLW() == tlw,
 473                          _T("event recipient not in TLW which received the event") );
 474
 475             recipient->HandleKeyEvent(event_);
 476             break;
 477         }
 478
 479         case DWET_GOTFOCUS:
 480         case DWET_LOSTFOCUS:
 481             {
 482                 InsideDFBFocusHandlerSetter inside(tlw);
 483                 tlw->HandleFocusEvent(event_);
 484             }
 485             break;
 486
 487         case DWET_NONE:
 488         case DWET_ALL:
 489             wxFAIL_MSG( _T("invalid event type") );
 490             break;
 491
 492         default:
 493             // we're not interested in them here
 494             break;
 495     }
 496 }
 497
 498 // ---------------------------------------------------------------------------
 499 // idle events processing
 500 // ---------------------------------------------------------------------------
 501
 502 void wxNonOwnedWindow::OnInternalIdle()
 503 {
 504     wxWindow::OnInternalIdle();
 505     HandleQueuedPaintRequests();
 506 }