nsWindowMediator.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsWindowMediator_h_
#define nsWindowMediator_h_

#include "nsCOMPtr.h"
#include "nsIWindowMediator.h"
#include "nsIObserver.h"
#include "nsTArray.h"
#include "nsString.h"
#include "nsWeakReference.h"
#include "nsTObserverArray.h"

class nsAppShellWindowEnumerator;
class nsASXULWindowEarlyToLateEnumerator;
class nsASDOMWindowEarlyToLateEnumerator;
class nsASXULWindowFrontToBackEnumerator;
class nsASXULWindowBackToFrontEnumerator;
class nsIWindowMediatorListener;
struct nsWindowInfo;

class nsWindowMediator : public nsIWindowMediator,
                         public nsIObserver,
                         public nsSupportsWeakReference {
  friend class nsAppShellWindowEnumerator;
  friend class nsASXULWindowEarlyToLateEnumerator;
  friend class nsASDOMWindowEarlyToLateEnumerator;
  friend class nsASXULWindowFrontToBackEnumerator;
  friend class nsASXULWindowBackToFrontEnumerator;

 protected:
  virtual ~nsWindowMediator();

 public:
  nsWindowMediator();

  nsresult Init();

  NS_DECL_ISUPPORTS
  NS_DECL_NSIWINDOWMEDIATOR
  NS_DECL_NSIOBSERVER

  static nsresult GetDOMWindow(nsIXULWindow* inWindow,
                               nsCOMPtr<nsPIDOMWindowOuter>& outDOMWindow);

 private:
  void AddEnumerator(nsAppShellWindowEnumerator* inEnumerator);
  int32_t RemoveEnumerator(nsAppShellWindowEnumerator* inEnumerator);
  nsWindowInfo* MostRecentWindowInfo(const char16_t* inType,
                                     bool aSkipPrivateBrowsingOrClosed = false);

  nsresult UnregisterWindow(nsWindowInfo* inInfo);
  nsWindowInfo* GetInfoFor(nsIXULWindow* aWindow);
  nsWindowInfo* GetInfoFor(nsIWidget* aWindow);
  void SortZOrderFrontToBack();
  void SortZOrderBackToFront();

  nsTArray<nsAppShellWindowEnumerator*> mEnumeratorList;
  nsWindowInfo* mOldestWindow;
  nsWindowInfo* mTopmostWindow;
  int32_t mTimeStamp;
  bool mSortingZOrder;
  bool mReady;

  typedef nsTObserverArray<nsCOMPtr<nsIWindowMediatorListener>> ListenerArray;
  ListenerArray mListeners;
};

#endif