xpfe/appshell/nsAppShellWindowEnumerator.h
author Thomas Wisniewski <twisniewski@mozilla.com>
Tue, 16 Apr 2019 14:37:34 +0000
changeset 469679 724fc2049046a87731d27183140132e5a2e7ff3c
parent 448947 6f3709b3878117466168c40affa7bca0b60cf75b
child 472056 e1993a1f09ac53cd1a04fdf6a87f8cad8e44f73e
permissions -rw-r--r--
Bug 1543983 - Whitelist about:compat as a secure page on Fennec; r=snorp Whitelist about:compat as a secure page on Fennec Differential Revision: https://phabricator.services.mozilla.com/D27391

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 nsAppShellWindowEnumerator_h
#define nsAppShellWindowEnumerator_h

#include "nsCOMPtr.h"
#include "nsString.h"

#include "nsSimpleEnumerator.h"
#include "nsIXULWindow.h"

class nsWindowMediator;

//
// nsWindowInfo
//

struct nsWindowInfo {
  nsWindowInfo(nsIXULWindow *inWindow, int32_t inTimeStamp);
  ~nsWindowInfo();

  nsCOMPtr<nsIXULWindow> mWindow;
  int32_t mTimeStamp;
  uint32_t mZLevel;

  // each struct is in two, independent, circular, doubly-linked lists
  nsWindowInfo *mYounger,  // next younger in sequence
      *mOlder;
  nsWindowInfo *mLower,  // next lower in z-order
      *mHigher;

  bool TypeEquals(const nsAString &aType);
  void InsertAfter(nsWindowInfo *inOlder, nsWindowInfo *inHigher);
  void Unlink(bool inAge, bool inZ);
  void ReferenceSelf(bool inAge, bool inZ);
};

//
// virtual enumerators
//

class nsAppShellWindowEnumerator : public nsSimpleEnumerator {
  friend class nsWindowMediator;

 public:
  nsAppShellWindowEnumerator(const char16_t *aTypeString,
                             nsWindowMediator &inMediator);
  NS_IMETHOD GetNext(nsISupports **retval) override = 0;
  NS_IMETHOD HasMoreElements(bool *retval) override;

 protected:
  ~nsAppShellWindowEnumerator() override;

  void AdjustInitialPosition();
  virtual nsWindowInfo *FindNext() = 0;

  void WindowRemoved(nsWindowInfo *inInfo);

  nsWindowMediator *mWindowMediator;
  nsString mType;
  nsWindowInfo *mCurrentPosition;
};

class nsASDOMWindowEnumerator : public nsAppShellWindowEnumerator {
 public:
  nsASDOMWindowEnumerator(const char16_t *aTypeString,
                          nsWindowMediator &inMediator);
  virtual ~nsASDOMWindowEnumerator();
  NS_IMETHOD GetNext(nsISupports **retval) override;
};

class nsASXULWindowEnumerator : public nsAppShellWindowEnumerator {
 public:
  nsASXULWindowEnumerator(const char16_t *aTypeString,
                          nsWindowMediator &inMediator);
  virtual ~nsASXULWindowEnumerator();
  NS_IMETHOD GetNext(nsISupports **retval) override;

  const nsID &DefaultInterface() override { return NS_GET_IID(nsIXULWindow); }
};

//
// concrete enumerators
//

class nsASDOMWindowEarlyToLateEnumerator : public nsASDOMWindowEnumerator {
 public:
  nsASDOMWindowEarlyToLateEnumerator(const char16_t *aTypeString,
                                     nsWindowMediator &inMediator);

  virtual ~nsASDOMWindowEarlyToLateEnumerator();

 protected:
  virtual nsWindowInfo *FindNext() override;
};

class nsASXULWindowEarlyToLateEnumerator : public nsASXULWindowEnumerator {
 public:
  nsASXULWindowEarlyToLateEnumerator(const char16_t *aTypeString,
                                     nsWindowMediator &inMediator);

  virtual ~nsASXULWindowEarlyToLateEnumerator();

 protected:
  virtual nsWindowInfo *FindNext() override;
};

class nsASXULWindowFrontToBackEnumerator : public nsASXULWindowEnumerator {
 public:
  nsASXULWindowFrontToBackEnumerator(const char16_t *aTypeString,
                                     nsWindowMediator &inMediator);

  virtual ~nsASXULWindowFrontToBackEnumerator();

 protected:
  virtual nsWindowInfo *FindNext() override;
};

class nsASXULWindowBackToFrontEnumerator : public nsASXULWindowEnumerator {
 public:
  nsASXULWindowBackToFrontEnumerator(const char16_t *aTypeString,
                                     nsWindowMediator &inMediator);

  virtual ~nsASXULWindowBackToFrontEnumerator();

 protected:
  virtual nsWindowInfo *FindNext() override;
};

#endif