Changes corresponding to patch #841324 from Ian Brown:

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

diff --git a/src/cocoa/app.mm b/src/cocoa/app.mm
index 58addbd3d75499ea435b2f62b70648dd7a6d4ec9..4ef6974b2f2e35d669e9d4938c522237d9ca8a1e 100644 (file)
--- a/src/cocoa/app.mm
+++ b/src/cocoa/app.mm
@@ -4,19 +4,11 @@
 // Author:      David Elliott
 // Modified by:
 // Created:     2002/11/27
 // Author:      David Elliott
 // Modified by:
 // Created:     2002/11/27

-// RCS-ID:      $Id:
+// RCS-ID:      $Id$

 // Copyright:   (c) David Elliott
 // Copyright:   (c) David Elliott

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-

 #include "wx/wxprec.h"
 #ifndef WX_PRECOMP
     #include "wx/defs.h"
 #include "wx/wxprec.h"
 #ifndef WX_PRECOMP
     #include "wx/defs.h"


@@ -31,6 +23,8 @@
 #include "wx/module.h"
 
 #include "wx/cocoa/ObjcPose.h"
 #include "wx/module.h"
 
 #include "wx/cocoa/ObjcPose.h"

+#include "wx/cocoa/autorelease.h"
+#include "wx/cocoa/mbarman.h"

 
 #if wxUSE_WX_RESOURCES
 #  include "wx/resource.h"
 
 #if wxUSE_WX_RESOURCES
 #  include "wx/resource.h"


@@ -39,108 +33,139 @@
 #import <AppKit/NSApplication.h>
 #import <Foundation/NSRunLoop.h>
 #import <Foundation/NSArray.h>
 #import <AppKit/NSApplication.h>
 #import <Foundation/NSRunLoop.h>
 #import <Foundation/NSArray.h>

+#import <Foundation/NSAutoreleasePool.h>
+#import <Foundation/NSThread.h>
+#import <AppKit/NSEvent.h>

 
 

-// ----------------------------------------------------------------------------
-// globals
-// ----------------------------------------------------------------------------
-
+// ========================================================================
+// wxPoseAsInitializer
+// ========================================================================

 wxPoseAsInitializer *wxPoseAsInitializer::sm_first = NULL;
 
 wxPoseAsInitializer *wxPoseAsInitializer::sm_first = NULL;
 

+// ========================================================================
+// wxPoserNSApplication
+// ========================================================================

 @interface wxPoserNSApplication : NSApplication
 {
 }
 
 @interface wxPoserNSApplication : NSApplication
 {
 }
 

-- (void)doIdle: (id)data;
-- (void)finishLaunching;

 - (void)sendEvent: (NSEvent*)anEvent;
 - (void)sendEvent: (NSEvent*)anEvent;

