tests/test.helper.js

   1 const expect = chai.expect;
   2
   3 import keysyms from '../core/input/keysymdef.js';
   4 import * as KeyboardUtil from "../core/input/util.js";
   5
   6 describe('Helpers', function () {
   7     "use strict";
   8
   9     describe('keysyms.lookup', function () {
  10         it('should map ASCII characters to keysyms', function () {
  11             expect(keysyms.lookup('a'.charCodeAt())).to.be.equal(0x61);
  12             expect(keysyms.lookup('A'.charCodeAt())).to.be.equal(0x41);
  13         });
  14         it('should map Latin-1 characters to keysyms', function () {
  15             expect(keysyms.lookup('ø'.charCodeAt())).to.be.equal(0xf8);
  16
  17             expect(keysyms.lookup('é'.charCodeAt())).to.be.equal(0xe9);
  18         });
  19         it('should map characters that are in Windows-1252 but not in Latin-1 to keysyms', function () {
  20             expect(keysyms.lookup('Š'.charCodeAt())).to.be.equal(0x01a9);
  21         });
  22         it('should map characters which aren\'t in Latin1 *or* Windows-1252 to keysyms', function () {
  23             expect(keysyms.lookup('ũ'.charCodeAt())).to.be.equal(0x03fd);
  24         });
  25         it('should map unknown codepoints to the Unicode range', function () {
  26             expect(keysyms.lookup('\n'.charCodeAt())).to.be.equal(0x100000a);
  27             expect(keysyms.lookup('\u262D'.charCodeAt())).to.be.equal(0x100262d);
  28         });
  29         // This requires very recent versions of most browsers... skipping for now
  30         it.skip('should map UCS-4 codepoints to the Unicode range', function () {
  31             //expect(keysyms.lookup('\u{1F686}'.codePointAt())).to.be.equal(0x101f686);
  32         });
  33     });
  34
  35     describe('getKeycode', function () {
  36         it('should pass through proper code', function () {
  37             expect(KeyboardUtil.getKeycode({code: 'Semicolon'})).to.be.equal('Semicolon');
  38         });
  39         it('should map legacy values', function () {
  40             expect(KeyboardUtil.getKeycode({code: ''})).to.be.equal('Unidentified');
  41             expect(KeyboardUtil.getKeycode({code: 'OSLeft'})).to.be.equal('MetaLeft');
  42         });
  43         it('should map keyCode to code when possible', function () {
  44             expect(KeyboardUtil.getKeycode({keyCode: 0x14})).to.be.equal('CapsLock');
  45             expect(KeyboardUtil.getKeycode({keyCode: 0x5b})).to.be.equal('MetaLeft');
  46             expect(KeyboardUtil.getKeycode({keyCode: 0x35})).to.be.equal('Digit5');
  47             expect(KeyboardUtil.getKeycode({keyCode: 0x65})).to.be.equal('Numpad5');
  48         });
  49         it('should map keyCode left/right side', function () {
  50             expect(KeyboardUtil.getKeycode({keyCode: 0x10, location: 1})).to.be.equal('ShiftLeft');
  51             expect(KeyboardUtil.getKeycode({keyCode: 0x10, location: 2})).to.be.equal('ShiftRight');
  52             expect(KeyboardUtil.getKeycode({keyCode: 0x11, location: 1})).to.be.equal('ControlLeft');
  53             expect(KeyboardUtil.getKeycode({keyCode: 0x11, location: 2})).to.be.equal('ControlRight');
  54         });
  55         it('should map keyCode on numpad', function () {
  56             expect(KeyboardUtil.getKeycode({keyCode: 0x0d, location: 0})).to.be.equal('Enter');
  57             expect(KeyboardUtil.getKeycode({keyCode: 0x0d, location: 3})).to.be.equal('NumpadEnter');
  58             expect(KeyboardUtil.getKeycode({keyCode: 0x23, location: 0})).to.be.equal('End');
  59             expect(KeyboardUtil.getKeycode({keyCode: 0x23, location: 3})).to.be.equal('Numpad1');
  60         });
  61         it('should return Unidentified when it cannot map the keyCode', function () {
  62             expect(KeyboardUtil.getKeycode({keycode: 0x42})).to.be.equal('Unidentified');
  63         });
  64
  65         describe('Fix Meta on macOS', function () {
  66             let origNavigator;
  67             beforeEach(function () {
  68                 // window.navigator is a protected read-only property in many
  69                 // environments, so we need to redefine it whilst running these
  70                 // tests.
  71                 origNavigator = Object.getOwnPropertyDescriptor(window, "navigator");
  72
  73                 Object.defineProperty(window, "navigator", {value: {}});
  74                 if (window.navigator.platform !== undefined) {
  75                     // Object.defineProperty() doesn't work properly in old
  76                     // versions of Chrome
  77                     this.skip();
  78                 }
  79
  80                 window.navigator.platform = "Mac x86_64";
  81             });
  82             afterEach(function () {
  83                 if (origNavigator !== undefined) {
  84                     Object.defineProperty(window, "navigator", origNavigator);
  85                 }
  86             });
  87
  88             it('should respect ContextMenu on modern browser', function () {
  89                 expect(KeyboardUtil.getKeycode({code: 'ContextMenu', keyCode: 0x5d})).to.be.equal('ContextMenu');
  90             });
  91             it('should translate legacy ContextMenu to MetaRight', function () {
  92                 expect(KeyboardUtil.getKeycode({keyCode: 0x5d})).to.be.equal('MetaRight');
  93             });
  94         });
  95     });
  96
  97     describe('getKey', function () {
  98         it('should prefer key', function () {
  99             expect(KeyboardUtil.getKey({key: 'a', charCode: 'Š'.charCodeAt(), keyCode: 0x42, which: 0x43})).to.be.equal('a');
 100         });
 101         it('should map legacy values', function () {
 102             expect(KeyboardUtil.getKey({key: 'OS'})).to.be.equal('Meta');
 103             expect(KeyboardUtil.getKey({key: 'UIKeyInputLeftArrow'})).to.be.equal('ArrowLeft');
 104         });
 105         it('should handle broken Delete', function () {
 106             expect(KeyboardUtil.getKey({key: '\x00', code: 'NumpadDecimal'})).to.be.equal('Delete');
 107         });
 108         it('should use code if no key', function () {
 109             expect(KeyboardUtil.getKey({code: 'NumpadBackspace'})).to.be.equal('Backspace');
 110         });
 111         it('should not use code fallback for character keys', function () {
 112             expect(KeyboardUtil.getKey({code: 'KeyA'})).to.be.equal('Unidentified');
 113             expect(KeyboardUtil.getKey({code: 'Digit1'})).to.be.equal('Unidentified');
 114             expect(KeyboardUtil.getKey({code: 'Period'})).to.be.equal('Unidentified');
 115             expect(KeyboardUtil.getKey({code: 'Numpad1'})).to.be.equal('Unidentified');
 116         });
 117         it('should use charCode if no key', function () {
 118             expect(KeyboardUtil.getKey({charCode: 'Š'.charCodeAt(), keyCode: 0x42, which: 0x43})).to.be.equal('Š');
 119         });
 120         it('should return Unidentified when it cannot map the key', function () {
 121             expect(KeyboardUtil.getKey({keycode: 0x42})).to.be.equal('Unidentified');
 122         });
 123     });
 124
 125     describe('getKeysym', function () {
 126         describe('Non-character keys', function () {
 127             it('should recognize the right keys', function () {
 128                 expect(KeyboardUtil.getKeysym({key: 'Enter'})).to.be.equal(0xFF0D);
 129                 expect(KeyboardUtil.getKeysym({key: 'Backspace'})).to.be.equal(0xFF08);
 130                 expect(KeyboardUtil.getKeysym({key: 'Tab'})).to.be.equal(0xFF09);
 131                 expect(KeyboardUtil.getKeysym({key: 'Shift'})).to.be.equal(0xFFE1);
 132                 expect(KeyboardUtil.getKeysym({key: 'Control'})).to.be.equal(0xFFE3);
 133                 expect(KeyboardUtil.getKeysym({key: 'Alt'})).to.be.equal(0xFFE9);
 134                 expect(KeyboardUtil.getKeysym({key: 'Meta'})).to.be.equal(0xFFEB);
 135                 expect(KeyboardUtil.getKeysym({key: 'Escape'})).to.be.equal(0xFF1B);
 136                 expect(KeyboardUtil.getKeysym({key: 'ArrowUp'})).to.be.equal(0xFF52);
 137             });
 138             it('should map left/right side', function () {
 139                 expect(KeyboardUtil.getKeysym({key: 'Shift', location: 1})).to.be.equal(0xFFE1);
 140                 expect(KeyboardUtil.getKeysym({key: 'Shift', location: 2})).to.be.equal(0xFFE2);
 141                 expect(KeyboardUtil.getKeysym({key: 'Control', location: 1})).to.be.equal(0xFFE3);
 142                 expect(KeyboardUtil.getKeysym({key: 'Control', location: 2})).to.be.equal(0xFFE4);
 143             });
 144             it('should handle AltGraph', function () {
 145                 expect(KeyboardUtil.getKeysym({code: 'AltRight', key: 'Alt', location: 2})).to.be.equal(0xFFEA);
 146                 expect(KeyboardUtil.getKeysym({code: 'AltRight', key: 'AltGraph', location: 2})).to.be.equal(0xFE03);
 147             });
 148             it('should handle Windows key with incorrect location', function () {
 149                 expect(KeyboardUtil.getKeysym({key: 'Meta', location: 0})).to.be.equal(0xFFEC);
 150             });
 151             it('should handle Clear/NumLock key with incorrect location', function () {
 152                 this.skip(); // Broken because of Clear/NumLock override
 153                 expect(KeyboardUtil.getKeysym({key: 'Clear', code: 'NumLock', location: 3})).to.be.equal(0xFF0B);
 154             });
 155             it('should handle Meta/Windows distinction', function () {
 156                 expect(KeyboardUtil.getKeysym({code: 'AltLeft', key: 'Meta', location: 1})).to.be.equal(0xFFE7);
 157                 expect(KeyboardUtil.getKeysym({code: 'AltRight', key: 'Meta', location: 2})).to.be.equal(0xFFE8);
 158                 expect(KeyboardUtil.getKeysym({code: 'MetaLeft', key: 'Meta', location: 1})).to.be.equal(0xFFEB);
 159                 expect(KeyboardUtil.getKeysym({code: 'MetaRight', key: 'Meta', location: 2})).to.be.equal(0xFFEC);
 160             });
 161             it('should send NumLock even if key is Clear', function () {
 162                 expect(KeyboardUtil.getKeysym({key: 'Clear', code: 'NumLock'})).to.be.equal(0xFF7F);
 163             });
 164             it('should return null for unknown keys', function () {
 165                 expect(KeyboardUtil.getKeysym({key: 'Semicolon'})).to.be.null;
 166                 expect(KeyboardUtil.getKeysym({key: 'BracketRight'})).to.be.null;
 167             });
 168             it('should handle remappings', function () {
 169                 expect(KeyboardUtil.getKeysym({code: 'ControlLeft', key: 'Tab'})).to.be.equal(0xFF09);
 170             });
 171         });
 172
 173         describe('Numpad', function () {
 174             it('should handle Numpad numbers', function () {
 175                 expect(KeyboardUtil.getKeysym({code: 'Digit5', key: '5', location: 0})).to.be.equal(0x0035);
 176                 expect(KeyboardUtil.getKeysym({code: 'Numpad5', key: '5', location: 3})).to.be.equal(0xFFB5);
 177             });
 178             it('should handle Numpad non-character keys', function () {
 179                 expect(KeyboardUtil.getKeysym({code: 'Home', key: 'Home', location: 0})).to.be.equal(0xFF50);
 180                 expect(KeyboardUtil.getKeysym({code: 'Numpad5', key: 'Home', location: 3})).to.be.equal(0xFF95);
 181                 expect(KeyboardUtil.getKeysym({code: 'Delete', key: 'Delete', location: 0})).to.be.equal(0xFFFF);
 182                 expect(KeyboardUtil.getKeysym({code: 'NumpadDecimal', key: 'Delete', location: 3})).to.be.equal(0xFF9F);
 183             });
 184             it('should handle Numpad Decimal key', function () {
 185                 expect(KeyboardUtil.getKeysym({code: 'NumpadDecimal', key: '.', location: 3})).to.be.equal(0xFFAE);
 186                 expect(KeyboardUtil.getKeysym({code: 'NumpadDecimal', key: ',', location: 3})).to.be.equal(0xFFAC);
 187             });
 188         });
 189     });
 190 });