The Tor Browser: dom/events/test/marionette/head.js@b8a032363ba2 (annotated)

dom/events/test/marionette/head.js@b8a032363ba2 (annotated)

dom/events/test/marionette/head.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* Any copyright is dedicated to the Public Domain.
  * http://creativecommons.org/publicdomain/zero/1.0/ */
 const {Cc: Cc, Ci: Ci, Cr: Cr, Cu: Cu} = SpecialPowers;
 let Promise = Cu.import("resource://gre/modules/Promise.jsm").Promise;
 let _pendingEmulatorCmdCount = 0;
 /**
  * Send emulator command with safe guard.
  *
  * We should only call |finish()| after all emulator command transactions
  * end, so here comes with the pending counter.  Resolve when the emulator
  * gives positive response, and reject otherwise.
  *
  * Fulfill params:
  *   result -- an array of emulator response lines.
  * Reject params:
  *   result -- an array of emulator response lines.
  *
  * @return A deferred promise.
  */
 function runEmulatorCmdSafe(aCommand) {
   let deferred = Promise.defer();
   ++_pendingEmulatorCmdCount;
   runEmulatorCmd(aCommand, function(aResult) {
     --_pendingEmulatorCmdCount;
     ok(true, "Emulator response: " + JSON.stringify(aResult));
     if (Array.isArray(aResult) &&
         aResult[aResult.length - 1] === "OK") {
       deferred.resolve(aResult);
     } else {
       deferred.reject(aResult);
     }
   });
   return deferred.promise;
 }
 /**
  * Get emulator sensor values of a named sensor.
  *
  * Fulfill params:
  *   result -- an array of emulator sensor values.
  * Reject params: (none)
  *
  * @param aSensorName
  *        A string name of the sensor.  Availables are: "acceleration"
  *        "magnetic-field", "orientation", "temperature", "proximity".
  *
  * @return A deferred promise.
  */
 function getEmulatorSensorValues(aSensorName) {
   return runEmulatorCmdSafe("sensor get " + aSensorName)
     .then(function(aResult) {
       // aResult = ["orientation = 0:0:0", "OK"]
       return aResult[0].split(" ")[2].split(":").map(function(aElement) {
         return parseInt(aElement, 10);
       });
     });
 }
 /**
  * Convenient alias function for getting orientation sensor values.
  */
 function getEmulatorOrientationValues() {
   return getEmulatorSensorValues("orientation");
 }
 /**
  * Set emulator orientation sensor values.
  *
  * Fulfill params: (none)
  * Reject params: (none)
  *
  * @param aAzimuth
  * @param aPitch
  * @param aRoll
  *
  * @return A deferred promise.
  */
 function setEmulatorOrientationValues(aAzimuth, aPitch, aRoll) {
   let cmd = "sensor set orientation " + aAzimuth + ":" + aPitch + ":" + aRoll;
   return runEmulatorCmdSafe(cmd);
 }
 /**
  * Wait for a named window event.
  *
  * Resolve if that named event occurs.  Never reject.
  *
  * Forfill params: the DOMEvent passed.
  *
  * @param aEventName
  *        A string event name.
  *
  * @return A deferred promise.
  */
 function waitForWindowEvent(aEventName) {
   let deferred = Promise.defer();
   window.addEventListener(aEventName, function onevent(aEvent) {
     window.removeEventListener(aEventName, onevent);
     ok(true, "Window event '" + aEventName + "' got.");
     deferred.resolve(aEvent);
   });
   return deferred.promise;
 }
 /**
  * Flush permission settings and call |finish()|.
  */
 function cleanUp() {
   waitFor(function() {
     SpecialPowers.flushPermissions(function() {
       // Use ok here so that we have at least one test run.
       ok(true, "permissions flushed");
       finish();
     });
   }, function() {
     return _pendingEmulatorCmdCount === 0;
   });
 }
 /**
  * Basic test routine helper.
  *
  * This helper does nothing but clean-ups.
  *
  * @param aTestCaseMain
  *        A function that takes no parameter.
  */
 function startTestBase(aTestCaseMain) {
   Promise.resolve()
     .then(aTestCaseMain)
     .then(cleanUp, function() {
       ok(false, 'promise rejects during test.');
       cleanUp();
     });
 }