Cleans up our autorelease handling so that we don't create a layered ...

base/message_pump_mac.h

-// Copyright (c) 2008 The Chromium Authors. All rights reserved.
+// Copyright (c) 2009 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.
 
 // The basis for all native run loops on the Mac is the CFRunLoop.  It can be
 // used directly, it can be used as the driving force behind the similar
 // Foundation NSRunLoop, and it can be used to implement higher-level event
 // loops such as the NSApplication event loop.
 //
 // This file introduces a basic CFRunLoop-based implementation of the
 // MessagePump interface called CFRunLoopBase.  CFRunLoopBase contains all
@@ skipping 16 matching lines @@
 // called on.
 
 #ifndef BASE_MESSAGE_PUMP_MAC_H_
 #define BASE_MESSAGE_PUMP_MAC_H_
 
 #include "base/message_pump.h"
 
 #include <CoreFoundation/CoreFoundation.h>
 #include <IOKit/IOKitLib.h>
 
+#if defined(__OBJC__)
+@class NSAutoreleasePool;
+#else   // __OBJC__
+class NSAutoreleasePool;
+#endif  // __OBJC__
+
+
 namespace base {
 
 class Time;
 
 class MessagePumpCFRunLoopBase : public MessagePump {
  public:
   MessagePumpCFRunLoopBase();
   virtual ~MessagePumpCFRunLoopBase();
 
   // Subclasses should implement the work they need to do in MessagePump::Run
   // in the DoRun method.  MessagePumpCFRunLoopBase::Run calls DoRun directly.
   // This arrangement is used because MessagePumpCFRunLoopBase needs to set
   // up and tear down things before and after the "meat" of DoRun.
   virtual void Run(Delegate* delegate);
   virtual void DoRun(Delegate* delegate) = 0;
 
   virtual void ScheduleWork();
   virtual void ScheduleDelayedWork(const Time& delayed_work_time);
 
  protected:
   // Accessors for private data members to be used by subclasses.
   CFRunLoopRef run_loop() const { return run_loop_; }
   int nesting_level() const { return nesting_level_; }
   int run_nesting_level() const { return run_nesting_level_; }
 
+  // Factory method for creating an autorelease pool. Not all message
+  // pumps work with autorelease pools in the same way.
+  virtual NSAutoreleasePool* CreateAutoreleasePool();
+
  private:
   // Timer callback scheduled by ScheduleDelayedWork.  This does not do any
   // work, but it signals delayed_work_source_ so that delayed work can be
   // performed within the appropriate priority constraints.
   static void RunDelayedWorkTimer(CFRunLoopTimerRef timer, void* info);
 
   // Perform highest-priority work.  This is associated with work_source_
   // signalled by ScheduleWork.  The static method calls the instance method;
   // the instance method returns true if work was done.
   static void RunWorkSource(void* info);
@@ skipping 143 matching lines @@
   // is called, to cause the loop to wake up so that it can stop.
   CFRunLoopSourceRef quit_source_;
 
   // False after Quit is called.
   bool keep_running_;
 
   DISALLOW_COPY_AND_ASSIGN(MessagePumpNSRunLoop);
 };
 
 class MessagePumpNSApplication : public MessagePumpCFRunLoopBase {
+  // ObjC objects and C++ objects can't be friends, so this C function

[Mark Mentovai, 2009/10/30 21:47:04]

remove letter C

+  // will act as a friendly trampoline for
+  // MessagePumpNSAppDeferredAutoReleasePool to call
+  // set_needs_event_loop_wakeup.
+  friend void SetNeedsEventLoopWakeUpTrue(MessagePumpNSApplication* pump);
+
  public:
   MessagePumpNSApplication();
 
   virtual void DoRun(Delegate* delegate);
   virtual void Quit();
 
+ protected:
+  // MessagePumpNSApplications need a special autorelease pool that works
+  // correctly when nested inside another autorelease pool.
+  virtual NSAutoreleasePool* CreateAutoreleasePool();
+  void set_needs_event_loop_wakeup_true() {
+    needs_event_loop_wake_up_ = true;
+  }
+
  private:
+  virtual void EnterExitRunLoop(CFRunLoopActivity activity);
+
+  // Send a null event through to the event loop if necessary.
+  void WakeUpEventLoop();
+
   // False after Quit is called.
   bool keep_running_;
 
   // True if DoRun is managing its own run loop as opposed to letting
   // -[NSApplication run] handle it.  The outermost run loop in the application
   // is managed by -[NSApplication run], inner run loops are handled by a loop
   // in DoRun.
   bool running_own_loop_;
 
+  // True if an event should be sent to the event loop to cause it to spin
+  // when the run loop is exiting.
+  bool needs_event_loop_wake_up_;
+
   DISALLOW_COPY_AND_ASSIGN(MessagePumpNSApplication);
 };
 
 class MessagePumpMac {
  public:
   // Returns a new instance of MessagePumpNSApplication if called on the main
   // thread.  Otherwise, returns a new instance of MessagePumpNSRunLoop.
   static MessagePump* Create();
 
  private:
   DISALLOW_IMPLICIT_CONSTRUCTORS(MessagePumpMac);
 };
 
 }  // namespace base
 
 #endif  // BASE_MESSAGE_PUMP_MAC_H_