]> git.saurik.com Git - wxWidgets.git/blobdiff - src/cocoa/app.mm
Added extra hit test style for more accurate reporting
[wxWidgets.git] / src / cocoa / app.mm
index 58addbd3d75499ea435b2f62b70648dd7a6d4ec9..a246c4c211719a2522930e6671528acd4e36f80b 100644 (file)
@@ -1,36 +1,29 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        cocoa/app.mm
+// Name:        src/cocoa/app.mm
 // Purpose:     wxApp
 // Author:      David Elliott
 // Modified by:
 // Created:     2002/11/27
-// RCS-ID:      $Id:
+// RCS-ID:      $Id$
 // Copyright:   (c) David Elliott
-// Licence:     wxWindows license
+// Licence:     wxWidgets licence
 /////////////////////////////////////////////////////////////////////////////
 
-// ============================================================================
-// declarations
-// ============================================================================
+#include "wx/wxprec.h"
 
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
+#include "wx/app.h"
 
-#include "wx/wxprec.h"
 #ifndef WX_PRECOMP
-    #include "wx/defs.h"
-    #include "wx/app.h"
-    #include "wx/frame.h"
-    #include "wx/dialog.h"
     #include "wx/dc.h"
     #include "wx/intl.h"
     #include "wx/log.h"
+    #include "wx/module.h"
 #endif
 
-#include "wx/module.h"
-
 #include "wx/cocoa/ObjcPose.h"
+#include "wx/cocoa/autorelease.h"
+#include "wx/cocoa/mbarman.h"
+#include "wx/cocoa/NSApplication.h"
 
 #if wxUSE_WX_RESOURCES
 #  include "wx/resource.h"
 
 #import <AppKit/NSApplication.h>
 #import <Foundation/NSRunLoop.h>
-#import <Foundation/NSArray.h>
-
-// ----------------------------------------------------------------------------
-// globals
-// ----------------------------------------------------------------------------
-
+#import <Foundation/NSThread.h>
+#import <AppKit/NSEvent.h>
+#import <Foundation/NSString.h>
+#import <Foundation/NSNotification.h>
+#import <AppKit/NSCell.h>
+
+// ========================================================================
+// wxPoseAsInitializer
+// ========================================================================
 wxPoseAsInitializer *wxPoseAsInitializer::sm_first = NULL;
 
+static bool sg_needIdle = true;
+
+// ========================================================================
+// wxPoserNSApplication
+// ========================================================================
 @interface wxPoserNSApplication : NSApplication
 {
 }
 
-- (void)doIdle: (id)data;
-- (void)finishLaunching;
+- (NSEvent *)nextEventMatchingMask:(unsigned int)mask untilDate:(NSDate *)expiration inMode:(NSString *)mode dequeue:(BOOL)flag;
 - (void)sendEvent: (NSEvent*)anEvent;
