widget/cocoa/nsAppShell.h

   1 /* -*- Mode: c++; tab-width: 2; indent-tabs-mode: nil; -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /*
   7  * Runs the main native Cocoa run loop, interrupting it as needed to process
   8  * Gecko events.
   9  */
  10
  11 #ifndef nsAppShell_h_
  12 #define nsAppShell_h_
  13
  14 #import <AppKit/NSApplication.h>
  15
  16 #include "nsBaseAppShell.h"
  17 #include "nsTArray.h"
  18
  19 class ProfilingStack;
  20
  21 namespace mozilla {
  22 class nsAvailableMemoryWatcherBase;
  23 }
  24
  25 // GeckoNSApplication
  26 //
  27 // Subclass of NSApplication for filtering out certain events.
  28 @interface GeckoNSApplication : NSApplication {
  29 }
  30 @property(readonly) BOOL didLaunch;
  31 @end
  32
  33 @class AppShellDelegate;
  34
  35 class nsAppShell : public nsBaseAppShell {
  36  public:
  37   NS_IMETHOD ResumeNative(void) override;
  38
  39   nsAppShell();
  40
  41   nsresult Init();
  42
  43   NS_IMETHOD Run(void) override;
  44   NS_IMETHOD Exit(void) override;
  45   NS_IMETHOD OnProcessNextEvent(nsIThreadInternal* aThread,
  46                                 bool aMayWait) override;
  47   NS_IMETHOD AfterProcessNextEvent(nsIThreadInternal* aThread,
  48                                    bool aEventWasProcessed) override;
  49
  50   void OnRunLoopActivityChanged(CFRunLoopActivity aActivity);
  51
  52   // public only to be visible to Objective-C code that must call it
  53   void WillTerminate();
  54
  55   static void OnMemoryPressureChanged(
  56       dispatch_source_memorypressure_flags_t aPressureLevel);
  57
  58  protected:
  59   virtual ~nsAppShell();
  60
  61   virtual void ScheduleNativeEventCallback() override;
  62   virtual bool ProcessNextNativeEvent(bool aMayWait) override;
  63
  64   void InitMemoryPressureObserver();
  65
  66   static void ProcessGeckoEvents(void* aInfo);
  67
  68  protected:
  69   CFMutableArrayRef mAutoreleasePools;
  70
  71   AppShellDelegate* mDelegate;
  72   CFRunLoopRef mCFRunLoop;
  73   CFRunLoopSourceRef mCFRunLoopSource;
  74
  75   // An observer for the profiler that is notified when the event loop enters
  76   // and exits the waiting state.
  77   CFRunLoopObserverRef mCFRunLoopObserver;
  78
  79   // Non-null while the native event loop is in the waiting state.
  80   ProfilingStack* mProfilingStackWhileWaiting = nullptr;
  81
  82   // For getting notifications from the OS about memory pressure state changes.
  83   dispatch_source_t mMemoryPressureSource = nullptr;
  84
  85   bool mRunningEventLoop;
  86   bool mStarted;
  87   bool mTerminated;
  88   bool mSkippedNativeCallback;
  89   bool mRunningCocoaEmbedded;
  90
  91   int32_t mNativeEventCallbackDepth;
  92   // Can be set from different threads, so must be modified atomically
  93   int32_t mNativeEventScheduledDepth;
  94 };
  95
  96 #endif  // nsAppShell_h_