dom/abort/AbortSignal.h
author Oriol Brufau <oriol-bugzilla@hotmail.com>
Wed, 31 Oct 2018 16:15:54 +0000
changeset 500988 8a28169fa91dbde370d47bd91bc1b0c91f89cacf
parent 492394 9b35b8441aa544d0f5f066750b64f30e67fabcde
child 508163 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1499693 - Choose correct add-on icon size in about:addons. r=mstriemer,aswan, a=RyanVM Differential Revision: https://phabricator.services.mozilla.com/D9347

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 mozilla_dom_AbortSignal_h
#define mozilla_dom_AbortSignal_h

#include "mozilla/DOMEventTargetHelper.h"
#include "nsTObserverArray.h"

namespace mozilla {
namespace dom {

class AbortSignal;
class AbortSignalImpl;

// This class must be implemented by objects who want to follow a
// AbortSignalImpl.
class AbortFollower
{
public:
  virtual void Abort() = 0;

  void
  Follow(AbortSignalImpl* aSignal);

  void
  Unfollow();

  bool
  IsFollowing() const;

protected:
  virtual ~AbortFollower();

  // Subclasses of AbortFollower must Traverse this member and call
  // Unfollow() when Unlinking.
  RefPtr<AbortSignalImpl> mFollowingSignal;
};

// Any subclass of this class must Traverse mFollowingSignal and call
// Unfollow() when Unlinking.
class AbortSignalImpl : public AbortFollower
                      , public nsISupports
{
public:
  explicit AbortSignalImpl(bool aAborted);

  bool
  Aborted() const;

  void
  Abort() override;

  void
  AddFollower(AbortFollower* aFollower);

  void
  RemoveFollower(AbortFollower* aFollower);

protected:
  virtual ~AbortSignalImpl() = default;

private:
  // Raw pointers. AbortFollower unregisters itself in the DTOR.
  nsTObserverArray<AbortFollower*> mFollowers;

  bool mAborted;
};

class AbortSignal final : public DOMEventTargetHelper
                        , public AbortSignalImpl
{
public:
  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(AbortSignal, DOMEventTargetHelper)

  AbortSignal(nsIGlobalObject* aGlobalObject, bool aAborted);

  JSObject*
  WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;

  IMPL_EVENT_HANDLER(abort);

  void
  Abort() override;

private:
  ~AbortSignal() = default;
};

} // dom namespace
} // mozilla namespace

#endif // mozilla_dom_AbortSignal_h