src/main/resources/oskeyboard.js

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   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/
   9  *
  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
  13  * License.
  14  *
  15  * The Original Code is guac-common-js.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2010
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  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.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 // Guacamole namespace
  39 var Guacamole = Guacamole || {};
  40
  41 /**
  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.
  45  *
  46  * @constructor
  47  * @param {String} url The URL of an XML keyboard layout file.
  48  */
  49 Guacamole.OnScreenKeyboard = function(url) {
  50
  51     var on_screen_keyboard = this;
  52
  53     var scaledElements = [];
  54
  55     var modifiers = {};
  56     var currentModifier = 1;
  57
  58     // Returns a unique power-of-two value for the modifier with the
  59     // given name. The same value will be returned for the same modifier.
  60     function getModifier(name) {
  61
  62         var value = modifiers[name];
  63         if (!value) {
  64
  65             // Get current modifier, advance to next
  66             value = currentModifier;
  67             currentModifier <<= 1;
  68
  69             // Store value of this modifier
  70             modifiers[name] = value;
  71
  72         }
  73
  74         return value;
  75
  76     }
  77
  78     function ScaledElement(element, width, height, scaleFont) {
  79
  80         this.width = width;
  81         this.height = height;
  82
  83         this.scale = function(pixels) {
  84             element.style.width      = Math.floor(width  * pixels) + "px";
  85             element.style.height     = Math.floor(height * pixels) + "px";
  86
  87             if (scaleFont) {
  88                 element.style.lineHeight = Math.floor(height * pixels) + "px";
  89                 element.style.fontSize   = pixels + "px";
  90             }
  91         }
  92
  93     }
  94
  95     // For each child of element, call handler defined in next
  96     function parseChildren(element, next) {
  97
  98         var children = element.childNodes;
  99         for (var i=0; i<children.length; i++) {
 100
 101             // Get child node
 102             var child = children[i];
 103
 104             // Do not parse text nodes
 105             if (!child.tagName)
 106                 continue;
 107
 108             // Get handler for node
 109             var handler = next[child.tagName];
 110
 111             // Call handler if defined
 112             if (handler)
 113                 handler(child);
 114
 115             // Throw exception if no handler
 116             else
 117                 throw new Error(
 118                       "Unexpected " + child.tagName
 119                     + " within " + element.tagName
 120                 );
 121
 122         }
 123
 124     }
 125
 126     // Create keyboard
 127     var keyboard = document.createElement("div");
 128     keyboard.className = "guac-keyboard";
 129
 130     // Retrieve keyboard XML
 131     var xmlhttprequest = new XMLHttpRequest();
 132     xmlhttprequest.open("GET", url, false);
 133     xmlhttprequest.send(null);
 134
 135     var xml = xmlhttprequest.responseXML;
 136
 137     if (xml) {
 138
 139         function parse_row(e) {
 140
 141             var row = document.createElement("div");
 142             row.className = "guac-keyboard-row";
 143
 144             parseChildren(e, {
 145
 146                 "column": function(e) {
 147                     row.appendChild(parse_column(e));
 148                 },
 149
 150                 "gap": function parse_gap(e) {
 151
 152                     // Get attributes
 153                     var gap_size = e.attributes["size"];
 154
 155                     // Create element
 156                     var gap = document.createElement("div");
 157                     gap.className = "guac-keyboard-gap";
 158
 159                     // Set gap size
 160                     var gap_units = 1;
 161                     if (gap_size)
 162                         gap_units = parseFloat(gap_size.value);
 163
 164                     scaledElements.push(new ScaledElement(gap, gap_units, gap_units));
 165                     row.appendChild(gap);
 166
 167                 },
 168
 169                 "key": function parse_key(e) {
 170
 171                     // Get attributes
 172                     var key_size = e.attributes["size"];
 173
 174                     // Create element
 175                     var key_element = document.createElement("div");
 176                     key_element.className = "guac-keyboard-key";
 177
 178                     // Position keys using container div
 179                     var key_container_element = document.createElement("div");
 180                     key_container_element.className = "guac-keyboard-key-container";
 181                     key_container_element.appendChild(key_element);
 182
 183                     // Create key
 184                     var key = new Guacamole.OnScreenKeyboard.Key();
 185
 186                     // Set key size
 187                     var key_units = 1;
 188                     if (key_size)
 189                         key_units = parseFloat(key_size.value);
 190
 191                     key.size = key_units;
 192
 193                     parseChildren(e, {
 194                         "cap": function parse_cap(e) {
 195
 196                             // Get attributes
 197                             var required = e.attributes["if"];
 198                             var modifier = e.attributes["modifier"];
 199                             var keysym   = e.attributes["keysym"];
 200                             var sticky   = e.attributes["sticky"];
 201
 202                             // Get content of key cap
 203                             var content = e.textContent;
 204
 205                             // Create cap
 206                             var cap = new Guacamole.OnScreenKeyboard.Cap(content,
 207                                 keysym ? keysym.value : null);
 208
 209                             if (modifier)
 210                                 cap.modifier = modifier.value;
 211
 212                             // Create cap element
 213                             var cap_element = document.createElement("div");
 214                             cap_element.className = "guac-keyboard-cap";
 215                             cap_element.textContent = content;
 216                             key_element.appendChild(cap_element);
 217
 218                             // Get modifier value
 219                             var modifierValue = 0;
 220                             if (required) {
 221
 222                                 // Get modifier value for specified comma-delimited
 223                                 // list of required modifiers.
 224                                 var requirements = required.value.split(",");
 225                                 for (var i=0; i<requirements.length; i++) {
 226                                     modifierValue |= getModifier(requirements[i]);
 227                                     cap_element.classList.add("guac-keyboard-requires-" + requirements[i]);
 228                                     key_element.classList.add("guac-keyboard-uses-" + requirements[i]);
 229                                 }
 230
 231                             }
 232
 233                             // Store cap
 234                             key.modifierMask |= modifierValue;
 235                             key.caps[modifierValue] = cap;
 236
 237                         }
 238                     });
 239
 240                     scaledElements.push(new ScaledElement(key_container_element, key_units, 1, true));
 241                     row.appendChild(key_container_element);
 242
 243                     // Set up click handler for key
 244                     key_element.onclick = function() {
 245
 246                         // Get current cap based on modifier state
 247                         var cap = key.getCap(on_screen_keyboard.modifiers);
 248
 249                         // Update modifier state
 250                         if (cap.modifier) {
 251
 252                             // Construct classname for modifier
 253                             var modifierClass = "guac-keyboard-modifier-" + cap.modifier;
 254                             var modifierFlag = getModifier(cap.modifier);
 255
 256                             // Toggle modifier state
 257                             on_screen_keyboard.modifiers ^= modifierFlag;
 258
 259                             // Activate modifier if pressed
 260                             if (on_screen_keyboard.modifiers & modifierFlag)
 261                                 keyboard.classList.add(modifierClass);
 262
 263                             // Deactivate if not pressed
 264                             else
 265                                 keyboard.classList.remove(modifierClass);
 266
 267                         }
 268
 269                         // TODO: Send key event
 270
 271                     };
 272
 273                 }
 274
 275             });
 276
 277             return row;
 278
 279         }
 280
 281         function parse_column(e) {
 282
 283             var col = document.createElement("div");
 284             col.className = "guac-keyboard-column";
 285
 286             var align = col.attributes["align"];
 287
 288             if (align)
 289                 col.style.textAlign = align.value;
 290
 291             // Columns can only contain rows
 292             parseChildren(e, {
 293                 "row": function(e) {
 294                     col.appendChild(parse_row(e));
 295                 }
 296             });
 297
 298             return col;
 299
 300         }
 301
 302
 303         // Parse document
 304         var keyboard_element = xml.documentElement;
 305         if (keyboard_element.tagName != "keyboard")
 306             throw new Error("Root element must be keyboard");
 307
 308         // Get attributes
 309         if (!keyboard_element.attributes["size"])
 310             throw new Error("size attribute is required for keyboard");
 311
 312         var keyboard_size = parseFloat(keyboard_element.attributes["size"].value);
 313
 314         parseChildren(keyboard_element, {
 315
 316             "row": function(e) {
 317                 keyboard.appendChild(parse_row(e));
 318             },
 319
 320             "column": function(e) {
 321                 keyboard.appendChild(parse_column(e));
 322             }
 323
 324         });
 325
 326     }
 327
 328     // Do not allow selection or mouse movement to propagate/register.
 329     keyboard.onselectstart =
 330     keyboard.onmousemove   =
 331     keyboard.onmouseup     =
 332     keyboard.onmousedown   =
 333     function(e) {
 334         e.stopPropagation();
 335         return false;
 336     };
 337
 338     /**
 339      * State of all modifiers.
 340      */
 341     this.modifiers = 0;
 342
 343     this.onkeypressed  = null;
 344     this.onkeyreleased = null;
 345
 346     this.getElement = function() {
 347         return keyboard;
 348     };
 349
 350     this.resize = function(width) {
 351
 352         // Get pixel size of a unit
 353         var unit = Math.floor(width / keyboard_size);
 354
 355         // Resize all scaled elements
 356         for (var i=0; i<scaledElements.length; i++) {
 357             var scaledElement = scaledElements[i];
 358             scaledElement.scale(unit)
 359         }
 360
 361     };
 362
 363 };
 364
 365 Guacamole.OnScreenKeyboard.Key = function() {
 366
 367     var key = this;
 368
 369     /**
 370      * Width of the key, relative to the size of the keyboard.
 371      */
 372     this.size = 1;
 373
 374     /**
 375      * An associative map of all caps by modifier.
 376      */
 377     this.caps = {};
 378
 379     /**
 380      * Bit mask with all modifiers that affect this key set.
 381      */
 382     this.modifierMask = 0;
 383
 384     /**
 385      * Given the bitwise OR of all active modifiers, returns the key cap
 386      * which applies.
 387      */
 388     this.getCap = function(modifier) {
 389         return key.caps[modifier & key.modifierMask];
 390     };
 391
 392 }
 393
 394 Guacamole.OnScreenKeyboard.Cap = function(text, keysym, modifier) {
 395
 396     /**
 397      * Modifier represented by this keycap
 398      */
 399     this.modifier = null;
 400
 401     /**
 402      * The text to be displayed within this keycap
 403      */
 404     this.text = text;
 405
 406     /**
 407      * The keysym this cap sends when its associated key is pressed/released
 408      */
 409     this.keysym = keysym;
 410
 411     // Set modifier if provided
 412     if (modifier) this.modifier = modifier;
 413
 414 }