[v8 gc] Introduce a base class for all objects that can have pending activity

third_party/WebKit/Source/bindings/IDLExtendedAttributes.md

 # Blink IDL Extended Attributes
 
 [TOC]
 
 ## Introduction
 
 The main interest in extended attributes are their _semantics_: Blink implements many more extended attributes than the Web IDL standard, to specify various behavior.
 
 The authoritative list of allowed extended attributes and values is [bindings/IDLExtendedAttributes.txt](https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit/Source/bindings/IDLExtendedAttributes.txt). This is complete but not necessarily precise (there may be unused extended attributes or values), since validation is run on build, but coverage isn't checked.
 
@@ skipping 112 matching lines @@
 * `[ImplementedAs]` is only necessary for these legacy files: otherwise the class (C++) implementing (IDL) implemented interfaces does not need to be specified, as this is handled in Blink C++.
 
 * `[OriginTrialEnabled]` behaves as for partial interfaces.
 
 * `[RuntimeEnabled]` behaves as for partial interfaces.
 
 * `[NoInterfaceObject]` is _always_ specified on implemented interfaces.
 
 ### Inheritance
 
-Extended attributes are generally not inherited: only extended attributes on the interface itself are consulted. However, there are a handful of extended attributes that are inherited (applying them to an ancestor interface applies them to the descendants). These are extended attributes that affect memory management, and currently consists of `[DependentLifetime]`; the up-to-date list is [compute_dependencies.INHERITED_EXTENDED_ATTRIBUTES](https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit/Source/bindings/scripts/compute_dependencies.py&q=INHERITED_EXTENDED_ATTRIBUTES).
+Extended attributes are generally not inherited: only extended attributes on the interface itself are consulted. However, there are a handful of extended attributes that are inherited (applying them to an ancestor interface applies them to the descendants). These are extended attributes that affect memory management, and currently consists of `[DependentLifetime]` and `[RequiresFinalizer]`; the up-to-date list is [compute_dependencies.INHERITED_EXTENDED_ATTRIBUTES](https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit/Source/bindings/scripts/compute_dependencies.py&q=INHERITED_EXTENDED_ATTRIBUTES).
 
 ## Standard Web IDL Extended Attributes
 
 These are defined in the [ECMAScript-specific extended attributes](http://heycam.github.io/webidl/#es-extended-attributes) section of the [Web IDL spec](http://heycam.github.io/webidl/), and alter the binding behavior.
 
 *** note
 Unsupported: `[ArrayClass]`, `[ImplicitThis]`, `[LenientThis]`, `[NamedPropertiesObject]`, `[TreatNonCallableAsNull]`
 ***
 
 ### [Clamp] _(a, p)_
@@ skipping 717 matching lines @@
 [
     DependentLifetime,
 ] interface Foo { ... };
 
 interface Bar : Foo { ... };  // inherits [DependentLifetime]
 ```
 
 If a DOM object does not have `[DependentLifetime]`, V8's GC collects the wrapper of the DOM object
 if the wrapper is unreachable on the JS side (i.e., V8's GC assumes that the wrapper should not be
 reachable in the DOM side). Use `[DependentLifetime]` to relax the assumption.
-For example, if the DOM object implements hasPendingActivity(), it must be annotated with
+For example, if the DOM object has `[RequiresFinalizer]` and implements hasPendingActivity(), it must be annotated with
 `[DependentLifetime]`. Otherwise, the wrapper will be collected regardless of the returned value
 of the hasPendingActivity(). DOM objects that are pointed to by `[SetWrapperReferenceFrom]` and
 `[SetWrapperReferenceTo]` must be annotated with `[DependentLifetime]`.
 
 ### [DeprecateAs] _(m, a, c)_
 
 Summary: Measures usage of a deprecated feature via UseCounter, and notifies developers about deprecation via a console warning.
 
 `[DeprecateAs]` can be considered an extended form of `[MeasureAs]`: it both measures the feature's usage via the same UseCounter mechanism, and also sends out a warning to the console (optionally with a message) in order to inform developers that the code they've written will stop working at some point in the relatively near future.
 
@@ skipping 307 matching lines @@
     [Reflect=q, ReflectOnly="first"|"second"|"third"|"fourth"] attribute DOMString quarter;
 };
 ```
 
 The ReflectOnly attribute limits the range of values that the attribute getter can return from its reflected attribute. If the content attribute has a value that is a case-insensitive match for one of the values given in the `ReflectOnly`'s list (using "`|`" as separator), then it will be returned. To allow attribute values that use characters that go beyond what IDL identifiers may contain, string literals are used. This is a Blink syntactic extension to extended attributes.
 
 If there is no match, the empty string will be returned. As required by the specification, no such checking is performed when the reflected IDL attribute is set.
 
 `[ReflectOnly=<list>]` should be used if the specification for a reflected IDL attribute says it is _"limited to only known values"_.
 
+### [RequiresFinalizer] _(i)_

[haraken, 2016/03/18 08:07:28]

"RequiresFinalizer" sounds a bit confusing, since it implies that the DOM object
needs a finalizer or something. I'd rename it to "ActiveScriptWrappable".

+
+Summary: `[RequiresFinalizer]` indicates that a given DOM object should be kept alive as long as the DOM object has pending activities.
+
+Usage: `[RequiresFinalizer]` can be specified on interfaces, and **is inherited**:
+
+```webidl
+[
+    RequiresFinalizer,
+] interface Foo {
+    ...
+};
+```
+
+If an interface X has `[RequiresFinalizer]` and an interface Y inherits the interface X, then the interface Y will also have `[RequiresFinalizer]`. For example
+
+```webidl
+[
+    RequiresFinalizer,
+] interface Foo {};
+```
+
+interface Bar : Foo {};  // inherits [RequiresFinalizer] from Foo
+If a given DOM object needs to be kept alive as long as the DOM object has pending activitiesi, yoiu need to specify `[RequiresFinalizer]` and `[DependentLifetime]`. For example, `[RequiresFinalizer]` can be used when the DOM object is expecting events ot be raised in the future.

[Marcel Hlopko, 2016/03/18 08:34:40]

typo ot

[Marcel Hlopko, 2016/03/18 08:34:40]

typo activitiesi, yoiu

[jochen (gone - plz use gerrit), 2016/03/18 13:18:01]

done

+
+If you use `[RequiresFinalizer]`, the corresponding Blink class needs to inherit ActiveScriptWrappable. For example, in case of XMLHttpRequest, core/xml/XMLHttpRequest.h would look like this:
+
+```c++
+class XMLHttpRequest : public ActiveScriptWrappable
+{
+    ...;
+}
+```
+
 ### [RuntimeEnabled] _(i, m, a, c)_
 
 Summary: `[RuntimeEnabled]` wraps the generated code with `if (RuntimeEnabledFeatures::FeatureNameEnabled) { ...code... }`.
 
 Usage: `[RuntimeEnabled=FeatureName]`. FeatureName must be included in [RuntimeEnabledFeatures.in](https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit/Source/platform/RuntimeEnabledFeatures.in).
 
 ```webidl
 [
     RuntimeEnabled=MediaSession
 ] interface MediaSession { ... };
@@ skipping 348 matching lines @@
 Copyright (C) 2009 Apple Inc. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ***