mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-08 14:03:49 +00:00
7467b1470b
The JSWindowActor constructor is called before the actor is fully initialized, which means it can't do things like send messages or access its content window. This patch adds a new callback which can do those things immediately after the actor is created. Differential Revision: https://phabricator.services.mozilla.com/D42178 --HG-- extra : rebase_source : ba17cacb00d8fc74f84c5d34f64addcc3e6d3f8b extra : source : ac3da20c687971c412d1164f08b17e0cccc5fbd5
168 lines
5.5 KiB
Plaintext
168 lines
5.5 KiB
Plaintext
/* -*- 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/. */
|
|
|
|
interface nsISupports;
|
|
|
|
[NoInterfaceObject]
|
|
interface JSWindowActor {
|
|
[Throws]
|
|
void sendAsyncMessage(DOMString messageName,
|
|
optional any obj,
|
|
optional any transfers);
|
|
|
|
[Throws]
|
|
Promise<any> sendQuery(DOMString messageName,
|
|
optional any obj,
|
|
optional any transfers);
|
|
};
|
|
|
|
[ChromeOnly, ChromeConstructor]
|
|
interface JSWindowActorParent {
|
|
/**
|
|
* Actor initialization occurs after the constructor is called but before the
|
|
* first message is delivered. Until the actor is initialized, accesses to
|
|
* manager will fail.
|
|
*/
|
|
readonly attribute WindowGlobalParent? manager;
|
|
|
|
[Throws]
|
|
readonly attribute CanonicalBrowsingContext? browsingContext;
|
|
};
|
|
JSWindowActorParent implements JSWindowActor;
|
|
|
|
[ChromeOnly, ChromeConstructor]
|
|
interface JSWindowActorChild {
|
|
/**
|
|
* Actor initialization occurs after the constructor is called but before the
|
|
* first message is delivered. Until the actor is initialized, accesses to
|
|
* manager will fail.
|
|
*/
|
|
readonly attribute WindowGlobalChild? manager;
|
|
|
|
[Throws]
|
|
readonly attribute Document? document;
|
|
|
|
[Throws]
|
|
readonly attribute BrowsingContext? browsingContext;
|
|
|
|
[Throws]
|
|
readonly attribute nsIDocShell? docShell;
|
|
|
|
/**
|
|
* NOTE: As this returns a window proxy, it may not be currently referencing
|
|
* the document associated with this JSWindowActor. Generally prefer using
|
|
* `document`.
|
|
*/
|
|
[Throws]
|
|
readonly attribute WindowProxy? contentWindow;
|
|
};
|
|
JSWindowActorChild implements JSWindowActor;
|
|
|
|
/**
|
|
* WebIDL callback interface version of the nsIObserver interface for use when
|
|
* calling the observe method on JSWindowActors.
|
|
*
|
|
* NOTE: This isn't marked as ChromeOnly, as it has no interface object, and
|
|
* thus cannot be conditionally exposed.
|
|
*/
|
|
callback interface MozObserverCallback {
|
|
void observe(nsISupports subject, ByteString topic, DOMString? data);
|
|
};
|
|
|
|
/**
|
|
* WebIDL callback interface calling the `willDestroy`, `didDestroy`, and
|
|
* `actorCreated` methods on JSWindowActors.
|
|
*/
|
|
[MOZ_CAN_RUN_SCRIPT_BOUNDARY]
|
|
callback MozJSWindowActorCallback = void();
|
|
|
|
/**
|
|
* The willDestroy method, if present, will be called at the last opportunity
|
|
* to send messages to the remote side, giving implementers the chance to clean
|
|
* up and send final messages.
|
|
* The didDestroy method, if present, will be called after the actor is no
|
|
* longer able to receive any more messages.
|
|
* The actorCreated method, if present, will be called immediately after the
|
|
* actor has been created and initialized.
|
|
*
|
|
* NOTE: Messages may be received between willDestroy and didDestroy, but they
|
|
* may not be sent.
|
|
*/
|
|
dictionary MozJSWindowActorCallbacks {
|
|
[ChromeOnly] MozJSWindowActorCallback willDestroy;
|
|
[ChromeOnly] MozJSWindowActorCallback didDestroy;
|
|
[ChromeOnly] MozJSWindowActorCallback actorCreated;
|
|
};
|
|
|
|
/**
|
|
* Used by ChromeUtils.registerWindowActor() to register JS window actor.
|
|
*/
|
|
dictionary WindowActorOptions {
|
|
/**
|
|
* If this is set to `true`, allow this actor to be created for subframes,
|
|
* and not just toplevel window globals.
|
|
*/
|
|
boolean allFrames = false;
|
|
|
|
/**
|
|
* If this is set to `true`, allow this actor to be created for window
|
|
* globals loaded in chrome browsing contexts, such as those used to load the
|
|
* tabbrowser.
|
|
*/
|
|
boolean includeChrome = false;
|
|
|
|
/**
|
|
* An array of URL match patterns (as accepted by the MatchPattern
|
|
* class in MatchPattern.webidl) which restrict which pages the actor
|
|
* may be instantiated for. If this is defined, only documents URL which match
|
|
* are allowed to have the given actor created for them. Other
|
|
* documents will fail to have their actor constructed, returning nullptr.
|
|
*/
|
|
sequence<DOMString> matches;
|
|
|
|
/**
|
|
* Optional list of regular expressions for remoteTypes which are
|
|
* allowed to instantiate this actor. If not passed, all content
|
|
* processes are allowed to instantiate the actor.
|
|
*/
|
|
sequence<DOMString> remoteTypes;
|
|
|
|
/** This fields are used for configuring individual sides of the actor. */
|
|
WindowActorSidedOptions parent = {};
|
|
WindowActorChildOptions child = {};
|
|
};
|
|
|
|
dictionary WindowActorSidedOptions {
|
|
/**
|
|
* The JSM path which should be loaded for the actor on this side.
|
|
* If not passed, the specified side cannot receive messages, but may send
|
|
* them using `sendAsyncMessage` or `sendQuery`.
|
|
*/
|
|
ByteString moduleURI;
|
|
};
|
|
|
|
dictionary WindowActorChildOptions : WindowActorSidedOptions {
|
|
/**
|
|
* Events which this actor wants to be listening to. When these events fire,
|
|
* it will trigger actor creation, and then forward the event to the actor.
|
|
*
|
|
* NOTE: `once` option is not support due to we register listeners in a shared
|
|
* location.
|
|
*/
|
|
record<DOMString, AddEventListenerOptions> events;
|
|
|
|
/**
|
|
* An array of observer topics to listen to. An observer will be added for each
|
|
* topic in the list.
|
|
*
|
|
* Observer notifications in the list use nsGlobalWindowInner or
|
|
* nsGlobalWindowOuter object as their subject, and the events will only be
|
|
* dispatched to the corresponding window actor. If additional observer
|
|
* notification's subjects are needed, please file a bug for that.
|
|
**/
|
|
sequence<ByteString> observers;
|
|
};
|