Mac: reform our shutdown routine.

chrome/browser/app_controller_mac.mm

-// Copyright (c) 2009 The Chromium Authors. All rights reserved.
+// Copyright (c) 2010 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "chrome/browser/app_controller_mac.h"
 
 #include "app/l10n_util_mac.h"
 #include "base/auto_reset.h"
 #include "base/command_line.h"
 #include "base/mac_util.h"
 #include "base/message_loop.h"
@@ skipping 119 matching lines @@
 
   // Sync after a delay avoid I/O contention on startup; 1500 ms is plenty.
   ChromeThread::PostDelayedTask(ChromeThread::FILE, FROM_HERE,
                                 new PrefsSyncTask(), 1500);
 }
 
 }  // anonymous namespace
 
 @interface AppController(Private)
 - (void)initMenuState;
+- (void)handleQuitEvent:(NSAppleEventDescriptor*)event
+              withReply:(NSAppleEventDescriptor*)reply;
 - (void)openUrls:(const std::vector<GURL>&)urls;
 - (void)getUrl:(NSAppleEventDescriptor*)event
      withReply:(NSAppleEventDescriptor*)reply;
 - (void)windowLayeringDidChange:(NSNotification*)inNotification;
 - (BOOL)userWillWaitForInProgressDownloads:(int)downloadCount;
 - (BOOL)shouldQuitWithInProgressDownloads;
 - (void)showPreferencesWindow:(id)sender
                          page:(OptionsPage)page
                       profile:(Profile*)profile;
 @end
@@ skipping 59 matching lines @@
   // BrowserWindow::Activate() calls ::SetForegroundWindow() which is
   // adequate.  On Mac, BrowserWindow::Activate() calls -[NSWindow
   // makeKeyAndOrderFront:] which does not activate the application
   // itself.
   const CommandLine& parsed_command_line = *CommandLine::ForCurrentProcess();
   if (parsed_command_line.HasSwitch(switches::kActivateOnLaunch)) {
     [NSApp activateIgnoringOtherApps:YES];
   }
 }
 
+// (NSApplicationDelegate protocol) This is the Apple-approved place to override
+// the default handlers.
+- (void)applicationWillFinishLaunching:(NSNotification*)notification {
+  NSAppleEventManager* em = [NSAppleEventManager sharedAppleEventManager];
+  [em setEventHandler:self
+          andSelector:@selector(handleQuitEvent:withReply:)
+        forEventClass:kCoreEventClass
+           andEventID:kAEQuitApplication];
+}
+
+// (NSApplicationDelegate protocol) Our mechanism for application termination
+// does not go through |-applicationShouldTerminate:|, so it should not be
+// called. In a release build, cancelling termination will prevent a crash (but
+// if things go really wrong, the user may have to force-terminate the
+// application).
 - (NSApplicationTerminateReply)applicationShouldTerminate:
-    (NSApplication *)sender {
-  // Check for in-progress downloads, and prompt the user if they really want to
-  // quit (and thus cancel the downloads).
-  if (![self shouldQuitWithInProgressDownloads])
-    return NSTerminateCancel;
+    (NSApplication*)sender {
+  NOTREACHED();
+  return NSTerminateCancel;
+}
 
-  return NSTerminateNow;
+- (BOOL)tryToTerminateApplication:(NSApplication*)app {
+  // Set the state to "trying to quit", so that closing all browser windows will
+  // lead to termination.
+  browser_shutdown::SetTryingToQuit(true);
+
+  // TODO(viettrungluu): Remove Apple Event handlers here? (It's safe to leave
+  // them in, but I'm not sure about UX; we'd also want to disable other things
+  // though.) http://crbug.com/40861
+
+  if (!BrowserList::size())
+    return YES;
+
+  // Try to close all the windows.
+  BrowserList::CloseAllBrowsers(true);
+
+  return NO;
+}
+
+- (void)stopTryingToTerminateApplication:(NSApplication*)app {
+  if (browser_shutdown::IsTryingToQuit()) {
+    // Reset the "trying to quit" state, so that closing all browser windows
+    // will no longer lead to termination.
+    browser_shutdown::SetTryingToQuit(false);
+
+    // TODO(viettrungluu): Were we to remove Apple Event handlers above, we
+    // would have to reinstall them here. http://crbug.com/40861
+  }
 }
 
 // Called when the app is shutting down. Clean-up as appropriate.
-- (void)applicationWillTerminate:(NSNotification *)aNotification {
+- (void)applicationWillTerminate:(NSNotification*)aNotification {
   NSAppleEventManager* em = [NSAppleEventManager sharedAppleEventManager];
   [em removeEventHandlerForEventClass:kInternetEventClass
                            andEventID:kAEGetURL];
   [em removeEventHandlerForEventClass:'WWW!'
                            andEventID:'OURL'];
 
-  // Close all the windows.
-  BrowserList::CloseAllBrowsers(true);
-
-  // On Windows, this is done in Browser::OnWindowClosing, but that's not
-  // appropriate on Mac since we don't shut down when we reach zero windows.
-  browser_shutdown::OnShutdownStarting(browser_shutdown::BROWSER_EXIT);
+  // There better be no browser windows left at this point.
+  CHECK_EQ(BrowserList::size(), 0u);
 
   // Release the reference to the browser process. Once all the browsers get
   // dealloc'd, it will stop the RunLoop and fall back into main().
   g_browser_process->ReleaseModule();
 
   // Close these off if they have open windows.
   [prefsController_ close];
   [aboutController_ close];
 
   [[NSNotificationCenter defaultCenter] removeObserver:self];
@@ skipping 134 matching lines @@
 // 1) Same spot as other Pref stuff
 // 2) Try and be friendly by keeping this after app launch
 // TODO(jrg): remove once we go Beta.
 - (void)setUpdateCheckInterval {
 #if defined(GOOGLE_CHROME_BUILD)
   CFStringRef app = (CFStringRef)@"com.google.Keystone.Agent";
   CFStringRef checkInterval = (CFStringRef)@"checkInterval";
   CFPropertyListRef plist = CFPreferencesCopyAppValue(checkInterval, app);
   if (!plist) {
     const float fiveHoursInSeconds = 5.0 * 60.0 * 60.0;
-    NSNumber *value = [NSNumber numberWithFloat:fiveHoursInSeconds];
+    NSNumber* value = [NSNumber numberWithFloat:fiveHoursInSeconds];
     CFPreferencesSetAppValue(checkInterval, value, app);
     CFPreferencesAppSynchronize(app);
   }
 #endif
 }
 
 // This is called after profiles have been loaded and preferences registered.
 // It is safe to access the default profile here.
 - (void)applicationDidFinishLaunching:(NSNotification*)notify {
   // Hold an extra ref to the BrowserProcess singleton so it doesn't go away
   // when all the browser windows get closed. We'll release it on quit which
   // will be the signal to exit.
   DCHECK(g_browser_process);
   g_browser_process->AddRefModule();
 
   bookmarkMenuBridge_.reset(new BookmarkMenuBridge([self defaultProfile]));
   historyMenuBridge_.reset(new HistoryMenuBridge([self defaultProfile]));
 
   [self setUpdateCheckInterval];
 
   // Build up the encoding menu, the order of the items differs based on the
   // current locale (see http://crbug.com/7647 for details).
   // We need a valid g_browser_process to get the profile which is why we can't
   // call this from awakeFromNib.
   NSMenu* view_menu = [[[NSApp mainMenu] itemWithTag:IDC_VIEW_MENU] submenu];
   NSMenuItem* encoding_menu_item = [view_menu itemWithTag:IDC_ENCODING_MENU];
-  NSMenu *encoding_menu = [encoding_menu_item submenu];
+  NSMenu* encoding_menu = [encoding_menu_item submenu];
   EncodingMenuControllerDelegate::BuildEncodingMenu([self defaultProfile],
                                                     encoding_menu);
 
   // Since Chrome is localized to more languages than the OS, tell Cocoa which
   // menu is the Help so it can add the search item to it.
   if (helpMenu_ && [NSApp respondsToSelector:@selector(setHelpMenu:)])
     [NSApp setHelpMenu:helpMenu_];
 
   // Record the path to the (browser) app bundle; this is used by the app mode
   // shim.
@@ skipping 359 matching lines @@
 }
 
 - (Profile*)defaultProfile {
   // TODO(jrg): Find a better way to get the "default" profile.
   if (g_browser_process->profile_manager())
     return *g_browser_process->profile_manager()->begin();
 
   return NULL;
 }
 
+// (Private) Never call |-applicationShouldTerminate:|; just make everything go
+// through |-terminate:|.
+- (void)handleQuitEvent:(NSAppleEventDescriptor*)event
+              withReply:(NSAppleEventDescriptor*)reply {
+  [NSApp terminate:nil];
+}
+
 // Various methods to open URLs that we get in a native fashion. We use
 // BrowserInit here because on the other platforms, URLs to open come through
 // the ProcessSingleton, and it calls BrowserInit. It's best to bottleneck the
 // openings through that for uniform handling.
 
 - (void)openUrls:(const std::vector<GURL>&)urls {
   // If the browser hasn't started yet, just queue up the URLs.
   if (!startupComplete_) {
     startupUrls_.insert(startupUrls_.end(), urls.begin(), urls.end());
     return;
@@ skipping 159 matching lines @@
   [appController showPreferencesWindow:nil page:page profile:profile];
 }
 
 namespace app_controller_mac {
 
 bool IsOpeningNewWindow() {
   return g_is_opening_new_window;
 }
 
 }  // namespace app_controller_mac