-- (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication;
 @end // wxPoserNSApplication
 
+WX_IMPLEMENT_POSER(wxPoserNSApplication);
+
 @implementation wxPoserNSApplication : NSApplication
 
-- (void)doIdle: (id)data
+/* NOTE: The old method of idle event handling added the handler using the
+    [NSRunLoop -performSelector:target:argument:order:modes] which caused
+    the invocation to occur at the begining of [NSApplication
+    -nextEventMatchingMask:untilDate:expiration:inMode:dequeue:].  However,
+    the code would be scheduled for invocation with every iteration of
+    the event loop.  This new method simply overrides the method.  The
+    same caveats apply.  In particular, by the time the event loop has
+    called this method, it usually expects to receive an event.  If you
+    plan on stopping the event loop, it is wise to send an event through
+    the queue to ensure this method will return.
+    See wxEventLoop::Exit() for more information.
+
+    This overridden method calls the superclass method with an untilDate
+    parameter that indicates nil should be returned if there are no pending
+    events.  That is, nextEventMatchingMask: should not wait for an event.
+    If nil is returned then idle event processing occurs until the user
+    does not request anymore idle events or until a real event comes through.
+
+    RN: Even though Apple documentation states that nil can be passed in place
+    of [NSDate distantPast] in the untilDate parameter, this causes Jaguar (10.2)
+    to get stuck in some kind of loop deep within nextEventMatchingMask:, thus we
+    need to explicitly pass [NSDate distantPast] instead.
+*/
+
+- (NSEvent *)nextEventMatchingMask:(unsigned int)mask untilDate:(NSDate *)expiration inMode:(NSString *)mode dequeue:(BOOL)flag
 {
-    wxASSERT(wxTheApp);
-    wxLogDebug("doIdle called");
-    NSRunLoop *rl = [NSRunLoop currentRunLoop];
-    // runMode: beforeDate returns YES if something was done
-    while(wxTheApp->ProcessIdle()) // FIXME: AND NO EVENTS ARE PENDING
+    // Get the same events except don't block
+    NSEvent *event = [super nextEventMatchingMask:mask untilDate:[NSDate distantPast] inMode:mode dequeue:flag];
+    // If we got one, simply return it
+    if(event)
+        return event;
+    // No events, try doing some idle stuff
+    if(sg_needIdle
+#ifdef __WXDEBUG__
+        && !wxTheApp->IsInAssert()
+#endif
+        && ([NSDefaultRunLoopMode isEqualToString:mode] || [NSModalPanelRunLoopMode isEqualToString:mode]))
     {
-        wxLogDebug("Looping for idle events");
-        #if 1
-        if( [rl runMode:[rl currentMode] beforeDate:[NSDate distantPast]])
+        sg_needIdle = false;
+        wxLogTrace(wxTRACE_COCOA,wxT("Processing idle events"));
+        while(wxTheApp->ProcessIdle())
         {
-            wxLogDebug("Found actual work to do");
-            break;
+            // Get the same events except don't block
+            NSEvent *event = [super nextEventMatchingMask:mask untilDate:[NSDate distantPast] inMode:mode dequeue:flag];
+            // If we got one, simply return it
+            if(event)
+                return event;
+            // we didn't get one, do some idle work
+            wxLogTrace(wxTRACE_COCOA,wxT("Looping idle events"));
         }
-        #endif
+        // No more idle work requested, block
+        wxLogTrace(wxTRACE_COCOA,wxT("Finished idle processing"));
     }
-    wxLogDebug("Idle processing complete, requesting next idle event");
-    // Add ourself back into the run loop (on next event) if necessary
-    wxTheApp->CocoaRequestIdle();
-}
-
-- (void)finishLaunching
-{
-    wxLogDebug("finishLaunching");
-    bool initsuccess = wxTheApp->OnInit();
-    if(!initsuccess)
-        [super stop: NULL];
-
-    [super finishLaunching];
+    else
+        wxLogTrace(wxTRACE_COCOA,wxT("Avoiding idle processing sg_needIdle=%d"),sg_needIdle);
+    return [super nextEventMatchingMask:mask untilDate:expiration inMode:mode dequeue:flag];
 }
 
 - (void)sendEvent: (NSEvent*)anEvent
 {
-    wxLogDebug("SendEvent");
-    wxTheApp->CocoaInstallRequestedIdleHandler();
+    wxLogTrace(wxTRACE_COCOA,wxT("SendEvent"));
+    sg_needIdle = true;
     [super sendEvent: anEvent];
 }
 
+@end // wxPoserNSApplication
+
+// ========================================================================
+// wxNSApplicationDelegate
+// ========================================================================
+@implementation wxNSApplicationDelegate : NSObject
+
+// NOTE: Terminate means that the event loop does NOT return and thus
+// cleanup code doesn't properly execute.  Furthermore, wxWidgets has its
+// own exit on frame delete mechanism.
 - (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication
 {
-    BOOL ret = wxTheApp->GetExitOnFrameDelete();
-    wxLogDebug("applicationShouldTermintaeAfterLastWindowClosed=%d",ret);
-    return ret;
+    return NO;
 }
 
-@end // wxPoserNSApplication
-WX_IMPLEMENT_POSER(wxPoserNSApplication);
+- (void)applicationWillBecomeActive:(NSNotification *)notification
+{
+    wxTheApp->CocoaDelegate_applicationWillBecomeActive();
+}
 
-// ============================================================================
-// functions
-// ============================================================================
+- (void)applicationDidBecomeActive:(NSNotification *)notification
+{
+    wxTheApp->CocoaDelegate_applicationDidBecomeActive();
+}
 
-void wxApp::Exit()
+- (void)applicationWillResignActive:(NSNotification *)notification
 {
-    wxApp::CleanUp();
+    wxTheApp->CocoaDelegate_applicationWillResignActive();
+}
 
-    wxAppConsole::Exit();
+- (void)applicationDidResignActive:(NSNotification *)notification
+{
+    wxTheApp->CocoaDelegate_applicationDidResignActive();
 }
 
-// ============================================================================
-// wxApp implementation
-// ============================================================================
+- (void)controlTintChanged:(NSNotification *)notification
+{
+    wxLogDebug(wxT("TODO: send EVT_SYS_COLOUR_CHANGED as appropriate"));
+}
+
+@end // implementation wxNSApplicationDelegate : NSObject
+
+// ========================================================================
+// wxApp
+// ========================================================================
 
 // ----------------------------------------------------------------------------
 // wxApp Static member initialization
 // ----------------------------------------------------------------------------
-
-#if !USE_SHARED_LIBRARY
 IMPLEMENT_DYNAMIC_CLASS(wxApp, wxEvtHandler)
 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
-    EVT_IDLE(wxApp::OnIdle)
+    EVT_IDLE(wxAppBase::OnIdle)
 //    EVT_END_SESSION(wxApp::OnEndSession)
 //    EVT_QUERY_END_SESSION(wxApp::OnQueryEndSession)
 END_EVENT_TABLE()
-#endif
 
 // ----------------------------------------------------------------------------
 // wxApp initialization/cleanup
 // ----------------------------------------------------------------------------
-
 bool wxApp::Initialize(int& argc, wxChar **argv)
 {
+    wxAutoNSAutoreleasePool pool;
+    m_cocoaMainThread = [NSThread currentThread];
     // Mac OS X passes a process serial number command line argument when
     // the application is launched from the Finder. This argument must be
     // removed from the command line arguments before being handled by the
@@ -148,17 +194,16 @@ bool wxApp::Initialize(int& argc, wxChar **argv)
     if ( argc > 1 )
     {
         static const wxChar *ARG_PSN = _T("-psn_");
-        if ( wxStrncmp(argv[1], ARG_PSN, sizeof(ARG_PSN) - 1) == 0 )
+        if ( wxStrncmp(argv[1], ARG_PSN, wxStrlen(ARG_PSN)) == 0 )
         {
             // remove this argument
-            memmove(argv, argv + 1, argc--);
+            --argc;
+            memmove(argv + 1, argv + 2, argc * sizeof(wxChar *));
         }
     }
 
-    // VZ: apparently this needs to be done a.s.a.p., right? it is done after
-    //     wxClassInfo::InitializeClasses() now but usd to be done before, I
-    //     hope it's not a problem -- if it is, please let me know, David (if
-    //     it isn't, just remove this comment :-)
+    // Posing must be completed before any instances of the Objective-C
+    // classes being posed as are created.
     wxPoseAsInitializer::InitializePosers();
 
     return wxAppBase::Initialize(argc, argv);
@@ -166,7 +211,16 @@ bool wxApp::Initialize(int& argc, wxChar **argv)
 
 void wxApp::CleanUp()
 {
+    wxAutoNSAutoreleasePool pool;
+
     wxDC::CocoaShutdownTextSystem();
+    wxMenuBarManager::DestroyInstance();
+
+    [m_cocoaApp setDelegate:nil];
+    [[NSNotificationCenter defaultCenter] removeObserver:m_cocoaAppDelegate
+        name:NSControlTintDidChangeNotification object:nil];
+    [m_cocoaAppDelegate release];
+    m_cocoaAppDelegate = NULL;
 
     wxAppBase::CleanUp();
 }
@@ -174,177 +228,79 @@ void wxApp::CleanUp()
 // ----------------------------------------------------------------------------
 // wxApp creation
 // ----------------------------------------------------------------------------
-
 wxApp::wxApp()
 {
     m_topWindow = NULL;
-    wxTheApp = this;
 
-    m_isIdle = true;
-#if WXWIN_COMPATIBILITY_2_2
-    m_wantDebugOutput = TRUE;
-#endif
+#ifdef __WXDEBUG__
+    m_isInAssert = false;
+#endif // __WXDEBUG__
 
     argc = 0;
     argv = NULL;
     m_cocoaApp = NULL;
+    m_cocoaAppDelegate = NULL;
 }
 
-void wxApp::CocoaInstallIdleHandler()
-{
-    wxLogDebug("wxApp::CocoaInstallIdleHandler");
-    m_isIdle = false;
-    // Call doIdle for EVERYTHING dammit
-// We'd need Foundation/NSConnection.h for this next constant, do we need it?
-    [[ NSRunLoop currentRunLoop ] performSelector:@selector(doIdle:) target:m_cocoaApp argument:NULL order:0 modes:[NSArray arrayWithObjects:NSDefaultRunLoopMode, /* NSConnectionReplyRunLoopMode,*/ NSModalPanelRunLoopMode, /**/NSEventTrackingRunLoopMode,/**/ nil] ];
-}
-
-bool wxApp::OnInitGui()
+void wxApp::CocoaDelegate_applicationWillBecomeActive()
 {
-    if(!wxAppBase::OnInitGui())
-        return FALSE;
-
-    // Create the app using the sharedApplication method
-    m_cocoaApp = [NSApplication sharedApplication];
-    wxDC::CocoaInitializeTextSystem();
-//    [ m_cocoaApp setDelegate:m_cocoaApp ];
-    #if 0
-    wxLogDebug("Just for kicks");
-    [ m_cocoaApp performSelector:@selector(doIdle:) withObject:NULL ];
-    wxLogDebug("okay.. done now");
-    #endif
-    return TRUE;
 }
 
-bool wxApp::OnInit()
+void wxApp::CocoaDelegate_applicationDidBecomeActive()
 {
-    if(!wxAppBase::OnInit())
-        return FALSE;
-
-    return TRUE;
 }
 
-bool wxApp::Initialized()
+void wxApp::CocoaDelegate_applicationWillResignActive()
 {
-  if (GetTopWindow())
-    return TRUE;
-  else
-    return FALSE;
+    wxTopLevelWindowCocoa::DeactivatePendingWindow();
 }
 
-int wxApp::MainLoop()
+void wxApp::CocoaDelegate_applicationDidResignActive()
 {
-    [m_cocoaApp run];
-    return 0;
 }
 
-// Returns TRUE if more time is needed.
-bool wxApp::ProcessIdle()
+bool wxApp::OnInitGui()
 {
-    wxIdleEvent event;
-    event.SetEventObject(this);
-    ProcessEvent(event);
-
-    return event.MoreRequested();
-}
+    wxAutoNSAutoreleasePool pool;
+    if(!wxAppBase::OnInitGui())
+        return false;
 
-void wxApp::ExitMainLoop()
-{
-    wxLogDebug("wxApp::ExitMailLoop m_isIdle=%d, isRunning=%d",(int)m_isIdle,(int)[m_cocoaApp isRunning]);
-//    CocoaInstallRequestedIdleHandler();
-//    if(m_isIdle)
-//        [[ NSRunLoop currentRunLoop ] performSelector:@selector(doIdle:) target:m_cocoaApp argument:NULL order:0 modes:[NSArray arrayWithObjects:NSDefaultRunLoopMode, /* NSConnectionReplyRunLoopMode, NSModalPanelRunLoopMode, NSEventTrackingRunLoopMode,*/ nil] ];
-// actually.. we WANT the idle event
-// or not
-#if 0
-    if(!m_isIdle)
-        [[ NSRunLoop currentRunLoop ] cancelPerformSelector:@selector(doIdle:) target:m_cocoaApp argument:NULL];
-#endif
-    [m_cocoaApp terminate: m_cocoaApp];
-}
+    // Create the app using the sharedApplication method
+    m_cocoaApp = [NSApplication sharedApplication];
+    m_cocoaAppDelegate = [[wxNSApplicationDelegate alloc] init];
+    [m_cocoaApp setDelegate:m_cocoaAppDelegate];
+    [[NSNotificationCenter defaultCenter] addObserver:m_cocoaAppDelegate
+        selector:@selector(controlTintChanged:)
+        name:NSControlTintDidChangeNotification object:nil];
 
-// Is a message/event pending?
-bool wxApp::Pending()
-{
-    return 0;
-}
+    wxMenuBarManager::CreateInstance();
 
-// Dispatch a message.
-void wxApp::Dispatch()
-{
+    wxDC::CocoaInitializeTextSystem();
+    return true;
 }
 
-void wxApp::OnIdle(wxIdleEvent& event)
+bool wxApp::CallOnInit()
 {
-    wxLogDebug("wxApp::OnIdle");
-   static bool s_inOnIdle = FALSE;
-
-    // Avoid recursion (via ProcessEvent default case)
-    if ( s_inOnIdle )
-        return;
-    s_inOnIdle = TRUE;
-
-
-    DeletePendingObjects();
-
-    // flush the logged messages if any
-    wxLog *pLog = wxLog::GetActiveTarget();
-    if ( pLog != NULL && pLog->HasPendingMessages() )
-        pLog->Flush();
-
-    // Send OnIdle events to all windows
-    bool needMore = SendIdleEvents();
-
-    if (needMore)
-      event.RequestMore(TRUE);
-
-    s_inOnIdle = FALSE;
+//    wxAutoNSAutoreleasePool pool;
+    return OnInit();
 }
 
-// Send idle event to all top-level windows
-bool wxApp::SendIdleEvents()
+bool wxApp::OnInit()
 {
-    bool needMore = FALSE;
-    wxWindowList::Node* node = wxTopLevelWindows.GetFirst();
-    while (node)
-    {
-        wxWindow* win = node->GetData();
-        if (SendIdleEvents(win))
-            needMore = TRUE;
+    if(!wxAppBase::OnInit())
+        return false;
 
-        node = node->GetNext();
-    }
-    return needMore;
+    return true;
 }
 
-// Send idle event to window and all subwindows
-bool wxApp::SendIdleEvents(wxWindow* win)
+void wxApp::Exit()
 {
-//    wxLogDebug("SendIdleEvents win=%p",win);
-    bool needMore = FALSE;
-
-    wxIdleEvent event;
-    event.SetEventObject(win);
-    win->ProcessEvent(event);
-
-    if (event.MoreRequested())
-        needMore = TRUE;
-
-    wxWindowList::Node* node = win->GetChildren().GetFirst();
-    while (node)
-    {
-//        wxLogDebug("child=%p",node->Data());
-        wxWindow* win = node->GetData();
-        if (SendIdleEvents(win))
-            needMore = TRUE;
+    wxApp::CleanUp();
 
-        node = node->GetNext();
-    }
-    return needMore;
+    wxAppConsole::Exit();
 }
 
 // Yield to other processes
-
 bool wxApp::Yield(bool onlyIfNeeded)
 {
     // MT-FIXME
@@ -368,8 +324,19 @@ bool wxApp::Yield(bool onlyIfNeeded)
 
     s_inYield = true;
 
-    wxLogDebug("WARNING: SUPPOSED to have yielded!");
-    // FIXME: Do something!
+    // Run the event loop until it is out of events
+    while(1)
+    {
+        wxAutoNSAutoreleasePool pool;
+        NSEvent *event = [GetNSApplication()
+                nextEventMatchingMask:NSAnyEventMask
+                untilDate:[NSDate distantPast]
+                inMode:NSDefaultRunLoopMode
+                dequeue: YES];
+        if(!event)
+            break;
+        [GetNSApplication() sendEvent: event];
+    }
 
 #if wxUSE_LOG
     // let the logs be flashed again
@@ -381,3 +348,19 @@ bool wxApp::Yield(bool onlyIfNeeded)
     return true;
 }
 
+void wxApp::WakeUpIdle()
+{
+    [m_cocoaApp postEvent:[NSEvent otherEventWithType:NSApplicationDefined
+            location:NSZeroPoint modifierFlags:NSAnyEventMask
+            timestamp:0 windowNumber:0 context:nil
+            subtype:0 data1:0 data2:0] atStart:NO];
+}
+
+#ifdef __WXDEBUG__
+void wxApp::OnAssert(const wxChar *file, int line, const wxChar* cond, const wxChar *msg)
+{
+    m_isInAssert = true;
+    wxAppBase::OnAssert(file, line, cond, msg);
+    m_isInAssert = false;
+}
+#endif // __WXDEBUG__