1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/marionette/marionette-sendkeys.js Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,380 @@
1.4 +/*
1.5 + * Copyright 2007-2009 WebDriver committers
1.6 + * Copyright 2007-2009 Google Inc.
1.7 + * Portions copyright 2012 Software Freedom Conservancy
1.8 + *
1.9 + * Licensed under the Apache License, Version 2.0 (the "License");
1.10 + * you may not use this file except in compliance with the License.
1.11 + * You may obtain a copy of the License at
1.12 + *
1.13 + * http://www.apache.org/licenses/LICENSE-2.0
1.14 + *
1.15 + * Unless required by applicable law or agreed to in writing, software
1.16 + * distributed under the License is distributed on an "AS IS" BASIS,
1.17 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1.18 + * See the License for the specific language governing permissions and
1.19 + * limitations under the License.
1.20 + */
1.21 +
1.22 +
1.23 +var type = function(doc, element, text, releaseModifiers,
1.24 + opt_keysState) {
1.25 +
1.26 + var currentTextLength = element.value ? element.value.length : 0;
1.27 + element.selectionStart = currentTextLength;
1.28 + element.selectionEnd = currentTextLength;
1.29 +
1.30 + // For consistency between native and synthesized events, convert common
1.31 + // escape sequences to their Key enum aliases.
1.32 + text = text.replace(new RegExp('\b', 'g'), '\uE003'). // DOM_VK_BACK_SPACE
1.33 + replace(/\t/g, '\uE004'). // DOM_VK_TAB
1.34 + replace(/(\r\n|\n|\r)/g, '\uE006'); // DOM_VK_RETURN
1.35 +
1.36 + var controlKey = false;
1.37 + var shiftKey = false;
1.38 + var altKey = false;
1.39 + var metaKey = false;
1.40 + if (opt_keysState) {
1.41 + controlKey = opt_keysState.control;
1.42 + shiftKey = opt_keysState.shiftKey;
1.43 + altKey = opt_keysState.alt;
1.44 + metaKey = opt_keysState.meta;
1.45 + }
1.46 +
1.47 + shiftCount = 0;
1.48 +
1.49 + var upper = text.toUpperCase();
1.50 +
1.51 + for (var i = 0; i < text.length; i++) {
1.52 + var c = text.charAt(i);
1.53 +
1.54 + // NULL key: reset modifier key states, and continue
1.55 +
1.56 + if (c == '\uE000') {
1.57 + if (controlKey) {
1.58 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CONTROL;
1.59 + keyEvent(doc, element, "keyup", kCode, 0,
1.60 + controlKey = false, shiftKey, altKey, metaKey, false);
1.61 + }
1.62 +
1.63 + if (shiftKey) {
1.64 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
1.65 + keyEvent(doc, element, "keyup", kCode, 0,
1.66 + controlKey, shiftKey = false, altKey, metaKey, false);
1.67 + }
1.68 +
1.69 + if (altKey) {
1.70 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ALT;
1.71 + keyEvent(doc, element, "keyup", kCode, 0,
1.72 + controlKey, shiftKey, altKey = false, metaKey, false);
1.73 + }
1.74 +
1.75 + if (metaKey) {
1.76 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_META;
1.77 + keyEvent(doc, element, "keyup", kCode, 0,
1.78 + controlKey, shiftKey, altKey, metaKey = false, false);
1.79 + }
1.80 +
1.81 + continue;
1.82 + }
1.83 +
1.84 + // otherwise decode keyCode, charCode, modifiers ...
1.85 +
1.86 + var modifierEvent = "";
1.87 + var charCode = 0;
1.88 + var keyCode = 0;
1.89 +
1.90 + if (c == '\uE001') {
1.91 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CANCEL;
1.92 + } else if (c == '\uE002') {
1.93 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_HELP;
1.94 + } else if (c == '\uE003') {
1.95 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_BACK_SPACE;
1.96 + } else if (c == '\uE004') {
1.97 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_TAB;
1.98 + } else if (c == '\uE005') {
1.99 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CLEAR;
1.100 + } else if (c == '\uE006' || c == '\uE007') {
1.101 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_RETURN;
1.102 + } else if (c == '\uE008') {
1.103 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
1.104 + shiftKey = !shiftKey;
1.105 + modifierEvent = shiftKey ? "keydown" : "keyup";
1.106 + } else if (c == '\uE009') {
1.107 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CONTROL;
1.108 + controlKey = !controlKey;
1.109 + modifierEvent = controlKey ? "keydown" : "keyup";
1.110 + } else if (c == '\uE00A') {
1.111 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ALT;
1.112 + altKey = !altKey;
1.113 + modifierEvent = altKey ? "keydown" : "keyup";
1.114 + } else if (c == '\uE03D') {
1.115 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_META;
1.116 + metaKey = !metaKey;
1.117 + modifierEvent = metaKey ? "keydown" : "keyup";
1.118 + } else if (c == '\uE00B') {
1.119 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PAUSE;
1.120 + } else if (c == '\uE00C') {
1.121 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ESCAPE;
1.122 + } else if (c == '\uE00D') {
1.123 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SPACE;
1.124 + keyCode = charCode = ' '.charCodeAt(0); // printable
1.125 + } else if (c == '\uE00E') {
1.126 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PAGE_UP;
1.127 + } else if (c == '\uE00F') {
1.128 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PAGE_DOWN;
1.129 + } else if (c == '\uE010') {
1.130 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_END;
1.131 + } else if (c == '\uE011') {
1.132 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_HOME;
1.133 + } else if (c == '\uE012') {
1.134 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_LEFT;
1.135 + } else if (c == '\uE013') {
1.136 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_UP;
1.137 + } else if (c == '\uE014') {
1.138 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_RIGHT;
1.139 + } else if (c == '\uE015') {
1.140 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DOWN;
1.141 + } else if (c == '\uE016') {
1.142 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_INSERT;
1.143 + } else if (c == '\uE017') {
1.144 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DELETE;
1.145 + } else if (c == '\uE018') {
1.146 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SEMICOLON;
1.147 + charCode = ';'.charCodeAt(0);
1.148 + } else if (c == '\uE019') {
1.149 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_EQUALS;
1.150 + charCode = '='.charCodeAt(0);
1.151 + } else if (c == '\uE01A') {
1.152 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD0;
1.153 + charCode = '0'.charCodeAt(0);
1.154 + } else if (c == '\uE01B') {
1.155 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD1;
1.156 + charCode = '1'.charCodeAt(0);
1.157 + } else if (c == '\uE01C') {
1.158 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD2;
1.159 + charCode = '2'.charCodeAt(0);
1.160 + } else if (c == '\uE01D') {
1.161 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD3;
1.162 + charCode = '3'.charCodeAt(0);
1.163 + } else if (c == '\uE01E') {
1.164 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD4;
1.165 + charCode = '4'.charCodeAt(0);
1.166 + } else if (c == '\uE01F') {
1.167 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD5;
1.168 + charCode = '5'.charCodeAt(0);
1.169 + } else if (c == '\uE020') {
1.170 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD6;
1.171 + charCode = '6'.charCodeAt(0);
1.172 + } else if (c == '\uE021') {
1.173 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD7;
1.174 + charCode = '7'.charCodeAt(0);
1.175 + } else if (c == '\uE022') {
1.176 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD8;
1.177 + charCode = '8'.charCodeAt(0);
1.178 + } else if (c == '\uE023') {
1.179 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_NUMPAD9;
1.180 + charCode = '9'.charCodeAt(0);
1.181 + } else if (c == '\uE024') {
1.182 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_MULTIPLY;
1.183 + charCode = '*'.charCodeAt(0);
1.184 + } else if (c == '\uE025') {
1.185 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ADD;
1.186 + charCode = '+'.charCodeAt(0);
1.187 + } else if (c == '\uE026') {
1.188 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SEPARATOR;
1.189 + charCode = ','.charCodeAt(0);
1.190 + } else if (c == '\uE027') {
1.191 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SUBTRACT;
1.192 + charCode = '-'.charCodeAt(0);
1.193 + } else if (c == '\uE028') {
1.194 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DECIMAL;
1.195 + charCode = '.'.charCodeAt(0);
1.196 + } else if (c == '\uE029') {
1.197 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_DIVIDE;
1.198 + charCode = '/'.charCodeAt(0);
1.199 + } else if (c == '\uE031') {
1.200 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F1;
1.201 + } else if (c == '\uE032') {
1.202 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F2;
1.203 + } else if (c == '\uE033') {
1.204 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F3;
1.205 + } else if (c == '\uE034') {
1.206 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F4;
1.207 + } else if (c == '\uE035') {
1.208 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F5;
1.209 + } else if (c == '\uE036') {
1.210 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F6;
1.211 + } else if (c == '\uE037') {
1.212 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F7;
1.213 + } else if (c == '\uE038') {
1.214 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F8;
1.215 + } else if (c == '\uE039') {
1.216 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F9;
1.217 + } else if (c == '\uE03A') {
1.218 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F10;
1.219 + } else if (c == '\uE03B') {
1.220 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F11;
1.221 + } else if (c == '\uE03C') {
1.222 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_F12;
1.223 + } else if (c == ',' || c == '<') {
1.224 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_COMMA;
1.225 + charCode = c.charCodeAt(0);
1.226 + } else if (c == '.' || c == '>') {
1.227 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_PERIOD;
1.228 + charCode = c.charCodeAt(0);
1.229 + } else if (c == '/' || c == '?') {
1.230 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SLASH;
1.231 + charCode = text.charCodeAt(i);
1.232 + } else if (c == '`' || c == '~') {
1.233 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_BACK_QUOTE;
1.234 + charCode = c.charCodeAt(0);
1.235 + } else if (c == '{' || c == '[') {
1.236 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_OPEN_BRACKET;
1.237 + charCode = c.charCodeAt(0);
1.238 + } else if (c == '\\' || c == '|') {
1.239 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_BACK_SLASH;
1.240 + charCode = c.charCodeAt(0);
1.241 + } else if (c == '}' || c == ']') {
1.242 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CLOSE_BRACKET;
1.243 + charCode = c.charCodeAt(0);
1.244 + } else if (c == '\'' || c == '"') {
1.245 + keyCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_QUOTE;
1.246 + charCode = c.charCodeAt(0);
1.247 + } else {
1.248 + keyCode = upper.charCodeAt(i);
1.249 + charCode = text.charCodeAt(i);
1.250 + }
1.251 +
1.252 + // generate modifier key event if needed, and continue
1.253 +
1.254 + if (modifierEvent) {
1.255 + keyEvent(doc, element, modifierEvent, keyCode, 0,
1.256 + controlKey, shiftKey, altKey, metaKey, false);
1.257 + continue;
1.258 + }
1.259 +
1.260 + // otherwise, shift down if needed
1.261 +
1.262 + var needsShift = false;
1.263 + if (charCode) {
1.264 + needsShift = /[A-Z\!\$\^\*\(\)\+\{\}\:\?\|~@#%&_"<>]/.test(c);
1.265 + }
1.266 +
1.267 + if (needsShift && !shiftKey) {
1.268 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
1.269 + keyEvent(doc, element, "keydown", kCode, 0,
1.270 + controlKey, true, altKey, metaKey, false);
1.271 + shiftCount += 1;
1.272 + }
1.273 +
1.274 + // generate key[down/press/up] for key
1.275 +
1.276 + var pressCode = keyCode;
1.277 + if (charCode >= 32 && charCode < 127) {
1.278 + pressCode = 0;
1.279 + if (!needsShift && shiftKey && charCode > 32) {
1.280 + // If typing a lowercase character key and the shiftKey is down, the
1.281 + // charCode should be mapped to the shifted key value. This assumes
1.282 + // a default 104 international keyboard layout.
1.283 + if (charCode >= 97 && charCode <= 122) {
1.284 + charCode = charCode + 65 - 97; // [a-z] -> [A-Z]
1.285 + } else {
1.286 + var mapFrom = '`1234567890-=[]\\;\',./';
1.287 + var mapTo = '~!@#$%^&*()_+{}|:"<>?';
1.288 +
1.289 + var value = String.fromCharCode(charCode).
1.290 + replace(/([\[\\\.])/g, '\\$1');
1.291 + var index = mapFrom.search(value);
1.292 + if (index >= 0) {
1.293 + charCode = mapTo.charCodeAt(index);
1.294 + }
1.295 + }
1.296 + }
1.297 + }
1.298 +
1.299 + var accepted =
1.300 + keyEvent(doc, element, "keydown", keyCode, 0,
1.301 + controlKey, needsShift || shiftKey, altKey, metaKey, false);
1.302 +
1.303 + keyEvent(doc, element, "keypress", pressCode, charCode,
1.304 + controlKey, needsShift || shiftKey, altKey, metaKey, !accepted);
1.305 +
1.306 + keyEvent(doc, element, "keyup", keyCode, 0,
1.307 + controlKey, needsShift || shiftKey, altKey, metaKey, false);
1.308 +
1.309 + // shift up if needed
1.310 +
1.311 + if (needsShift && !shiftKey) {
1.312 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
1.313 + keyEvent(doc, element, "keyup", kCode, 0,
1.314 + controlKey, false, altKey, metaKey, false);
1.315 + }
1.316 + }
1.317 +
1.318 + // exit cleanup: keyup active modifier keys
1.319 +
1.320 + if (controlKey && releaseModifiers) {
1.321 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_CONTROL;
1.322 + keyEvent(doc, element, "keyup", kCode, 0,
1.323 + controlKey = false, shiftKey, altKey, metaKey, false);
1.324 + }
1.325 +
1.326 + if (shiftKey && releaseModifiers) {
1.327 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_SHIFT;
1.328 + keyEvent(doc, element, "keyup", kCode, 0,
1.329 + controlKey, shiftKey = false, altKey, metaKey, false);
1.330 + }
1.331 +
1.332 + if (altKey && releaseModifiers) {
1.333 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_ALT;
1.334 + keyEvent(doc, element, "keyup", kCode, 0,
1.335 + controlKey, shiftKey, altKey = false, metaKey, false);
1.336 + }
1.337 +
1.338 + if (metaKey && releaseModifiers) {
1.339 + var kCode = Components.interfaces.nsIDOMKeyEvent.DOM_VK_META;
1.340 + keyEvent(doc, element, "keyup", kCode, 0,
1.341 + controlKey, shiftKey, altKey, metaKey = false, false);
1.342 + }
1.343 +
1.344 + return {
1.345 + shiftKey: shiftKey,
1.346 + alt: altKey,
1.347 + meta: metaKey,
1.348 + control: controlKey
1.349 + };
1.350 +};
1.351 +
1.352 +
1.353 +var keyEvent = function(doc, element, type, keyCode, charCode,
1.354 + controlState, shiftState, altState, metaState,
1.355 + shouldPreventDefault) {
1.356 + var preventDefault = shouldPreventDefault == undefined ? false
1.357 + : shouldPreventDefault;
1.358 +
1.359 + var keyboardEvent = doc.createEvent("KeyEvents");
1.360 + var currentView = doc.defaultView;
1.361 +
1.362 + keyboardEvent.initKeyEvent(
1.363 + type, // in DOMString typeArg,
1.364 + true, // in boolean canBubbleArg
1.365 + true, // in boolean cancelableArg
1.366 + currentView, // in nsIDOMAbstractView viewArg
1.367 + controlState, // in boolean ctrlKeyArg
1.368 + altState, // in boolean altKeyArg
1.369 + shiftState, // in boolean shiftKeyArg
1.370 + metaState, // in boolean metaKeyArg
1.371 + keyCode, // in unsigned long keyCodeArg
1.372 + charCode); // in unsigned long charCodeArg
1.373 +
1.374 + if (preventDefault) {
1.375 + keyboardEvent.preventDefault();
1.376 + }
1.377 +
1.378 + var win = doc.defaultView;
1.379 + var domUtil = win.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
1.380 + .getInterface(Components.interfaces.nsIDOMWindowUtils);
1.381 + return domUtil.dispatchDOMEventViaPresShell(element, keyboardEvent, true);
1.382 +};
1.383 +