-- (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication;

 @end // wxPoserNSApplication
 
 @end // wxPoserNSApplication
 

+WX_IMPLEMENT_POSER(wxPoserNSApplication);
+

 @implementation wxPoserNSApplication : NSApplication
 
 @implementation wxPoserNSApplication : NSApplication
 

+- (void)sendEvent: (NSEvent*)anEvent
+{
+    wxLogDebug("SendEvent");
+    wxTheApp->CocoaInstallRequestedIdleHandler();
+    [super sendEvent: anEvent];
+}
+
+@end // wxPoserNSApplication
+
+// ========================================================================
+// wxNSApplicationDelegate
+// ========================================================================
+@interface wxNSApplicationDelegate : NSObject
+{
+}
+
+- (void)doIdle: (id)data;
+// Delegate methods
+- (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication;
+- (void)applicationWillBecomeActive:(NSNotification *)notification;
+- (void)applicationDidBecomeActive:(NSNotification *)notification;
+- (void)applicationWillResignActive:(NSNotification *)notification;
+- (void)applicationDidResignActive:(NSNotification *)notification;
+@end // interface wxNSApplicationDelegate : NSObject
+
+@implementation wxNSApplicationDelegate : NSObject
+

 - (void)doIdle: (id)data
 {
     wxASSERT(wxTheApp);
 - (void)doIdle: (id)data
 {
     wxASSERT(wxTheApp);

+    wxASSERT(wxMenuBarManager::GetInstance());

     wxLogDebug("doIdle called");
     wxLogDebug("doIdle called");

-    NSRunLoop *rl = [NSRunLoop currentRunLoop];
-    // runMode: beforeDate returns YES if something was done
-    while(wxTheApp->ProcessIdle()) // FIXME: AND NO EVENTS ARE PENDING
+#ifdef __WXDEBUG__
+    if(wxTheApp->IsInAssert())

     {
     {

-        wxLogDebug("Looping for idle events");
-        #if 1
-        if( [rl runMode:[rl currentMode] beforeDate:[NSDate distantPast]])
+        wxLogDebug("Idle events ignored durring assertion dialog");
+    }
+    else
+#endif
+    {
+        NSRunLoop *rl = [NSRunLoop currentRunLoop];
+        // runMode: beforeDate returns YES if something was done
+        while(wxTheApp->ProcessIdle()) // FIXME: AND NO EVENTS ARE PENDING

         {
         {

-            wxLogDebug("Found actual work to do");
-            break;
+            wxLogDebug("Looping for idle events");
+            #if 1
+            if( [rl runMode:[rl currentMode] beforeDate:[NSDate distantPast]])
+            {
+                wxLogDebug("Found actual work to do");
+                break;
+            }
+            #endif

         }
         }

-        #endif

     }
     wxLogDebug("Idle processing complete, requesting next idle event");
     // Add ourself back into the run loop (on next event) if necessary
     wxTheApp->CocoaRequestIdle();
 }
 
     }
     wxLogDebug("Idle processing complete, requesting next idle event");
     // Add ourself back into the run loop (on next event) if necessary
     wxTheApp->CocoaRequestIdle();
 }
 

-- (void)finishLaunching
+// NOTE: Terminate means that the event loop does NOT return and thus
+// cleanup code doesn't properly execute.  Furthermore, wxWindows has its
+// own exit on frame delete mechanism.
+- (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication

 {
 {

-    wxLogDebug("finishLaunching");
-    bool initsuccess = wxTheApp->OnInit();
-    if(!initsuccess)
-        [super stop: NULL];
-
-    [super finishLaunching];
+    return NO;

 }
 
 }
 

-- (void)sendEvent: (NSEvent*)anEvent
+- (void)applicationWillBecomeActive:(NSNotification *)notification

 {
 {

-    wxLogDebug("SendEvent");
-    wxTheApp->CocoaInstallRequestedIdleHandler();
-    [super sendEvent: anEvent];
+    wxTheApp->CocoaDelegate_applicationWillBecomeActive();

 }
 
 }
 

-- (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)theApplication
+- (void)applicationDidBecomeActive:(NSNotification *)notification

 {
 {

-    BOOL ret = wxTheApp->GetExitOnFrameDelete();
-    wxLogDebug("applicationShouldTermintaeAfterLastWindowClosed=%d",ret);
-    return ret;
+    wxTheApp->CocoaDelegate_applicationDidBecomeActive();

 }
 
 }
 

-@end // wxPoserNSApplication
-WX_IMPLEMENT_POSER(wxPoserNSApplication);
-
-// ============================================================================
-// functions
-// ============================================================================
-
-void wxApp::Exit()
+- (void)applicationWillResignActive:(NSNotification *)notification

 {
 {

-    wxApp::CleanUp();
+    wxTheApp->CocoaDelegate_applicationWillResignActive();
+}

 
 

-    wxAppConsole::Exit();
+- (void)applicationDidResignActive:(NSNotification *)notification
+{
+    wxTheApp->CocoaDelegate_applicationDidResignActive();

 }
 
 }
 

-// ============================================================================
-// wxApp implementation
-// ============================================================================
+@end // implementation wxNSApplicationDelegate : NSObject
+
+// ========================================================================
+// wxApp
+// ========================================================================

 
 // ----------------------------------------------------------------------------
 // wxApp Static member initialization
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxApp Static member initialization
 // ----------------------------------------------------------------------------

-
-#if !USE_SHARED_LIBRARY

 IMPLEMENT_DYNAMIC_CLASS(wxApp, wxEvtHandler)
 BEGIN_EVENT_TABLE(wxApp, wxEvtHandler)
 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()
 //    EVT_END_SESSION(wxApp::OnEndSession)
 //    EVT_QUERY_END_SESSION(wxApp::OnQueryEndSession)
 END_EVENT_TABLE()

-#endif

 
 // ----------------------------------------------------------------------------
 // wxApp initialization/cleanup
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxApp initialization/cleanup
 // ----------------------------------------------------------------------------

-

 bool wxApp::Initialize(int& argc, wxChar **argv)
 {
 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
     // 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 +173,16 @@ bool wxApp::Initialize(int& argc, wxChar **argv)
     if ( argc > 1 )
     {
         static const wxChar *ARG_PSN = _T("-psn_");
     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, strlen(ARG_PSN)) == 0 )

         {
             // remove this argument
         {
             // remove this argument

-            memmove(argv, argv + 1, argc--);
+            --argc;
+            memmove(argv + 1, argv + 2, argc * sizeof(char *));

         }
     }
 
         }
     }
 

-    // 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);
     wxPoseAsInitializer::InitializePosers();
 
     return wxAppBase::Initialize(argc, argv);


@@ -166,7 +190,14 @@ bool wxApp::Initialize(int& argc, wxChar **argv)
 
 void wxApp::CleanUp()
 {
 
 void wxApp::CleanUp()
 {

+    wxAutoNSAutoreleasePool pool;
+

     wxDC::CocoaShutdownTextSystem();
     wxDC::CocoaShutdownTextSystem();

+    wxMenuBarManager::DestroyInstance();
+
+    [m_cocoaApp setDelegate:nil];
+    [m_cocoaAppDelegate release];
+    m_cocoaAppDelegate = NULL;

 
     wxAppBase::CleanUp();
 }
 
     wxAppBase::CleanUp();
 }


@@ -174,177 +205,114 @@ void wxApp::CleanUp()
 // ----------------------------------------------------------------------------
 // wxApp creation
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxApp creation
 // ----------------------------------------------------------------------------

-

 wxApp::wxApp()
 {
     m_topWindow = NULL;
 wxApp::wxApp()
 {
     m_topWindow = NULL;

-    wxTheApp = this;

 
     m_isIdle = true;
 #if WXWIN_COMPATIBILITY_2_2
     m_wantDebugOutput = TRUE;
 #endif
 
     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;
 
     argc = 0;
     argv = NULL;
     m_cocoaApp = NULL;

+    m_cocoaAppDelegate = NULL;

 }
 
 void wxApp::CocoaInstallIdleHandler()
 {
 }
 
 void wxApp::CocoaInstallIdleHandler()
 {

+    // If we're not the main thread, don't install the idle handler
+    if(m_cocoaMainThread != [NSThread currentThread])
+    {
+        wxLogDebug("Attempt to install idle handler from secondary thread");
+        return;
+    }
+    // If we're supposed to be stopping, don't add more idle events
+    if(![m_cocoaApp isRunning])
+        return;

     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?
     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] ];
+    [[ NSRunLoop currentRunLoop ] performSelector:@selector(doIdle:) target:m_cocoaAppDelegate argument:NULL order:0 modes:[NSArray arrayWithObjects:NSDefaultRunLoopMode, /* NSConnectionReplyRunLoopMode,*/ NSModalPanelRunLoopMode, /**/NSEventTrackingRunLoopMode,/**/ nil] ];
+    /* Notes:
+    In the Mac OS X implementation of Cocoa, the above method schedules
+    doIdle: to be called from *within* [NSApplication
+    -nextEventMatchingMask:untilDate:inMode:dequeue:].  That is, no
+    NSEvent object is generated and control does not return from that
+    method.  In fact, control will only return from that method for the
+    usual reasons (e.g. a real event is received or the untilDate is reached).
+    This has implications when trying to stop the event loop and return to
+    its caller.  See wxEventLoop::Exit
+    */

 }
 
 }
 

