1
0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-02-17 19:45:46 +01:00

Promisify some callbackish functions, and remove spaces around = in default arguments, per Python conventions.

This commit is contained in:
Kris Maglione
2014-02-15 20:35:27 -08:00
parent fd20535999
commit bb7486da6c
22 changed files with 250 additions and 115 deletions

View File

@@ -9,10 +9,86 @@ defineModule("promises", {
require: []
});
lazyRequire("services", ["services"]);
lazyRequire("resource://gre/modules/Promise.jsm", ["Promise"]);
lazyRequire("resource://gre/modules/Task.jsm", ["Task"]);
function withCallbacks(fn) {
return function wrapper(...args) {
let deferred = Promise.defer();
function resolve(arg) { deferred.resolve(arg); }
function reject(arg) { deferred.reject(arg); }
fn.apply(this, [[resolve, reject, deferred]].concat(args));
return deferred.promise;
}
}
var Promises = Module("Promises", {
_cancel: WeakMap(),
/**
* Allows promises to be canceled..
*
* @param {Promise} promise The promise to cancel.
* @param {*} arg Argument to be passed to the cancellation
* function.
*/
cancel: function cancel(promise, reason) {
let cleanup = this._cancel.get(promise);
if (cleanup) {
cleanup[0](promise);
cleanup[1].reject(reason);
}
this._cancel.delete(promise);
},
/**
* Registers a cleanup function for the given deferred promise.
*
* @param {Deferred} promise The promise to cancel.
* @param {function} fn The cleanup function.
*/
oncancel: function oncancel(deferred, fn) {
this._cancel.set(deferred.promise, [fn, deferred]);
},
/**
* Returns a promise which resolves after a brief delay.
*/
delay: withCallbacks(function delay([accept]) {
let { mainThread } = services.threading;
mainThread.dispatch(accept, mainThread.DISPATCH_NORMAL);
}),
/**
* Returns a promise which resolves with the given argument.
*/
accept: function fail(arg) {
let deferred = Promise.defer();
deferred.resolve(arg);
return deferred.promise;
},
/**
* Returns a promise which fails with the given argument.
*/
fail: function fail(arg) {
let deferred = Promise.defer();
deferred.reject(arg);
return deferred.promise;
},
/**
* Returns a promise which resolves after the given number of
* milliseconds.
*
* @param {number} delay The number of milliseconds to wait.
*/
sleep: withCallbacks(function sleep([callback], delay) {
this.timeout(callback, delay);
}),
/**
* Wraps the given function so that each call spawns a Task.
*
@@ -26,21 +102,45 @@ var Promises = Module("Promises", {
},
/**
* Wraps the given function so that its first argument is a
* callback which, when called, resolves the returned promise.
* Returns a promise which resolves when the function *test* returns
* true, or *timeout* milliseconds have expired.
*
* @param {function} test The predicate on which to wait.
* @param {Number} timeout The maximum number of milliseconds to
* wait.
* @optional
* @param {number} pollInterval The poll interval, in milliseconds.
* @default 10
*/
waitFor: withCallbacks(function waitFor([accept, reject], test, timeout=null, pollInterval=10) {
let end = timeout && Date.now() + timeout, result;
let timer = services.Timer(
() => {
try {
var result = test();
}
catch (e) {
timer.cancel();
reject(e);
}
if (result) {
timer.cancel();
accept(result);
}
},
pollInterval, services.Timer.TYPE_REPEATING_SLACK);
}),
/**
* Wraps the given function so that its first argument is an array
* of success and failure callbacks which, when called, resolve the
* returned promise.
*
* @param {function} fn The function to wrap.
* @returns {Promise}
*/
withCallback: function withCallback(fn) {
return function wrapper(...args) {
let deferred = Promise.defer();
function callback(arg) {
deferred.resolve(arg);
}
return fn.apply(this, [callback].concat(args));
}
},
withCallbacks: withCallbacks,
});
endModule();