Correct signature of HitTest()

[wxWidgets.git] / src / cocoa / window.mm

diff --git a/src/cocoa/window.mm b/src/cocoa/window.mm
index d89d7de1a5d131d1c0ece75a66ff4db7e903e25b..390d250a93082e662228ac3a166b1bc688b9f1f4 100644 (file)
--- a/src/cocoa/window.mm
+++ b/src/cocoa/window.mm
@@ -711,7 +711,7 @@ bool wxWindowCocoa::Cocoa_mouseEntered(WX_NSEvent theEvent)
 
         wxMouseEvent event(wxEVT_ENTER_WINDOW);
         InitMouseEvent(event,theEvent);
 
         wxMouseEvent event(wxEVT_ENTER_WINDOW);
         InitMouseEvent(event,theEvent);

-        wxLogTrace(wxTRACE_COCOA,wxT("wxwin=%p Mouse Entered @%d,%d"),this,event.m_x,event.m_y);
+        wxLogTrace(wxTRACE_COCOA_TrackingRect,wxT("wxwin=%p Mouse Entered TR#%d @%d,%d"),this,[theEvent trackingNumber], event.m_x,event.m_y);

         return GetEventHandler()->ProcessEvent(event);
     }
     else
         return GetEventHandler()->ProcessEvent(event);
     }
     else


@@ -726,7 +726,7 @@ bool wxWindowCocoa::Cocoa_mouseExited(WX_NSEvent theEvent)
 
         wxMouseEvent event(wxEVT_LEAVE_WINDOW);
         InitMouseEvent(event,theEvent);
 
         wxMouseEvent event(wxEVT_LEAVE_WINDOW);
         InitMouseEvent(event,theEvent);

-        wxLogTrace(wxTRACE_COCOA,wxT("wxwin=%p Mouse Exited @%d,%d"),this,event.m_x,event.m_y);
+        wxLogTrace(wxTRACE_COCOA_TrackingRect,wxT("wxwin=%p Mouse Exited TR#%d @%d,%d"),this,[theEvent trackingNumber],event.m_x,event.m_y);

         return GetEventHandler()->ProcessEvent(event);
     }
     else
         return GetEventHandler()->ProcessEvent(event);
     }
     else


@@ -811,8 +811,21 @@ void wxWindowCocoa::Cocoa_FrameChanged(void)
 bool wxWindowCocoa::Cocoa_resetCursorRects()
 {
     wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_resetCursorRects"),this);
 bool wxWindowCocoa::Cocoa_resetCursorRects()
 {
     wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_resetCursorRects"),this);

+
+    // When we are called there may be a queued tracking rect event (mouse entered or exited) and
+    // we won't know it.  A specific example is wxGenericHyperlinkCtrl changing the cursor from its
+    // mouse exited event.  If the control happens to share the edge with its parent window which is
+    // also tracking mouse events then Cocoa receives two mouse exited events from the window server.
+    // The first one will cause wxGenericHyperlinkCtrl to call wxWindow::SetCursor which will
+    // invaildate the cursor rect causing Cocoa to schedule cursor rect reset with the run loop
+    // which willl in turn call us before exiting for the next user event.
+
+    // If we are the parent window then rebuilding our tracking rectangle will cause us to miss
+    // our mouse exited event because the already queued event will have the old tracking rect
+    // tag.  The simple solution is to only rebuild our tracking rect if we need to.
+

     if(m_visibleTrackingRectManager != NULL)
     if(m_visibleTrackingRectManager != NULL)

-        m_visibleTrackingRectManager->RebuildTrackingRect();
+        m_visibleTrackingRectManager->RebuildTrackingRectIfNeeded();

 
     if(!m_cursor.GetNSCursor())
         return false;
 
     if(!m_cursor.GetNSCursor())
         return false;


@@ -826,7 +839,15 @@ bool wxWindowCocoa::SetCursor(const wxCursor &cursor)
 {
     if(!wxWindowBase::SetCursor(cursor))
         return false;
 {
     if(!wxWindowBase::SetCursor(cursor))
         return false;

+
+    // Set up the cursor rect so that invalidateCursorRectsForView: will destroy it.
+    // If we don't do this then Cocoa thinks (rightly) that we don't have any cursor
+    // rects and thus won't ever call resetCursorRects.
+    [GetNSView() addCursorRect: [GetNSView() visibleRect]  cursor: m_cursor.GetNSCursor()];
+

     // Invalidate the cursor rects so the cursor will change
     // Invalidate the cursor rects so the cursor will change

+    // Note that it is not enough to remove the old one (if any) and add the new one.
+    // For the rects to work properly, Cocoa itself must call resetCursorRects.

     [[GetNSView() window] invalidateCursorRectsForView:GetNSView()];
     return true;
 }
     [[GetNSView() window] invalidateCursorRectsForView:GetNSView()];
     return true;
 }


@@ -1412,11 +1433,12 @@ wxWindow* wxFindWindowAtPointer(wxPoint& pt)
     return NULL;
 }
 
     return NULL;
 }
 

