Skip to content

Commit

Permalink
Bug 1679204 - Consider to add signal to addEventListener, r=edgar
Browse files Browse the repository at this point in the history
This passes the tests which are in web-platform-tests/wpt#26472

Because of complications in #include handling, AbortFollower needs to be in a different
header file than AbortSignal, yet AbortSignalImpl needs to be available when AbortFollower is used.
Another option would have been to make DOMEventTargetHelper.h a bit different and uninline some hot methods
there or move them to another file, but that would have been equally bad and Abort* is used way less often.
AbortFollower and AbortSignalImpl are thus just moved to a new header.

Memory management is such that Listener in EventListenerManager owns the possible ListenerSignalFollower
instance which follows the relevant signal. In order to be able remove event listener,
ListenerSignalFollower has many similar fields as Listener.
ListenerSignalFollower can't easily have just a pointer to Listener* since Listener isn't stored as a pointer
in EventListenerManager.
ListenerSignalFollower is cycle collectable so that Listener->ListenerSignalFollower can be traversed/unlinked
and also strong pointers in ListenerSignalFollower itself can be traversed/unlinked.

There is an XXX in the .webidl, since nullability of signal is unclear in the spec pr.
Whether or not it ends up being nullable shouldn't change the actual C++ implementation.

Differential Revision: https://phabricator.services.mozilla.com/D97938

UltraBlame original commit: b3d0fba5fd8d624b5abf53df196aedae5e83a269
  • Loading branch information
marco-c committed Dec 18, 2020
1 parent 2b384d8 commit 4bdf376
Show file tree
Hide file tree
Showing 8 changed files with 727 additions and 2,284 deletions.
208 changes: 208 additions & 0 deletions dom/abort/AbortFollower.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
#
ifndef
mozilla_dom_AbortFollower_h
#
define
mozilla_dom_AbortFollower_h
#
include
"
nsISupportsImpl
.
h
"
#
include
"
nsTObserverArray
.
h
"
namespace
mozilla
{
namespace
dom
{
class
AbortSignal
;
class
AbortSignalImpl
;
class
AbortFollower
:
public
nsISupports
{
public
:
virtual
void
RunAbortAlgorithm
(
)
=
0
;
void
Follow
(
AbortSignalImpl
*
aSignal
)
;
void
Unfollow
(
)
;
bool
IsFollowing
(
)
const
;
AbortSignalImpl
*
Signal
(
)
const
{
return
mFollowingSignal
;
}
protected
:
static
void
Traverse
(
AbortFollower
*
aFollower
nsCycleCollectionTraversalCallback
&
cb
)
;
static
void
Unlink
(
AbortFollower
*
aFollower
)
{
aFollower
-
>
Unfollow
(
)
;
}
virtual
~
AbortFollower
(
)
;
friend
class
AbortSignalImpl
;
RefPtr
<
AbortSignalImpl
>
mFollowingSignal
;
}
;
class
AbortSignalImpl
:
public
nsISupports
{
public
:
explicit
AbortSignalImpl
(
bool
aAborted
)
;
bool
Aborted
(
)
const
;
virtual
void
SignalAbort
(
)
;
protected
:
static
void
Traverse
(
AbortSignalImpl
*
aSignal
nsCycleCollectionTraversalCallback
&
cb
)
;
static
void
Unlink
(
AbortSignalImpl
*
aSignal
)
{
}
virtual
~
AbortSignalImpl
(
)
=
default
;
private
:
friend
class
AbortFollower
;
nsTObserverArray
<
AbortFollower
*
>
mFollowers
;
bool
mAborted
;
}
;
}
}
#
endif
Loading

0 comments on commit 4bdf376

Please sign in to comment.