-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];

 
 

-// Is a message/event pending?
-bool wxApp::Pending()
-{
-    return 0;
-}
+    wxMenuBarManager::CreateInstance();

 
 

-// Dispatch a message.
-void wxApp::Dispatch()
-{
+    wxDC::CocoaInitializeTextSystem();
+//    [ m_cocoaApp setDelegate:m_cocoaApp ];
+    #if 0
+    wxLogDebug("Just for kicks");
+    [ m_cocoaAppDelegate performSelector:@selector(doIdle:) withObject:NULL ];
+    wxLogDebug("okay.. done now");
+    #endif
+    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
 }
 
 // Yield to other processes

-

 bool wxApp::Yield(bool onlyIfNeeded)
 {
     // MT-FIXME
 bool wxApp::Yield(bool onlyIfNeeded)
 {
     // MT-FIXME


@@ -368,8 +336,15 @@ bool wxApp::Yield(bool onlyIfNeeded)
 
     s_inYield = true;
 
 
     s_inYield = true;
 

-    wxLogDebug("WARNING: SUPPOSED to have yielded!");
-    // FIXME: Do something!
+    // Run the event loop until it is out of events
+    while(NSEvent *event = [GetNSApplication()
+                nextEventMatchingMask:NSAnyEventMask
+                untilDate:[NSDate distantPast]
+                inMode:NSDefaultRunLoopMode
+                dequeue: YES])
+    {
+        [GetNSApplication() sendEvent: event];
+    }

 
 #if wxUSE_LOG
     // let the logs be flashed again
 
 #if wxUSE_LOG
     // let the logs be flashed again


@@ -381,3 +356,12 @@ bool wxApp::Yield(bool onlyIfNeeded)
     return true;
 }
 
     return true;
 }
 

+#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__
+