-

 // ========================================================================
 // wxCocoaMouseMovedEventSynthesizer
 // ========================================================================
 
 // ========================================================================
 // wxCocoaMouseMovedEventSynthesizer
 // ========================================================================
 

+#define wxTRACE_COCOA_MouseMovedSynthesizer wxT("COCOA_MouseMovedSynthesizer")
+

 /* This class registers one run loop observer to cover all windows registered with it.
  *  It will register the observer when the first view is registerd and unregister the
  * observer when the last view is unregistered.
 /* This class registers one run loop observer to cover all windows registered with it.
  *  It will register the observer when the first view is registerd and unregister the
  * observer when the last view is unregistered.


@@ -1447,7 +1469,7 @@ protected:
 void wxCocoaMouseMovedEventSynthesizer::RegisterWxCocoaView(wxCocoaNSView *aView)
 {
     m_registeredViews.push_back(aView);
 void wxCocoaMouseMovedEventSynthesizer::RegisterWxCocoaView(wxCocoaNSView *aView)
 {
     m_registeredViews.push_back(aView);

-    wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Registered wxCocoaNSView=%p"), aView);
+    wxLogTrace(wxTRACE_COCOA_MouseMovedSynthesizer, wxT("Registered wxCocoaNSView=%p"), aView);

 
     if(!m_registeredViews.empty() && m_runLoopObserver == NULL)
     {
 
     if(!m_registeredViews.empty() && m_runLoopObserver == NULL)
     {


@@ -1458,7 +1480,7 @@ void wxCocoaMouseMovedEventSynthesizer::RegisterWxCocoaView(wxCocoaNSView *aView
 void wxCocoaMouseMovedEventSynthesizer::UnregisterWxCocoaView(wxCocoaNSView *aView)
 {
     m_registeredViews.remove(aView);
 void wxCocoaMouseMovedEventSynthesizer::UnregisterWxCocoaView(wxCocoaNSView *aView)
 {
     m_registeredViews.remove(aView);

-    wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Unregistered wxCocoaNSView=%p"), aView);
+    wxLogTrace(wxTRACE_COCOA_MouseMovedSynthesizer, wxT("Unregistered wxCocoaNSView=%p"), aView);

     if(m_registeredViews.empty() && m_runLoopObserver != NULL)
     {
         RemoveRunLoopObserver();
     if(m_registeredViews.empty() && m_runLoopObserver != NULL)
     {
         RemoveRunLoopObserver();


@@ -1495,7 +1517,27 @@ void wxCocoaMouseMovedEventSynthesizer::AddRunLoopObserver()
     ,   NULL
     ,   NULL
     };
     ,   NULL
     ,   NULL
     };

-    m_runLoopObserver.reset(CFRunLoopObserverCreate(kCFAllocatorDefault, kCFRunLoopBeforeWaiting, TRUE, 0, SynthesizeMouseMovedEvent, &observerContext));
+
+    // The kCFRunLoopExit observation point is used such that we hook the run loop after it has already decided that
+    // it is going to exit which is generally for the purpose of letting the event loop process the next Cocoa event.
+
+    // Executing our procedure within the run loop (e.g. kCFRunLoopBeforeWaiting which was used before) results
+    // in our observer procedure being called before the run loop has decided that it is going to return control to
+    // the Cocoa event loop.  One major problem is uncovered by the wxGenericHyperlinkCtrl (consider this to be "user
+    // code") which changes the window's cursor and thus causes the cursor rectangle's to be invalidated.
+
+    // Cocoa implements this invalidation using a delayed notification scheme whereby the resetCursorRects method
+    // won't be called until the CFRunLoop gets around to it.  If the CFRunLoop has not yet exited then it will get
+    // around to it before letting the event loop do its work.  This has some very odd effects on the way the
+    // newly created tracking rects function.  In particular, we will often miss the mouseExited: message if the
+    // user flicks the mouse quickly enough such that the mouse is already outside of the tracking rect by the
+    // time the new one is built.
+
+    // Observing from the kCFRunLoopExit point gives Cocoa's event loop an opportunity to chew some events before it cedes
+    // control back to the CFRunLoop, thus causing the delayed notifications to fire at an appropriate time and
+    // the mouseExited: message to be sent properly.
+
+    m_runLoopObserver.reset(CFRunLoopObserverCreate(kCFAllocatorDefault, kCFRunLoopExit, TRUE, 0, SynthesizeMouseMovedEvent, &observerContext));

     CFRunLoopAddObserver([[NSRunLoop currentRunLoop] getCFRunLoop], m_runLoopObserver, kCFRunLoopCommonModes);
     wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Added tracking rect run loop observer"));
 }
     CFRunLoopAddObserver([[NSRunLoop currentRunLoop] getCFRunLoop], m_runLoopObserver, kCFRunLoopCommonModes);
     wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Added tracking rect run loop observer"));
 }


@@ -1548,6 +1590,7 @@ void wxCocoaTrackingRectManager::ClearTrackingRect()
     {
         [m_window->GetNSView() removeTrackingRect:m_trackingRectTag];
         m_isTrackingRectActive = false;
     {
         [m_window->GetNSView() removeTrackingRect:m_trackingRectTag];
         m_isTrackingRectActive = false;

+        wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("%s@%p: Removed tracking rect #%d"), m_window->GetClassInfo()->GetClassName(), m_window, m_trackingRectTag);

     }
     // If we were doing periodic events we need to clear those too
     StopSynthesizingEvents();
     }
     // If we were doing periodic events we need to clear those too
     StopSynthesizingEvents();


@@ -1564,10 +1607,18 @@ void wxCocoaTrackingRectManager::BuildTrackingRect()
     wxAutoNSAutoreleasePool pool;
 
     wxASSERT_MSG(!m_isTrackingRectActive, wxT("Tracking rect was not cleared"));
     wxAutoNSAutoreleasePool pool;
 
     wxASSERT_MSG(!m_isTrackingRectActive, wxT("Tracking rect was not cleared"));

-    if([m_window->GetNSView() window] != nil)
+
+    NSView *theView = m_window->GetNSView();
+
+    if([theView window] != nil)

     {
     {

-        m_trackingRectTag = [m_window->GetNSView() addTrackingRect:[m_window->GetNSView() visibleRect] owner:m_window->GetNSView() userData:NULL assumeInside:NO];
+        NSRect visibleRect = [theView visibleRect];
+
+        m_trackingRectTag = [theView addTrackingRect:visibleRect owner:theView userData:NULL assumeInside:NO];
+        m_trackingRectInWindowCoordinates = [theView convertRect:visibleRect toView:nil];

         m_isTrackingRectActive = true;
         m_isTrackingRectActive = true;

+
+        wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("%s@%p: Added tracking rect #%d"), m_window->GetClassInfo()->GetClassName(), m_window, m_trackingRectTag);

     }
 }
 
     }
 }
 


@@ -1576,6 +1627,21 @@ void wxCocoaTrackingRectManager::BeginSynthesizingEvents()
     s_mouseMovedSynthesizer.RegisterWxCocoaView(m_window);
 }
 
     s_mouseMovedSynthesizer.RegisterWxCocoaView(m_window);
 }
 

+void wxCocoaTrackingRectManager::RebuildTrackingRectIfNeeded()
+{
+    if(m_isTrackingRectActive)
+    {
+        NSView *theView = m_window->GetNSView();
+        NSRect currentRect = [theView convertRect:[theView visibleRect] toView:nil];
+        if(NSEqualRects(m_trackingRectInWindowCoordinates,currentRect))
+        {
+            wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Ignored request to rebuild TR#%d"), m_trackingRectTag);
+            return;
+        }
+    }
+    RebuildTrackingRect();
+}
+

 void wxCocoaTrackingRectManager::RebuildTrackingRect()
 {
     ClearTrackingRect();
 void wxCocoaTrackingRectManager::RebuildTrackingRect()
 {
     ClearTrackingRect();