wine/gecko
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/wine-gecko.git synced 2024-09-13 09:24:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

Bug 1234020: Part 2k - [webext] Return promises from the windows API. r=rpl

Browse Source
This commit is contained in:
Kris Maglione 2016-02-01 18:28:00 -08:00
parent af1381399d
commit 9613c18150
2 changed files with 258 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
browser/components/extensions/ext-windows.js
View File

@ -9,7 +9,6 @@ XPCOMUtils.defineLazyServiceGetter(this, "aboutNewTabService",
Cu.import("resource://gre/modules/ExtensionUtils.jsm");
var {
EventManager,
runSafe,
} = ExtensionUtils;
extensions.registerSchemaAPI("windows", null, (extension, context) => {
@ -40,34 +39,28 @@ extensions.registerSchemaAPI("windows", null, (extension, context) => {
};
}).api(),
get: function(windowId, getInfo, callback) {
get: function(windowId, getInfo) {
let window = WindowManager.getWindow(windowId);
runSafe(context, callback, WindowManager.convert(extension, window, getInfo));
return Promise.resolve(WindowManager.convert(extension, window, getInfo));
},
getCurrent: function(getInfo, callback) {
getCurrent: function(getInfo) {
let window = currentWindow(context);
runSafe(context, callback, WindowManager.convert(extension, window, getInfo));
return Promise.resolve(WindowManager.convert(extension, window, getInfo));
},
getLastFocused: function(getInfo, callback) {
getLastFocused: function(getInfo) {
let window = WindowManager.topWindow;
runSafe(context, callback, WindowManager.convert(extension, window, getInfo));
return Promise.resolve(WindowManager.convert(extension, window, getInfo));
},
getAll: function(getInfo, callback) {
let e = Services.wm.getEnumerator("navigator:browser");
let windows = [];
while (e.hasMoreElements()) {
let window = e.getNext();
if (window.document.readyState == "complete") {
windows.push(WindowManager.convert(extension, window, getInfo));
}
}
runSafe(context, callback, windows);
getAll: function(getInfo) {
let windows = Array.from(WindowListManager.browserWindows(),
window => WindowManager.convert(extension, window, getInfo));
return Promise.resolve(windows);
},
create: function(createData, callback) {
create: function(createData) {
function mkstr(s) {
let result = Cc["@mozilla.org/supports-string;1"].createInstance(Ci.nsISupportsString);
result.data = s;
@ -114,37 +107,35 @@ extensions.registerSchemaAPI("windows", null, (extension, context) => {
// TODO: focused, type, state
window.addEventListener("load", function listener() {
window.removeEventListener("load", listener);
if (callback) {
runSafe(context, callback, WindowManager.convert(extension, window));
}
return new Promise(resolve => {
window.addEventListener("load", function listener() {
window.removeEventListener("load", listener);
resolve(WindowManager.convert(extension, window));
});
});
},
update: function(windowId, updateInfo, callback) {
update: function(windowId, updateInfo) {
let window = WindowManager.getWindow(windowId);
if (updateInfo.focused) {
Services.focus.activeWindow = window;
}
// TODO: All the other properties...
if (callback) {
runSafe(context, callback, WindowManager.convert(extension, window));
}
return Promise.resolve(WindowManager.convert(extension, window));
},
remove: function(windowId, callback) {
remove: function(windowId) {
let window = WindowManager.getWindow(windowId);
window.close();
let listener = () => {
AllWindowEvents.removeListener("domwindowclosed", listener);
if (callback) {
runSafe(context, callback);
}
};
AllWindowEvents.addListener("domwindowclosed", listener);
return new Promise(resolve => {
let listener = () => {
AllWindowEvents.removeListener("domwindowclosed", listener);
resolve();
};
AllWindowEvents.addListener("domwindowclosed", listener);
});
},
},
};

277
browser/components/extensions/schemas/windows.json
View File

@ -37,14 +37,46 @@
"id": "Window",
"type": "object",
"properties": {
"id": {"type": "integer", "optional": true, "minimum": 0, "description": "The ID of the window. Window IDs are unique within a browser session. Under some circumstances a Window may not be assigned an ID, for example when querying windows using the $(ref:sessions) API, in which case a session ID may be present."},
"focused": {"type": "boolean", "description": "Whether the window is currently the focused window."},
"top": {"type": "integer", "optional": true, "description": "The offset of the window from the top edge of the screen in pixels. Under some circumstances a Window may not be assigned top property, for example when querying closed windows from the $(ref:sessions) API."},
"left": {"type": "integer", "optional": true, "description": "The offset of the window from the left edge of the screen in pixels. Under some circumstances a Window may not be assigned left property, for example when querying closed windows from the $(ref:sessions) API."},
"width": {"type": "integer", "optional": true, "description": "The width of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned width property, for example when querying closed windows from the $(ref:sessions) API."},
"height": {"type": "integer", "optional": true, "description": "The height of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned height property, for example when querying closed windows from the $(ref:sessions) API."},
"tabs": {"type": "array", "items": { "$ref": "tabs.Tab" }, "optional": true, "description": "Array of $(ref:tabs.Tab) objects representing the current tabs in the window."},
"incognito": {"type": "boolean", "description": "Whether the window is incognito."},
"id": {
"type": "integer",
"optional": true,
"minimum": 0,
"description": "The ID of the window. Window IDs are unique within a browser session. Under some circumstances a Window may not be assigned an ID, for example when querying windows using the $(ref:sessions) API, in which case a session ID may be present."
},
"focused": {
"type": "boolean",
"description": "Whether the window is currently the focused window."
},
"top": {
"type": "integer",
"optional": true,
"description": "The offset of the window from the top edge of the screen in pixels. Under some circumstances a Window may not be assigned top property, for example when querying closed windows from the $(ref:sessions) API."
},
"left": {
"type": "integer",
"optional": true,
"description": "The offset of the window from the left edge of the screen in pixels. Under some circumstances a Window may not be assigned left property, for example when querying closed windows from the $(ref:sessions) API."
},
"width": {
"type": "integer",
"optional": true,
"description": "The width of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned width property, for example when querying closed windows from the $(ref:sessions) API."
},
"height": {
"type": "integer",
"optional": true,
"description": "The height of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned height property, for example when querying closed windows from the $(ref:sessions) API."
},
"tabs": {
"type": "array",
"items": { "$ref": "tabs.Tab" },
"optional": true,
"description": "Array of $(ref:tabs.Tab) objects representing the current tabs in the window."
},
"incognito": {
"type": "boolean",
"description": "Whether the window is incognito."
},
"type": {
"$ref": "WindowType",
"optional": true,
@ -55,8 +87,17 @@
"optional": true,
"description": "The state of this browser window."
},
"alwaysOnTop": {"unsupported": true, "type": "boolean", "description": "Whether the window is set to be always on top."},
"sessionId": {"unsupported": true, "type": "string", "optional": true, "description": "The session ID used to uniquely identify a Window obtained from the $(ref:sessions) API."}
"alwaysOnTop": {
"unsupported": true,
"type": "boolean",
"description": "Whether the window is set to be always on top."
},
"sessionId": {
"unsupported": true,
"type": "string",
"optional": true,
"description": "The session ID used to uniquely identify a Window obtained from the $(ref:sessions) API."
}
}
},
{
@ -81,16 +122,32 @@
"name": "get",
"type": "function",
"description": "Gets details about a window.",
"async": "callback",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": -2},
{
"type": "integer",
"name": "windowId",
"minimum": -2
},
{
"type": "object",
"name": "getInfo",
"optional": true,
"description": "",
"properties": {
"populate": {"type": "boolean", "optional": true, "description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission." },
"windowTypes": {"type": "array", "items": { "$ref": "WindowType" }, "optional": true, "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows." }
"populate": {
"type": "boolean",
"optional": true,
"description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
},
"windowTypes": {
"type": "array",
"items": {
"$ref": "WindowType"
},
"optional": true,
"description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
}
}
},
{
@ -98,7 +155,8 @@
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window"
"name": "window",
"$ref": "Window"
}
]
}
@ -108,6 +166,7 @@
"name": "getCurrent",
"type": "function",
"description": "Gets the $(topic:current-window)[current window].",
"async": "callback",
"parameters": [
{
"type": "object",
@ -115,8 +174,17 @@
"optional": true,
"description": "",
"properties": {
"populate": {"type": "boolean", "optional": true, "description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission." },
"windowTypes": {"type": "array", "items": { "$ref": "WindowType" }, "optional": true, "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows." }
"populate": {
"type": "boolean",
"optional": true,
"description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
},
"windowTypes": {
"type": "array",
"items": { "$ref": "WindowType" },
"optional": true,
"description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
}
}
},
{
@ -124,7 +192,8 @@
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window"
"name": "window",
"$ref": "Window"
}
]
}
@ -134,6 +203,7 @@
"name": "getLastFocused",
"type": "function",
"description": "Gets the window that was most recently focused &mdash; typically the window 'on top'.",
"async": "callback",
"parameters": [
{
"type": "object",
@ -141,8 +211,17 @@
"optional": true,
"description": "",
"properties": {
"populate": {"type": "boolean", "optional": true, "description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission." },
"windowTypes": {"type": "array", "items": { "$ref": "WindowType" }, "optional": true, "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows." }
"populate": {
"type": "boolean",
"optional": true,
"description": "If true, the $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
},
"windowTypes": {
"type": "array",
"items": { "$ref": "WindowType" },
"optional": true,
"description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
}
}
},
{
@ -150,7 +229,8 @@
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window"
"name": "window",
"$ref": "Window"
}
]
}
@ -160,6 +240,7 @@
"name": "getAll",
"type": "function",
"description": "Gets all windows.",
"async": "callback",
"parameters": [
{
"type": "object",
@ -167,8 +248,17 @@
"optional": true,
"description": "",
"properties": {
"populate": {"type": "boolean", "optional": true, "description": "If true, each $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects for that window. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission." },
"windowTypes": {"type": "array", "items": { "$ref": "WindowType" }, "optional": true, "description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows." }
"populate": {
"type": "boolean",
"optional": true,
"description": "If true, each $(ref:windows.Window) object will have a <var>tabs</var> property that contains a list of the $(ref:tabs.Tab) objects for that window. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>favIconUrl</code> properties if the extension's manifest file includes the <code>\"tabs\"</code> permission."
},
"windowTypes": {
"type": "array",
"items": { "$ref": "WindowType" },
"optional": true,
"description": "If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code> window types limited to the extension's own windows."
}
}
},
{
@ -176,7 +266,9 @@
"name": "callback",
"parameters": [
{
"name": "windows", "type": "array", "items": { "$ref": "Window" }
"name": "windows",
"type": "array",
"items": { "$ref": "Window" }
}
]
}
@ -186,6 +278,7 @@
"name": "create",
"type": "function",
"description": "Creates (opens) a new browser with any optional sizing, position or default URL provided.",
"async": "callback",
"parameters": [
{
"type": "object",
@ -195,17 +288,52 @@
"description": "A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.",
"optional": true,
"choices": [
{"type": "string"},
{"type": "array", "items": {"type": "string"}}
{ "type": "string" },
{
"type": "array",
"items": { "type": "string" }
}
]
},
"tabId": {"type": "integer", "minimum": 0, "optional": true, "description": "The id of the tab for which you want to adopt to the new window."},
"left": {"type": "integer", "optional": true, "description": "The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels."},
"top": {"type": "integer", "optional": true, "description": "The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels."},
"width": {"type": "integer", "minimum": 0, "optional": true, "description": "The width in pixels of the new window, including the frame. If not specified defaults to a natural width."},
"height": {"type": "integer", "minimum": 0, "optional": true, "description": "The height in pixels of the new window, including the frame. If not specified defaults to a natural height."},
"focused": {"unsupported": true, "type": "boolean", "optional": true, "description": "If true, opens an active window. If false, opens an inactive window."},
"incognito": {"type": "boolean", "optional": true, "description": "Whether the new window should be an incognito window."},
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The id of the tab for which you want to adopt to the new window."
},
"left": {
"type": "integer",
"optional": true,
"description": "The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels."
},
"top": {
"type": "integer",
"optional": true,
"description": "The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels."
},
"width": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The width in pixels of the new window, including the frame. If not specified defaults to a natural width."
},
"height": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The height in pixels of the new window, including the frame. If not specified defaults to a natural height."
},
"focused": {
"unsupported": true,
"type": "boolean",
"optional": true,
"description": "If true, opens an active window. If false, opens an inactive window."
},
"incognito": {
"type": "boolean",
"optional": true,
"description": "Whether the new window should be an incognito window."
},
"type": {
"unsupported": true,
"$ref": "CreateType",
@ -227,7 +355,9 @@
"optional": true,
"parameters": [
{
"name": "window", "$ref": "Window", "description": "Contains details about the created window.",
"name": "window",
"$ref": "Window",
"description": "Contains details about the created window.",
"optional": true
}
]
@ -238,18 +368,54 @@
"name": "update",
"type": "function",
"description": "Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be left unchanged.",
"async": "callback",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": -2},
{
"type": "integer",
"name": "windowId",
"minimum": -2
},
{
"type": "object",
"name": "updateInfo",
"properties": {
"left": {"unsupported": true, "type": "integer", "optional": true, "description": "The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels."},
"top": {"unsupported": true, "type": "integer", "optional": true, "description": "The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels."},
"width": {"unsupported": true, "type": "integer", "minimum": 0, "optional": true, "description": "The width to resize the window to in pixels. This value is ignored for panels."},
"height": {"unsupported": true, "type": "integer", "minimum": 0, "optional": true, "description": "The height to resize the window to in pixels. This value is ignored for panels."},
"focused": {"type": "boolean", "optional": true, "description": "If true, brings the window to the front. If false, brings the next window in the z-order to the front."},
"drawAttention": {"unsupported": true, "type": "boolean", "optional": true, "description": "If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous draw attention request."},
"left": {
"unsupported": true,
"type": "integer",
"optional": true,
"description": "The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels."
},
"top": {
"unsupported": true,
"type": "integer",
"optional": true,
"description": "The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels."
},
"width": {
"unsupported": true,
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The width to resize the window to in pixels. This value is ignored for panels."
},
"height": {
"unsupported": true,
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The height to resize the window to in pixels. This value is ignored for panels."
},
"focused": {
"type": "boolean",
"optional": true,
"description": "If true, brings the window to the front. If false, brings the next window in the z-order to the front."
},
"drawAttention": {
"unsupported": true,
"type": "boolean",
"optional": true,
"description": "If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous draw attention request."
},
"state": {
"unsupported": true,
"$ref": "WindowState",
@ -264,7 +430,8 @@
"optional": true,
"parameters": [
{
"name": "window", "$ref": "Window"
"name": "window",
"$ref": "Window"
}
]
}
@ -274,9 +441,19 @@
"name": "remove",
"type": "function",
"description": "Removes (closes) a window, and all the tabs inside it.",
"async": "callback",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
{
"type": "integer",
"name": "windowId",
"minimum": 0
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": []
}
]
}
],
@ -314,7 +491,12 @@
}
],
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0, "description": "ID of the removed window."}
{
"type": "integer",
"name": "windowId",
"minimum": 0,
"description": "ID of the removed window."
}
]
},
{
@ -330,7 +512,12 @@
}
],
"parameters": [
{"type": "integer", "name": "windowId", "minimum": -1, "description": "ID of the newly focused window."}
{
"type": "integer",
"name": "windowId",
"minimum": -1,
"description": "ID of the newly focused window."
}
]
}
]