rainux-selenium-webdriver 0.0.17

data/firefox/src/extension/components/utils.js

@@ -0,0 +1,1263 @@
+/*
+ Copyright 2007-2009 WebDriver committers
+ Copyright 2007-2009 Google Inc.
+ Portions copyright 2007 ThoughtWorks, Inc
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ */
+
+function StaleElementError() {
+  this.isStaleElementError = true;
+}
+
+function createSwitchFile(file_content) {
+  var filename = "/tmp/switch_window_started";
+  var cc = Components.classes;
+  var ci = Components.interfaces;
+
+  try {
+    // TODO(eran): Look at the OS and only do this where it makes sense.
+    var tmpdir = cc['@mozilla.org/file/local;1'].createInstance(ci.nsILocalFile);
+    tmpdir.initWithPath("/tmp");
+
+    // Do not create a switch file on systems that do not have a /tmp directory
+    // - this serves to prevent creation of a switch file on Windows systems.
+    if (!tmpdir.exists()) {
+      return;
+    }
+
+    var file = cc['@mozilla.org/file/local;1'].createInstance(ci.nsILocalFile);
+    file.initWithPath(filename);
+    var fileOutputStream = cc['@mozilla.org/network/safe-file-output-stream;1'].createInstance(ci.nsIFileOutputStream);
+    fileOutputStream.init(file, -1, -1, null);
+
+    fileOutputStream.write(file_content, file_content.length);
+    if (fileOutputStream instanceof ci.nsISafeOutputStream) {
+        fileOutputStream.finish();
+    } else {
+        fileOutputStream.close();
+    }
+  } catch (e) {
+    // Fine. Log it and continue
+    Utils.dumpn(e);
+  }
+}
+
+function Utils() {
+}
+
+
+Utils.getUniqueId = function() {
+  if (!Utils._generator) {
+    Utils._generator =
+    Utils.getService("@mozilla.org/uuid-generator;1", "nsIUUIDGenerator");
+  }
+  return Utils._generator.generateUUID().toString();
+};
+
+
+Utils.newInstance = function(className, interfaceName) {
+  var clazz = Components.classes[className];
+
+  if (!clazz)
+    return undefined;
+
+  var iface = Components.interfaces[interfaceName];
+  return clazz.createInstance(iface);
+};
+
+
+Utils.getService = function(className, serviceName) {
+  var clazz = Components.classes[className];
+  if (clazz == undefined) {
+    throw new Exception();
+  }
+
+  return clazz.getService(Components.interfaces[serviceName]);
+};
+
+
+Utils.getServer = function() {
+  var handle =
+      Utils.newInstance("@googlecode.com/webdriver/fxdriver;1", "nsISupports");
+  return handle.wrappedJSObject;
+};
+
+
+Utils.getBrowser = function(context) {
+  return context.fxbrowser;
+};
+
+
+Utils.getDocument = function(context) {
+  if (context.frame) {
+    return context.frame.document;
+  }
+  return context.fxbrowser.contentDocument;
+};
+
+
+Utils.getActiveElement = function(context) {
+  var doc = Utils.getDocument(context);
+
+  var element;
+  if (doc["activeElement"]) {
+    element = doc.activeElement;
+  } else {
+    var commandDispatcher = Utils.getBrowser(context).ownerDocument.
+        commandDispatcher;
+
+    doc = Utils.getDocument(context);
+    element = commandDispatcher.focusedElement;
+
+    if (element && Utils.getDocument(context) != element.ownerDocument)
+      element = null;
+  }
+
+  // Default to the body
+  if (!element) {
+    element = Utils.getDocument(context).body;
+  }
+
+  return element;
+};
+
+
+function getTextFromNode(node, toReturn, textSoFar) {
+  if (node['tagName'] && node.tagName == "SCRIPT") {
+    return [toReturn, textSoFar];
+  }
+  var children = node.childNodes;
+
+  var bits;
+  for (var i = 0; i < children.length; i++) {
+    var child = children[i];
+
+    // Do we need to collapse the text so far?
+    if (child["tagName"] && child.tagName == "PRE") {
+      toReturn += collapseWhitespace(textSoFar);
+      textSoFar = "";
+      bits = getTextFromNode(child, toReturn, "", true);
+      toReturn += bits[1];
+      continue;
+    }
+
+    // Or is this just plain text?
+    if (child.nodeName == "#text") {
+      if (Utils.isDisplayed(child, false)) {
+        var textToAdd = child.nodeValue;
+        textToAdd =
+        textToAdd.replace(new RegExp(String.fromCharCode(160), "gm"), " ");
+        textSoFar += textToAdd;
+      }
+      continue;
+    }
+
+    // Treat as another child node.
+    bits = getTextFromNode(child, toReturn, textSoFar, false);
+    toReturn = bits[0];
+    textSoFar = bits[1];
+  }
+
+  if (isBlockLevel(node)) {
+    if (node["tagName"] && node.tagName != "PRE") {
+      toReturn += collapseWhitespace(textSoFar) + "\n";
+      textSoFar = "";
+    } else {
+      toReturn += "\n";
+    }
+  }
+  return [toReturn, textSoFar];
+}
+
+
+function isBlockLevel(node) {
+  if (node["tagName"] && node.tagName == "BR")
+    return true;
+
+  try {
+    // Should we think about getting hold of the current document?
+    return "block" == Utils.getStyleProperty(node, "display");
+  } catch (e) {
+    return false;
+  }
+}
+
+
+Utils.isInHead = function(element) {
+  while (element) {
+    if (element.tagName && element.tagName.toLowerCase() == "head") {
+      return true;
+    }
+    try {
+      element = element.parentNode;
+    } catch (e) {
+      // Fine. the DOM has dispeared from underneath us
+      return false;
+    }
+  }
+
+  return false;
+};
+
+
+/**
+ * Checks that the element is not hidden by dimensions or CSS
+ */
+Utils.isDisplayed = function(element, scrollIfNecessary) {
+  // Ensure that we're dealing with an element.
+  var el = element;
+  while (el.nodeType != 1 && !(el.nodeType >= 9 && el.nodeType <= 11)) {
+    el = el.parentNode;
+  }
+
+  if (!el) {
+    return false;
+  }
+
+  // Hidden input elements are, by definition, never displayed
+  if (el.tagName == "input" && el.type == "hidden") {
+    return false;
+  }
+
+  var box = scrollIfNecessary ? Utils.getLocationOnceScrolledIntoView(el) : Utils.getLocation(el);
+  // Elements with zero width or height are never displayed
+  if (box.width == 0 || box.height == 0) {
+    return false;
+  }
+
+  var visibility = Utils.getStyleProperty(el, "visibility");
+
+  var _isDisplayed = function(e) {
+    var display = e.ownerDocument.defaultView.getComputedStyle(e, null).
+        getPropertyValue("display");
+    if (display == "none") return display;
+    if (e && e.parentNode && e.parentNode.style) {
+      return _isDisplayed(e.parentNode);
+    }
+    return undefined;
+  };
+
+  var displayed = _isDisplayed(el);
+
+  return displayed != "none" && visibility != "hidden";
+};
+
+
+/**
+ * Gets the computed style of a DOM {@code element}. If the computed style is
+ * inherited from the element's parent, the parent will be queried for its
+ * style value. If the style value is an RGB color string, it will be converted
+ * to hex ("#rrggbb").
+ * @param {Element} element The DOM element whose computed style to retrieve.
+ * @param {string} propertyName The name of the CSS style proeprty to get.
+ * @return {string} The computed style as a string.
+ */
+Utils.getStyleProperty = function(element, propertyName) {
+  if (!element) {
+    return undefined;
+  }
+
+  var value = element.ownerDocument.defaultView.getComputedStyle(element, null).
+      getPropertyValue(propertyName);
+
+  if ('inherit' == value && element.parentNode.style) {
+    value = Utils.getStyleProperty(element.parentNode, propertyName);
+  }
+
+  // Convert colours to hex if possible
+  var raw = /rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)/.exec(value);
+  if (raw) {
+    var hex = (Number(raw[1]) << 16) +
+              (Number(raw[2]) << 8) +
+              (Number(raw[3]));
+    hex = (hex & 0x00ffffff) | 0x1000000;
+    value = '#' + hex.toString(16).substring(1);
+  }
+
+  return value;
+};
+
+
+function collapseWhitespace(textSoFar) {
+  return textSoFar.replace(/\s+/g, " ");
+}
+
+
+function getPreformattedText(node) {
+  var textToAdd = "";
+  return getTextFromNode(node, "", textToAdd, true)[1];
+}
+
+
+function isWhiteSpace(character) {
+  return character == '\n' || character == ' ' || character == '\t' || character
+      == '\r';
+}
+
+
+Utils.getText = function(element) {
+  var bits = getTextFromNode(element, "", "", element.tagName == "PRE");
+  var text = bits[0] + collapseWhitespace(bits[1]);
+  var start = 0;
+  while (start < text.length && isWhiteSpace(text[start])) {
+    ++start;
+  }
+  var end = text.length;
+  while (end > start && isWhiteSpace(text[end - 1])) {
+    --end;
+  }
+  return text.slice(start, end);
+};
+
+
+Utils.addToKnownElements = function(element, context) {
+  var doc = Utils.getDocument(context);
+  if (!doc.fxdriver_elements) {
+    doc.fxdriver_elements = {};
+  }
+
+  for (var e in doc.fxdriver_elements) {
+    if (doc.fxdriver_elements[e] == element) {
+      return e;
+    }
+  }
+  
+  var id = Utils.getUniqueId();
+  doc.fxdriver_elements[id] = element;
+
+  return id;
+};
+
+
+Utils.getElementAt = function(index, context) {
+  var doc = Utils.getDocument(context);
+  var e = doc.fxdriver_elements ? doc.fxdriver_elements[index] : undefined;
+  if (e) {
+    // Is this a stale reference?
+    var parent = e;
+    while (parent && parent != e.ownerDocument.documentElement) {
+      parent = parent.parentNode;
+    }
+
+    if (parent !== e.ownerDocument.documentElement) {
+      // Remove from the cache
+      delete doc.fxdriver_elements[index];
+
+      throw new StaleElementError();
+    }
+  } else {
+    throw new StaleElementError();
+  }
+
+  return e;
+};
+
+
+Utils.currentDocument = function(context) {
+  if (context) {
+    return Utils.getDocument(context);
+  } else {
+    return document;
+  }
+};
+
+
+Utils.platform = function(context) {
+  if (!this.userAgentPlatformLowercase) {
+    var currentWindow = Utils.currentDocument(context).defaultView;
+    this.userAgentPlatformLowercase =
+    currentWindow.navigator.platform.toLowerCase();
+  }
+
+  return this.userAgentPlatformLowercase;
+};
+
+
+Utils.shiftCount = 0;
+
+
+Utils.getNativeEvents = function() {
+  try {
+    const cid = "@openqa.org/nativeevents;1";
+    var obj = Components.classes[cid].createInstance();
+    return obj.QueryInterface(Components.interfaces.nsINativeEvents);
+  } catch(e) {
+    // Unable to retrieve native events. No biggie, because we fall back to
+    // synthesis later
+    return undefined;
+  }
+};
+
+
+Utils.getNodeForNativeEvents = function(element) {
+  try {
+    // This stuff changes between releases.
+    // Do as much up-front work in JS as possible
+    var retrieval = Utils.newInstance(
+        "@mozilla.org/accessibleRetrieval;1", "nsIAccessibleRetrieval");
+    var accessible = retrieval.getAccessibleFor(element.ownerDocument);
+    var accessibleDoc =
+        accessible.QueryInterface(Components.interfaces.nsIAccessibleDocument);
+    return accessibleDoc.QueryInterface(Components.interfaces.nsISupports);
+  } catch(e) {
+    // Unable to retrieve the accessible doc
+    return undefined;
+  }
+};
+
+
+Utils.type = function(context, element, text, opt_useNativeEvents) {
+
+  // For consistency between native and synthesized events, convert common
+  // escape sequences to their Key enum aliases.
+  text = text.replace(new RegExp('\b', 'g'), '\uE003').   // DOM_VK_BACK_SPACE
+      replace(/\t/g, '\uE004').                           // DOM_VK_TAB
+      replace(/(\r\n|\n|\r)/g, '\uE006');                 // DOM_VK_RETURN
+
+  // Special-case file input elements. This is ugly, but should be okay
+  if (element.tagName == "INPUT") {
+    var inputtype = element.getAttribute("type");
+    if (inputtype && inputtype.toLowerCase() == "file") {
+      element.value = text;
+      Utils.fireHtmlEvent(context, element, "change");
+      return;
+    }
+  }
+
+  var obj = Utils.getNativeEvents();
+  var node = Utils.getNodeForNativeEvents(element);
+  const thmgr_cls = Components.classes["@mozilla.org/thread-manager;1"];
+
+  if (opt_useNativeEvents && obj && node && thmgr_cls) {
+
+    // This indicates that a the page has been unloaded
+    var pageHasBeenUnloaded = false;
+    
+    // This is the standard indicator that a page has been unloaded, but
+    // due to Firefox's caching policy, will occur only when Firefox works
+    // *without* caching at all.
+    var unloadFunction = function() { pageHasBeenUnloaded = true; };
+
+    element.ownerDocument.body.addEventListener("unload",
+        unloadFunction, false);
+
+    // This is a Firefox specific event - See:
+    // https://developer.mozilla.org/En/Using_Firefox_1.5_caching
+    element.ownerDocument.defaultView.addEventListener("pagehide",
+        unloadFunction, false);
+
+    // Now do the native thing.
+    obj.sendKeys(node, text);
+
+    var hasEvents = {};
+    var threadmgr =
+        thmgr_cls.getService(Components.interfaces.nsIThreadManager);
+    var thread = threadmgr.currentThread;
+    
+    do {
+
+      // This sleep is needed so that Firefox on Linux will manage to process
+      // all of the keyboard events before returning control to the caller
+      // code (otherwise the caller may not find all of the keystrokes it
+      // has entered).
+      var the_window = element.ownerDocument.defaultView;
+
+      var doneNativeEventWait = false;
+
+      if (the_window) {
+        the_window.setTimeout(function() {
+          doneNativeEventWait = true; }, 100);
+      }
+      
+      // Do it as long as the timeout function has not been called and the
+      // page has not been unloaded. If the page has been unloaded, there is no
+      // point in waiting for other native events to be processed in this page
+      // as they "belong" to the next page.
+      while ((!doneNativeEventWait) && (!pageHasBeenUnloaded)) {
+          thread.processNextEvent(true);
+      }
+
+      obj.hasUnhandledEvents(node, hasEvents);
+
+    } while ((hasEvents.value == true) && (!pageHasBeenUnloaded));
+
+    if (pageHasBeenUnloaded) {
+        Utils.dumpn("Page has been reloaded while waiting for native events to "
+            + "be processed. Remaining events? " + hasEvents.value);
+    } else {
+        // Remove event listeners...
+        element.ownerDocument.body.removeEventListener("unload",
+            unloadFunction, false);
+        element.ownerDocument.defaultView.removeEventListener("pagehide",
+        	unloadFunction, false);
+    }
+
+    // It is possible that, even though the native code reports all of the
+    // keyboard events are out of the GDK event queue, the process is not done.
+    // These keyboard events are converted into Javascript events - and not all
+    // of them may have been processed. In fact, this is the common case when
+    // the sleep timeout above is less than 500 msec.
+    // The appropriate thing to do is process all the remaining JS events.
+    // Only existing events in the queue should be processed - hence the call
+    // to processNextEvent with false.
+    
+    var numExtraEventsProcessed = 0;
+    var hasMoreEvents = thread.processNextEvent(false);
+    // A safety net to prevent the code from endlessly staying in this loop,
+    // in case there is some source of events that's constantly generating them.
+    var MAX_EXTRA_EVENTS_TO_PROCESS = 150;
+    
+    while ((hasMoreEvents) &&
+    		(numExtraEventsProcessed < MAX_EXTRA_EVENTS_TO_PROCESS)) {
+    	hasMoreEvents = thread.processNextEvent(false);
+    	numExtraEventsProcessed += 1;
+    }
+
+    return;
+  }
+
+  Utils.dumpn("Doing sendKeys in a non-native way...")
+  var controlKey = false;
+  var shiftKey = false;
+  var altKey = false;
+  var metaKey = false;
+
+  Utils.shiftCount = 0;
+
+  var upper = text.toUpperCase();
+
+  for (var i = 0; i < text.length; i++) {
+    var c = text.charAt(i);
+
+    // NULL key: reset modifier key states, and continue
+
+    if (c == '\uE000') {
+      if (controlKey) {
+        var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CONTROL;
+        Utils.keyEvent(context, element, "keyup", kCode, 0,
+            controlKey = false, shiftKey, altKey, metaKey);
+      }
+
+      if (shiftKey) {
+        var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
+        Utils.keyEvent(context, element, "keyup", kCode, 0,
+            controlKey, shiftKey = false, altKey, metaKey);
+      }
+
+      if (altKey) {
+        var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ALT;
+        Utils.keyEvent(context, element, "keyup", kCode, 0,
+            controlKey, shiftKey, altKey = false, metaKey);
+      }
+
+      if (metaKey) {
+        var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_META;
+        Utils.keyEvent(context, element, "keyup", kCode, 0,
+            controlKey, shiftKey, altKey, metaKey = false);
+      }
+
+      continue;
+    }
+
+    // otherwise decode keyCode, charCode, modifiers ...
+
+    var modifierEvent = "";
+    var charCode = 0;
+    var keyCode = 0;
+
+    if (c == '\uE001') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CANCEL;
+    } else if (c == '\uE002') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_HELP;
+    } else if (c == '\uE003') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_BACK_SPACE;
+    } else if (c == '\uE004') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_TAB;
+    } else if (c == '\uE005') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CLEAR;
+    } else if (c == '\uE006') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_RETURN;
+    } else if (c == '\uE007') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ENTER;
+    } else if (c == '\uE008') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
+      shiftKey = !shiftKey;
+      modifierEvent = shiftKey ? "keydown" : "keyup";
+    } else if (c == '\uE009') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CONTROL;
+      controlKey = !controlKey;
+      modifierEvent = controlKey ? "keydown" : "keyup";
+    } else if (c == '\uE00A') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ALT;
+      altKey = !altKey;
+      modifierEvent = altKey ? "keydown" : "keyup";
+    } else if (c == '\uE03D') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_META;
+      metaKey = !metaKey;
+      modifierEvent = metaKey ? "keydown" : "keyup";
+    } else if (c == '\uE00B') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PAUSE;
+    } else if (c == '\uE00C') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ESCAPE;
+    } else if (c == '\uE00D') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SPACE;
+      keyCode = charCode = ' '.charCodeAt(0);  // printable
+    } else if (c == '\uE00E') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PAGE_UP;
+    } else if (c == '\uE00F') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PAGE_DOWN;
+    } else if (c == '\uE010') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_END;
+    } else if (c == '\uE011') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_HOME;
+    } else if (c == '\uE012') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_LEFT;
+    } else if (c == '\uE013') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_UP;
+    } else if (c == '\uE014') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_RIGHT;
+    } else if (c == '\uE015') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DOWN;
+    } else if (c == '\uE016') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_INSERT;
+    } else if (c == '\uE017') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DELETE;
+    } else if (c == '\uE018') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SEMICOLON;
+      charCode = ';'.charCodeAt(0);
+    } else if (c == '\uE019') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_EQUALS;
+      charCode = '='.charCodeAt(0);
+    } else if (c == '\uE01A') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD0;
+      charCode = '0'.charCodeAt(0);
+    } else if (c == '\uE01B') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD1;
+      charCode = '1'.charCodeAt(0);
+    } else if (c == '\uE01C') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD2;
+      charCode = '2'.charCodeAt(0);
+    } else if (c == '\uE01D') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD3;
+      charCode = '3'.charCodeAt(0);
+    } else if (c == '\uE01E') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD4;
+      charCode = '4'.charCodeAt(0);
+    } else if (c == '\uE01F') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD5;
+      charCode = '5'.charCodeAt(0);
+    } else if (c == '\uE020') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD6;
+      charCode = '6'.charCodeAt(0);
+    } else if (c == '\uE021') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD7;
+      charCode = '7'.charCodeAt(0);
+    } else if (c == '\uE022') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD8;
+      charCode = '8'.charCodeAt(0);
+    } else if (c == '\uE023') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD9;
+      charCode = '9'.charCodeAt(0);
+    } else if (c == '\uE024') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_MULTIPLY;
+      charCode = '*'.charCodeAt(0);
+    } else if (c == '\uE025') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ADD;
+      charCode = '+'.charCodeAt(0);
+    } else if (c == '\uE026') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SEPARATOR;
+      charCode = ','.charCodeAt(0);
+    } else if (c == '\uE027') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SUBTRACT;
+      charCode = '-'.charCodeAt(0);
+    } else if (c == '\uE028') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DECIMAL;
+      charCode = '.'.charCodeAt(0);
+    } else if (c == '\uE029') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DIVIDE;
+      charCode = '/'.charCodeAt(0);
+    } else if (c == '\uE031') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F1;
+    } else if (c == '\uE032') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F2;
+    } else if (c == '\uE033') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F3;
+    } else if (c == '\uE034') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F4;
+    } else if (c == '\uE035') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F5;
+    } else if (c == '\uE036') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F6;
+    } else if (c == '\uE037') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F7;
+    } else if (c == '\uE038') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F8;
+    } else if (c == '\uE039') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F9;
+    } else if (c == '\uE03A') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F10;
+    } else if (c == '\uE03B') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F11;
+    } else if (c == '\uE03C') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F12;
+    } else if (c == ',' || c == '<') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_COMMA;
+      charCode = c.charCodeAt(0);
+    } else if (c == '.' || c == '>') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PERIOD;
+      charCode = c.charCodeAt(0);
+    } else if (c == '/' || c == '?') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SLASH;
+      charCode = text.charCodeAt(i);
+    } else if (c == '`' || c == '~') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_BACK_QUOTE;
+      charCode = c.charCodeAt(0);
+    } else if (c == '{' || c == '[') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_OPEN_BRACKET;
+      charCode = c.charCodeAt(0);
+    } else if (c == '\\' || c == '|') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_BACK_SLASH;
+      charCode = c.charCodeAt(0);
+    } else if (c == '}' || c == ']') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CLOSE_BRACKET;
+      charCode = c.charCodeAt(0);
+    } else if (c == '\'' || c == '"') {
+      keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_QUOTE;
+      charCode = c.charCodeAt(0);
+    } else {
+      keyCode = upper.charCodeAt(i);
+      charCode = text.charCodeAt(i);
+    }
+
+    // generate modifier key event if needed, and continue
+
+    if (modifierEvent) {
+      Utils.keyEvent(context, element, modifierEvent, keyCode, 0,
+          controlKey, shiftKey, altKey, metaKey);
+      continue;
+    }
+
+    // otherwise, shift down if needed
+
+    var needsShift = false;
+    if (charCode) {
+      needsShift = /[A-Z\!\$\^\*\(\)\+\{\}\:\?\|~@#%&_"<>]/.test(c);
+    }
+
+    if (needsShift && !shiftKey) {
+      var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
+      Utils.keyEvent(context, element, "keydown", kCode, 0,
+          controlKey, true, altKey, metaKey);
+      Utils.shiftCount += 1;
+    }
+
+    // generate key[down/press/up] for key
+
+    var pressCode = keyCode;
+    if (charCode >= 32 && charCode < 127) {
+      pressCode = 0;
+      if (!needsShift && shiftKey && charCode > 32) {
+        // If typing a lowercase character key and the shiftKey is down, the
+        // charCode should be mapped to the shifted key value. This assumes
+        // a default 104 international keyboard layout.
+        if (charCode >= 97 && charCode <= 122) {
+          charCode = charCode + 65 - 97;  // [a-z] -> [A-Z]
+        } else {
+          var mapFrom = '`1234567890-=[]\\;\',./';
+          var mapTo = '~!@#$%^&*()_+{}|:"<>?';
+
+          var value = String.fromCharCode(charCode).
+              replace(/([\[\\\.])/g, '\\$1');
+          var index = mapFrom.search(value);
+          if (index >= 0) {
+            charCode = mapTo.charCodeAt(index);
+          }
+        }
+      }
+    }
+
+    var accepted =
+        Utils.keyEvent(context, element, "keydown", keyCode, 0,
+            controlKey, needsShift || shiftKey, altKey, metaKey);
+
+    Utils.keyEvent(context, element, "keypress", pressCode, charCode,
+        controlKey, needsShift || shiftKey, altKey, metaKey, !accepted);
+
+    Utils.keyEvent(context, element, "keyup", keyCode, 0,
+        controlKey, needsShift || shiftKey, altKey, metaKey);
+
+    // shift up if needed
+
+    if (needsShift && !shiftKey) {
+      var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
+      Utils.keyEvent(context, element, "keyup", kCode, 0,
+          controlKey, false, altKey, metaKey);
+    }
+  }
+
+  // exit cleanup: keyup active modifier keys
+
+  if (controlKey) {
+    var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CONTROL;
+    Utils.keyEvent(context, element, "keyup", kCode, 0,
+        controlKey = false, shiftKey, altKey, metaKey);
+  }
+
+  if (shiftKey) {
+    var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
+    Utils.keyEvent(context, element, "keyup", kCode, 0,
+        controlKey, shiftKey = false, altKey, metaKey);
+  }
+
+  if (altKey) {
+    var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ALT;
+    Utils.keyEvent(context, element, "keyup", kCode, 0,
+        controlKey, shiftKey, altKey = false, metaKey);
+  }
+
+  if (metaKey) {
+    var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_META;
+    Utils.keyEvent(context, element, "keyup", kCode, 0,
+        controlKey, shiftKey, altKey, metaKey = false);
+  }
+};
+
+
+Utils.keyEvent = function(context, element, type, keyCode, charCode,
+                          controlState, shiftState, altState, metaState,
+                          shouldPreventDefault) {
+  var preventDefault = shouldPreventDefault == undefined ? false
+      : shouldPreventDefault;
+
+  var keyboardEvent =
+      Utils.currentDocument(context).createEvent("KeyEvents");
+  var currentView =
+      Utils.currentDocument(context).defaultView;
+
+  keyboardEvent.initKeyEvent(
+      type, //  in DOMString typeArg,
+      true, //  in boolean canBubbleArg
+      true, //  in boolean cancelableArg
+      currentView, //  in nsIDOMAbstractView viewArg
+      controlState, //  in boolean ctrlKeyArg
+      altState, //  in boolean altKeyArg
+      shiftState, //  in boolean shiftKeyArg
+      metaState, //  in boolean metaKeyArg
+      keyCode, //  in unsigned long keyCodeArg
+      charCode);    //  in unsigned long charCodeArg
+
+  if (preventDefault) {
+    keyboardEvent.preventDefault();
+  }
+
+  return element.dispatchEvent(keyboardEvent);
+};
+
+
+Utils.fireHtmlEvent = function(context, element, eventName) {
+  var doc = element.ownerDocument;
+  var e = doc.createEvent("HTMLEvents");
+  e.initEvent(eventName, true, true);
+  return element.dispatchEvent(e);
+};
+
+
+Utils.findForm = function(element) {
+  // Are we already on an element that can be used to submit the form?
+  try {
+    element.QueryInterface(Components.interfaces.nsIDOMHTMLButtonElement);
+    return element;
+  } catch(e) {
+  }
+
+  try {
+    var input =
+        element.QueryInterface(Components.interfaces.nsIDOMHTMLInputElement);
+    if (input.type == "image" || input.type == "submit")
+      return input;
+  } catch(e) {
+  }
+
+  var form = element;
+  while (form) {
+    if (form["submit"])
+      return form;
+    form = form.parentNode;
+  }
+  return undefined;
+};
+
+
+Utils.fireMouseEventOn = function(context, element, eventName) {
+  Utils.triggerMouseEvent(element, eventName, 0, 0);
+};
+
+
+Utils.triggerMouseEvent = function(element, eventType, clientX, clientY) {
+  var event = element.ownerDocument.createEvent("MouseEvents");
+  var view = element.ownerDocument.defaultView;
+
+  event.initMouseEvent(eventType, true, true, view, 1, 0, 0, clientX, clientY,
+      false, false, false, false, 0, element);
+  element.dispatchEvent(event);
+};
+
+
+Utils.findDocumentInFrame = function(browser, frameId) {
+  var frame = Utils.findFrame(browser, frameId);
+  return frame ? frame.document : null;
+};
+
+
+Utils.findFrame = function(browser, frameId) {
+  var stringId = "" + frameId;
+  var names = stringId.split(".");
+  var frame = browser.contentWindow;
+  for (var i = 0; i < names.length; i++) {
+    // Try a numerical index first
+    var index = names[i] - 0;
+    if (!isNaN(index)) {
+      frame = frame.frames[index];
+      if (frame) {
+        return frame;
+      }
+    } else {
+      // Fine. Use the name and loop
+      var found = false;
+      for (var j = 0; j < frame.frames.length; j++) {
+        var f = frame.frames[j];
+        if (f.name == names[i] || f.frameElement.id == names[i]) {
+          frame = f;
+          found = true;
+          break;
+        }
+      }
+
+      if (!found) {
+        return null;
+      }
+    }
+  }
+
+  return frame;
+};
+
+
+Utils.dumpText = function(text) {
+  var consoleService = Utils.getService(
+      "@mozilla.org/consoleservice;1", "nsIConsoleService");
+  if (consoleService)
+    consoleService.logStringMessage(text);
+  else
+    dump(text);
+};
+
+
+Utils.dumpn = function(text) {
+  Utils.dumpText(text + "\n");
+};
+
+
+Utils.dump = function(element) {
+  var dump = "=============\n";
+
+  var rows = [];
+
+  dump += "Supported interfaces: ";
+  for (var i in Components.interfaces) {
+    try {
+      var view = element.QueryInterface(Components.interfaces[i]);
+      dump += i + ", ";
+    } catch (e) {
+      // Doesn't support the interface
+    }
+  }
+  dump += "\n------------\n";
+
+  try {
+    Utils.dumpProperties(element, rows);
+  } catch (e) {
+    Utils.dumpText("caught an exception: " + e);
+  }
+
+  rows.sort();
+  for (var i in rows) {
+    dump += rows[i] + "\n";
+  }
+
+  dump += "=============\n\n\n";
+  Utils.dumpText(dump);
+};
+
+
+Utils.dumpProperties = function(view, rows) {
+  for (var i in view) {
+    var value = "\t" + i + ": ";
+    try {
+      if (typeof(view[i]) == typeof(Function)) {
+        value += " function()";
+      } else {
+        value += String(view[i]);
+      }
+    } catch (e) {
+      value += " Cannot obtain value";
+    }
+
+    rows.push(value);
+  }
+};
+
+
+Utils.stackTrace = function() {
+  var stack = Components.stack;
+  var i = 5;
+  var dump = "";
+  while (i && stack.caller) {
+    stack = stack.caller;
+    dump += stack + "\n";
+  }
+
+  Utils.dumpText(dump);
+};
+
+
+Utils.getElementLocation = function(element, context) {
+  var x = element.offsetLeft;
+  var y = element.offsetTop;
+  var elementParent = element.offsetParent;
+  while (elementParent != null) {
+    if (elementParent.tagName == "TABLE") {
+      var parentBorder = parseInt(elementParent.border);
+      if (isNaN(parentBorder)) {
+        var parentFrame = elementParent.getAttribute('frame');
+        if (parentFrame != null) {
+          x += 1;
+          y += 1;
+        }
+      } else if (parentBorder > 0) {
+        x += parentBorder;
+        y += parentBorder;
+      }
+    }
+    x += elementParent.offsetLeft;
+    y += elementParent.offsetTop;
+    elementParent = elementParent.offsetParent;
+  }
+
+  // Netscape can get confused in some cases, such that the height of the parent
+  // is smaller than that of the element (which it shouldn't really be). If this
+  // is the case, we need to exclude this element, since it will result in too
+  // large a 'top' return value.
+  if (element.offsetParent && element.offsetParent.offsetHeight
+      && element.offsetParent.offsetHeight < element.offsetHeight) {
+    // skip the parent that's too small
+    element = element.offsetParent.offsetParent;
+  } else {
+    // Next up...
+    element = element.offsetParent;
+  }
+  var location = new Object();
+  location.x = x;
+  location.y = y;
+  return location;
+};
+
+
+Utils.findElementsByXPath = function (xpath, contextNode, context) {
+  var doc = Utils.getDocument(context);
+  var result = doc.evaluate(xpath, contextNode, null,
+      Components.interfaces.nsIDOMXPathResult.ORDERED_NODE_ITERATOR_TYPE, null);
+  var indices = [];
+  var element = result.iterateNext();
+  while (element) {
+    var index = Utils.addToKnownElements(element, context);
+    indices.push(index);
+    element = result.iterateNext();
+  }
+  return indices;
+};
+
+
+Utils.getLocation = function(element) {
+  var retrieval = Utils.newInstance(
+      "@mozilla.org/accessibleRetrieval;1", "nsIAccessibleRetrieval");
+
+  try {
+    element = element.wrappedJSObject ? element.wrappedJSObject : element;
+
+    var clientRect = element.getBoundingClientRect();
+
+    // Firefox 3.5
+    if (clientRect['width']) {
+      return {
+        x : clientRect.left + 3,
+        y : clientRect.top,
+        width: clientRect.width,
+        height: clientRect.height
+      };
+    }
+
+    // Firefox 3.0.14 seems to have top, bottom attributes.
+    if (clientRect['top'] !== undefined) {
+      var retWidth = clientRect.right - clientRect.left;
+      var retHeight = clientRect.bottom - clientRect.top;
+      return {
+        x : clientRect.left,
+        y : clientRect.top,
+        width: retWidth,
+        height: retHeight
+      }
+    }
+
+    // Firefox 3.0, but lacking client rect
+    Utils.dumpn("Falling back to firefox3 mechanism");
+    var accessible = retrieval.getAccessibleFor(element);
+
+    var x = {}, y = {}, width = {}, height = {};
+    accessible.getBounds(x, y, width, height);
+
+    return {
+      x : clientRect.left + 3,
+      y : clientRect.top,
+      width: width.value,
+      height: height.value
+    };
+  } catch(e) {
+    Utils.dumpn(e);
+    // Element doesn't have an accessibility node
+  }
+
+  // Firefox 2.0
+
+  Utils.dumpn("Falling back to firefox2 mechanism");
+  // Fallback. Use the (deprecated) method to find out where the element is in
+  // the viewport. This should be fine to use because we only fall down this
+  // code path on older versions of Firefox (I think!)
+  var theDoc = element.ownerDocument;
+  var box = theDoc.getBoxObjectFor(element);
+
+  // We've seen cases where width is 0, despite the element actually having
+  // children with width.
+  // This happens particularly with GWT.
+  if (box.width == 0 || box.height == 0) {
+    // Check the child, and hope the user doesn't nest this stuff. Walk the
+    // children til we find an element. At this point, we know that width and
+    // height are a polite fiction
+    for (var i = 0; i < element.childNodes.length; i++) {
+      var c = element.childNodes[i];
+      if (c.nodeType == 1) {
+        Utils.dumpn(
+            "Width and height are ficticious values, based on child node");
+        box = theDoc.getBoxObjectFor(c);
+        break;
+      }
+    }
+  }
+
+  return {
+    x : box.x + 3,
+    y : box.y,
+    width: box.width,
+    height: box.height
+  };
+};
+
+
+Utils.getLocationOnceScrolledIntoView = function(element) {
+  // Some elements may not a scrollIntoView function - for example,
+  // elements under an SVG element. Call those only if they exist.
+  if (typeof element.scrollIntoView == 'function') {
+    element.scrollIntoView(true);
+  }
+
+  return Utils.getLocation(element);
+};
+
+
+Utils.unwrapParameters = function(wrappedParameters, resultArray, context) {
+  while (wrappedParameters && wrappedParameters.length > 0) {
+    var t = wrappedParameters.shift();
+
+    if (t != null && t.length !== undefined && t.length != null && (t['type']
+        === undefined || t['type'] == null)) {
+      var innerArray = [];
+      Utils.unwrapParameters(t, innerArray);
+      resultArray.push(innerArray);
+      return;
+    }
+
+    if (t['type'] == "ELEMENT") {
+      var element = Utils.getElementAt(t['value'], context);
+      t['value'] = element.wrappedJSObject ? element.wrappedJSObject : element;
+    }
+
+    resultArray.push(t['value']);
+  }
+};
+
+
+Utils.isArray_ = function(obj) {
+  return (obj !== undefined &&
+    obj.constructor.toString().indexOf("Array") != -1);
+}
+
+
+Utils.isHtmlCollection_ = function(obj) {
+  return (obj !== undefined && obj['length'] &&
+    obj['item'] && obj['namedItem']); 
+}
+
+
+Utils.wrapResult = function(result, context) {
+  // Sophisticated.
+  if (null === result || undefined === result) {
+    return {type: "NULL", value: null};
+  } else if (result['tagName']) {
+    return {type: "ELEMENT",
+            value: Utils.addToKnownElements(result, context)};
+  } else if (Utils.isArray_(result) || Utils.isHtmlCollection_(result)) {
+    var array = [];
+    for (var i = 0; i < result.length; i++) {
+      array.push(Utils.wrapResult(result[i], context));
+    }
+    return {type: "ARRAY", value: array};
+  } else {
+    return {type: "OTHER", value: result};
+  }
+}
+
+/**
+ * Gets canonical xpath of the passed element, e.g. /HTML[1]/BODY[1]/P[1]
+ */
+Utils.getXPathOfElement = function(element) {
+  var path = "";
+  for (; element && element.nodeType == 1; element = element.parentNode) {
+    index = Utils.getElementIndexForXPath_(element);
+    path = "/" + element.tagName + "[" + index + "]" + path;
+  }
+  return path;	
+}
+
+/**
+ * Returns n for the nth child of the parent of that element, of type element.tagName, starting at 1
+ */
+Utils.getElementIndexForXPath_ = function (element) {
+  var index = 1;
+  for (var sibling = element.previousSibling; sibling ; sibling = sibling.previousSibling) {
+    if (sibling.nodeType == 1 && sibling.tagName == element.tagName) {
+      index++;
+    }
+  }
+  return index;
+}