2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
15 * The Original Code is guac-common-js.
17 * The Initial Developer of the Original Code is
19 * Portions created by the Initial Developer are Copyright (C) 2010
20 * the Initial Developer. All Rights Reserved.
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
36 * ***** END LICENSE BLOCK ***** */
38 // Guacamole namespace
39 var Guacamole = Guacamole || {};
42 * Dynamic on-screen keyboard. Given the URL to an XML keyboard layout file,
43 * this object will download and use the XML to construct a clickable on-screen
44 * keyboard with its own key events.
47 * @param {String} url The URL of an XML keyboard layout file.
49 Guacamole.OnScreenKeyboard = function(url) {
51 var on_screen_keyboard = this;
53 var scaledElements = [];
56 var currentModifier = 1;
58 // Function for adding a class to an element
61 // Function for removing a class from an element
64 // If Node.classList is supported, implement addClass/removeClass using that
67 addClass = function(element, classname) {
68 element.classList.add(classname);
71 removeClass = function(element, classname) {
72 element.classList.remove(classname);
77 // Otherwise, implement own
80 addClass = function(element, classname) {
82 // Simply add new class
83 element.className += " " + classname;
87 removeClass = function(element, classname) {
89 // Filter out classes with given name
90 element.className = element.className.replace(/([^ ]+)[ ]*/g,
91 function(match, testClassname, spaces, offset, string) {
93 // If same class, remove
94 if (testClassname == classname)
107 // Returns a unique power-of-two value for the modifier with the
108 // given name. The same value will be returned for the same modifier.
109 function getModifier(name) {
111 var value = modifiers[name];
114 // Get current modifier, advance to next
115 value = currentModifier;
116 currentModifier <<= 1;
118 // Store value of this modifier
119 modifiers[name] = value;
127 function ScaledElement(element, width, height, scaleFont) {
130 this.height = height;
132 this.scale = function(pixels) {
133 element.style.width = (width * pixels) + "px";
134 element.style.height = (height * pixels) + "px";
137 element.style.lineHeight = (height * pixels) + "px";
138 element.style.fontSize = pixels + "px";
144 // For each child of element, call handler defined in next
145 function parseChildren(element, next) {
147 var children = element.childNodes;
148 for (var i=0; i<children.length; i++) {
151 var child = children[i];
153 // Do not parse text nodes
157 // Get handler for node
158 var handler = next[child.tagName];
160 // Call handler if defined
164 // Throw exception if no handler
167 "Unexpected " + child.tagName
168 + " within " + element.tagName
176 var keyboard = document.createElement("div");
177 keyboard.className = "guac-keyboard";
179 // Retrieve keyboard XML
180 var xmlhttprequest = new XMLHttpRequest();
181 xmlhttprequest.open("GET", url, false);
182 xmlhttprequest.send(null);
184 var xml = xmlhttprequest.responseXML;
188 function parse_row(e) {
190 var row = document.createElement("div");
191 row.className = "guac-keyboard-row";
195 "column": function(e) {
196 row.appendChild(parse_column(e));
199 "gap": function parse_gap(e) {
202 var gap = document.createElement("div");
203 gap.className = "guac-keyboard-gap";
207 if (e.getAttribute("size"))
208 gap_units = parseFloat(e.getAttribute("size"));
210 scaledElements.push(new ScaledElement(gap, gap_units, gap_units));
211 row.appendChild(gap);
215 "key": function parse_key(e) {
218 var key_element = document.createElement("div");
219 key_element.className = "guac-keyboard-key";
221 // Append class if specified
222 if (e.getAttribute("class"))
223 key_element.className += " " + e.getAttribute("class");
225 // Position keys using container div
226 var key_container_element = document.createElement("div");
227 key_container_element.className = "guac-keyboard-key-container";
228 key_container_element.appendChild(key_element);
231 var key = new Guacamole.OnScreenKeyboard.Key();
235 if (e.getAttribute("size"))
236 key_units = parseFloat(e.getAttribute("size"));
238 key.size = key_units;
241 "cap": function parse_cap(e) {
243 // TODO: Handle "sticky" attribute
245 // Get content of key cap
246 var content = e.textContent || e.text;
248 // If read as blank, assume cap is a single space.
249 if (content.length == 0)
253 var real_keysym = null;
254 if (e.getAttribute("keysym"))
255 real_keysym = parseInt(e.getAttribute("keysym"));
257 // If no keysym specified, try to get from key content
258 else if (content.length == 1) {
260 var charCode = content.charCodeAt(0);
261 if (charCode >= 0x0000 && charCode <= 0x00FF)
262 real_keysym = charCode;
263 else if (charCode >= 0x0100 && charCode <= 0x10FFFF)
264 real_keysym = 0x01000000 | charCode;
269 var cap = new Guacamole.OnScreenKeyboard.Cap(content, real_keysym);
271 if (e.getAttribute("modifier"))
272 cap.modifier = e.getAttribute("modifier");
274 // Create cap element
275 var cap_element = document.createElement("div");
276 cap_element.className = "guac-keyboard-cap";
277 cap_element.textContent = content;
278 key_element.appendChild(cap_element);
280 // Append class if specified
281 if (e.getAttribute("class"))
282 cap_element.className += " " + e.getAttribute("class");
284 // Get modifier value
285 var modifierValue = 0;
286 if (e.getAttribute("if")) {
288 // Get modifier value for specified comma-delimited
289 // list of required modifiers.
290 var requirements = e.getAttribute("if").split(",");
291 for (var i=0; i<requirements.length; i++) {
292 modifierValue |= getModifier(requirements[i]);
293 addClass(cap_element, "guac-keyboard-requires-" + requirements[i]);
294 addClass(key_element, "guac-keyboard-uses-" + requirements[i]);
300 key.modifierMask |= modifierValue;
301 key.caps[modifierValue] = cap;
306 scaledElements.push(new ScaledElement(key_container_element, key_units, 1, true));
307 row.appendChild(key_container_element);
309 // Set up click handler for key
312 // Press key if not yet pressed
315 addClass(key_element, "guac-keyboard-pressed");
317 // Get current cap based on modifier state
318 var cap = key.getCap(on_screen_keyboard.modifiers);
320 // Update modifier state
323 // Construct classname for modifier
324 var modifierClass = "guac-keyboard-modifier-" + cap.modifier;
325 var modifierFlag = getModifier(cap.modifier);
327 // Toggle modifier state
328 on_screen_keyboard.modifiers ^= modifierFlag;
330 // Activate modifier if pressed
331 if (on_screen_keyboard.modifiers & modifierFlag) {
333 addClass(keyboard, modifierClass);
336 if (on_screen_keyboard.onkeydown && cap.keysym)
337 on_screen_keyboard.onkeydown(cap.keysym);
341 // Deactivate if not pressed
344 removeClass(keyboard, modifierClass);
347 if (on_screen_keyboard.onkeyup && cap.keysym)
348 on_screen_keyboard.onkeyup(cap.keysym);
354 // If not modifier, send key event now
355 else if (on_screen_keyboard.onkeydown && cap.keysym)
356 on_screen_keyboard.onkeydown(cap.keysym);
358 // Mark key as pressed
367 function release(e) {
369 // Release key if currently pressed
372 // Get current cap based on modifier state
373 var cap = key.getCap(on_screen_keyboard.modifiers);
375 removeClass(key_element, "guac-keyboard-pressed");
377 // Send key event if not a modifier key
378 if (!cap.modifier && on_screen_keyboard.onkeyup && cap.keysym)
379 on_screen_keyboard.onkeyup(cap.keysym);
381 // Mark key as released
390 key_element.addEventListener("mousedown", press, true);
391 key_element.addEventListener("touchstart", press, true);
393 key_element.addEventListener("mouseup", release, true);
394 key_element.addEventListener("mouseout", release, true);
395 key_element.addEventListener("touchend", release, true);
405 function parse_column(e) {
407 var col = document.createElement("div");
408 col.className = "guac-keyboard-column";
410 if (col.getAttribute("align"))
411 col.style.textAlign = col.getAttribute("align");
413 // Columns can only contain rows
416 col.appendChild(parse_row(e));
426 var keyboard_element = xml.documentElement;
427 if (keyboard_element.tagName != "keyboard")
428 throw new Error("Root element must be keyboard");
431 if (!keyboard_element.getAttribute("size"))
432 throw new Error("size attribute is required for keyboard");
434 var keyboard_size = parseFloat(keyboard_element.getAttribute("size"));
436 parseChildren(keyboard_element, {
439 keyboard.appendChild(parse_row(e));
442 "column": function(e) {
443 keyboard.appendChild(parse_column(e));
450 // Do not allow selection or mouse movement to propagate/register.
451 keyboard.onselectstart =
452 keyboard.onmousemove =
454 keyboard.onmousedown =
461 * State of all modifiers.
465 this.onkeydown = null;
468 this.getElement = function() {
472 this.resize = function(width) {
474 // Get pixel size of a unit
475 var unit = Math.floor(width * 10 / keyboard_size) / 10;
477 // Resize all scaled elements
478 for (var i=0; i<scaledElements.length; i++) {
479 var scaledElement = scaledElements[i];
480 scaledElement.scale(unit)
487 Guacamole.OnScreenKeyboard.Key = function() {
492 * Whether this key is currently pressed.
494 this.pressed = false;
497 * Width of the key, relative to the size of the keyboard.
502 * An associative map of all caps by modifier.
507 * Bit mask with all modifiers that affect this key set.
509 this.modifierMask = 0;
512 * Given the bitwise OR of all active modifiers, returns the key cap
515 this.getCap = function(modifier) {
516 return key.caps[modifier & key.modifierMask];
521 Guacamole.OnScreenKeyboard.Cap = function(text, keysym, modifier) {
524 * Modifier represented by this keycap
526 this.modifier = null;
529 * The text to be displayed within this keycap
534 * The keysym this cap sends when its associated key is pressed/released
536 this.keysym = keysym;
538 // Set modifier if provided
539 if (modifier) this.modifier = modifier;