modules/keymap.js

   1 /**
   2  * (C) Copyright 2004-2007 Shawn Betts
   3  * (C) Copyright 2007-2010 John J. Foerch
   4  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   5  *
   6  * Use, modification, and distribution are subject to the terms specified in the
   7  * COPYING file.
   8 **/
   9
  10 in_module(null);
  11
  12 /* Generate vk name table  */
  13 var keycode_to_vk_name = [];
  14 var vk_name_to_keycode = {};
  15 let (KeyEvent = Ci.nsIDOMKeyEvent,
  16      prefix = "DOM_VK_") {
  17     for (var i in KeyEvent) {
  18         /* Check if this is a key binding */
  19         if (i.substr(0, prefix.length) == prefix) {
  20             let name = i.substr(prefix.length).toLowerCase();
  21             let code = KeyEvent[i];
  22             keycode_to_vk_name[code] = name;
  23             vk_name_to_keycode[name] = code;
  24         }
  25     }
  26 }
  27
  28
  29 /*
  30  * Modifiers
  31  */
  32
  33 function modifier (in_event_p, set_in_event) {
  34     this.in_event_p = in_event_p;
  35     this.set_in_event = set_in_event;
  36 }
  37
  38 var modifiers = {
  39     A: new modifier(function (event) { return event.altKey; },
  40                     function (event) { event.altKey = true; }),
  41     C: new modifier(function (event) { return event.ctrlKey; },
  42                     function (event) { event.ctrlKey = true; }),
  43     M: new modifier(function (event) { return event.metaKey; },
  44                     function (event) { event.metaKey = true; }),
  45     S: new modifier(function (event) {
  46                         if (event.shiftKey) {
  47                             var name;
  48                             if (event.keyCode)
  49                                 name = keycode_to_vk_name[event.keyCode];
  50                             return ((name && name.length > 1) ||
  51                                     (event.charCode == 32) ||
  52                                     (event.button != null));
  53                         }
  54                         return false;
  55                     },
  56                     function (event) { event.shiftKey = true; })
  57 };
  58 var modifier_order = ['C', 'M', 'S'];
  59
  60 // check the platform and guess whether we should treat Alt as Meta
  61 if (get_os() == 'Darwin') {
  62     // In OS X, alt is a shift-like modifier, in that we
  63     // only care about it for non-character events.
  64     modifiers.A = new modifier(
  65         function (event) {
  66             if (event.altKey) {
  67                 var name;
  68                 if (event.keyCode)
  69                     name = keycode_to_vk_name[event.keyCode];
  70                 return ((name && name.length > 1) ||
  71                         (event.charCode == 32) ||
  72                         (event.button != null));
  73             }
  74             return false;
  75         },
  76         function (event) { event.altKey = true; });
  77     modifier_order = ['C', 'M', 'A', 'S'];
  78 } else {
  79     modifiers.M = modifiers.A;
  80 }
  81
  82
  83
  84 /*
  85  * Combos
  86  */
  87
  88 function format_key_combo (event) {
  89     var combo = '';
  90     for each (var M in modifier_order) {
  91         if (modifiers[M].in_event_p(event) ||
  92             (event.sticky_modifiers &&
  93              event.sticky_modifiers.indexOf(M) != -1))
  94         {
  95             combo += (M + '-');
  96         }
  97     }
  98     if (event.charCode) {
  99         if (event.charCode == 32)
 100             combo += 'space';
 101         else
 102             combo += String.fromCharCode(event.charCode);
 103     } else if (event.keyCode) {
 104         combo += keycode_to_vk_name[event.keyCode];
 105     } else if (event.button != null) {
 106         combo += "mouse" + (event.button + 1);
 107     }
 108     return combo;
 109 }
 110
 111 function unformat_key_combo (combo) {
 112     var event = {
 113         keyCode: 0,
 114         charCode: 0,
 115         altKey: false,
 116         ctrlKey: false,
 117         metaKey: false,
 118         shiftKey: false
 119     };
 120     var M;
 121     var i = 0;
 122     var len = combo.length - 2;
 123     var res;
 124     while (i < len && combo[i+1] == '-') {
 125         M = combo[i];
 126         modifiers[M].set_in_event(event);
 127         i+=2;
 128     }
 129     var key = combo.substring(i);
 130     if (key.length == 1)
 131         event.charCode = key.charCodeAt(0);
 132     else if (key == 'space')
 133         event.charCode = 32;
 134     else if (vk_name_to_keycode[key])
 135         event.keyCode = vk_name_to_keycode[key];
 136     else if (key.substring(0, 5) == 'mouse')
 137         event.button = parseInt(key.substring(5));
 138     return event;
 139 }
 140
 141
 142
 143 /*
 144  * Keymap datatype
 145  */
 146
 147 define_keywords("$parent", "$help", "$name", "$anonymous",
 148                 "$display_name", "$notify");
 149 function keymap () {
 150     keywords(arguments);
 151     this.parent = arguments.$parent;
 152     this.bindings = {};
 153     this.predicate_bindings = [];
 154     this.fallthrough = [];
 155     this.help = arguments.$help;
 156     this.name = arguments.$name;
 157     this.display_name = arguments.$display_name;
 158     this.notify = arguments.$notify;
 159     this.anonymous = arguments.$anonymous;
 160 }
 161
 162 function define_keymap (name) {
 163     keywords(arguments);
 164     this[name] = new keymap($name = name, forward_keywords(arguments));
 165 }
 166
 167
 168
 169 /*
 170  * Key Match Predicates.
 171  */
 172
 173 function define_key_match_predicate (name, description, predicate) {
 174     conkeror[name] = predicate;
 175     conkeror[name].name = name;
 176     conkeror[name].description = description;
 177     return conkeror[name];
 178 }
 179
 180 define_key_match_predicate('match_any_key', 'any key',
 181     function (event) true);
 182
 183 // should be renamed to match_any_unmodified_character
 184 define_key_match_predicate('match_any_unmodified_character', 'any unmodified character',
 185     function (event) {
 186         // this predicate can be used for both keypress and keydown
 187         // fallthroughs.
 188         try {
 189             return ((event.type == 'keypress' && event.charCode)
 190                     || event.keyCode > 31)
 191                 && !modifiers.A.in_event_p(event)
 192                 && !event.metaKey
 193                 && !event.ctrlKey
 194                 && !event.sticky_modifiers;
 195         } catch (e) { return false; }
 196     });
 197
 198 define_key_match_predicate('match_checkbox_keys', 'checkbox keys',
 199     function (event) {
 200         return event.keyCode == 32
 201             && !event.shiftKey
 202             && !event.metaKey
 203             && !event.altKey
 204             && !event.ctrlKey;
 205         //XXX: keycode fallthroughs don't support sticky modifiers
 206     });
 207
 208 define_key_match_predicate('match_text_keys', 'text editing keys',
 209     function (event) {
 210         return ((event.type == 'keypress' && event.charCode)
 211                 || event.keyCode == 13 || event.keyCode > 31)
 212             && !event.ctrlKey
 213             && !event.metaKey
 214             && !modifiers.A.in_event_p(event);
 215         //XXX: keycode fallthroughs don't support sticky modifiers
 216     });
 217
 218 define_key_match_predicate('match_not_escape_key', 'any key but escape',
 219     function (event) {
 220         return event.keyCode != 27 ||
 221              event.shiftKey ||
 222              event.altKey ||
 223              event.metaKey || // M-escape can also leave this mode, so we
 224                               // need to use an accurate determination of
 225                               // whether the "M" modifier was pressed,
 226                               // which is not necessarily the same as
 227                               // event.metaKey.
 228              event.ctrlKey;
 229     });
 230
 231
 232 /*
 233  */
 234
 235 function format_key_spec (key) {
 236     if (key instanceof Function) {
 237         if (key.description)
 238             return "<"+key.description+">";
 239         if (key.name)
 240             return "<"+key.name+">";
 241         return "<anonymous match function>";
 242     }
 243     return key;
 244 }
 245
 246 function format_binding_sequence (seq) {
 247     return seq.map(function (x) {
 248             return format_key_spec(x.key);
 249         }).join(" ");
 250 }
 251
 252
 253 function keymap_lookup (keymaps, combo, event) {
 254     var i = keymaps.length - 1;
 255     if (i < 0)
 256         return null;
 257     var kmap = keymaps[i];
 258     var new_kmaps;
 259     while (true) {
 260         var bindings = kmap.bindings;
 261         var bind = bindings[combo];
 262         if (new_kmaps) {
 263             if (bind) {
 264                 if (bind.keymap)
 265                     new_kmaps.unshift(bind.keymap);
 266                 else
 267                     return new_kmaps;
 268             }
 269         } else if (bind) {
 270             if (bind.keymap)
 271                 new_kmaps = [bind.keymap];
 272             else
 273                 return bind;
 274         } else {
 275             var pred_binds = kmap.predicate_bindings;
 276             for (var j = 0, pblen = pred_binds.length; j < pblen; ++j) {
 277                 bind = pred_binds[j];
 278                 if (bind.key(event))
 279                     return bind;
 280             }
 281         }
 282         if (kmap.parent)
 283             kmap = kmap.parent;
 284         else if (i > 0)
 285             kmap = keymaps[--i];
 286         else if (new_kmaps)
 287             return new_kmaps
 288         else
 289             return null;
 290     }
 291 }
 292
 293
 294 function keymap_lookup_fallthrough (keymap, event) {
 295     var predicates = keymap.fallthrough;
 296     for (var i = 0, plen = predicates.length; i < plen; ++i) {
 297         if (predicates[i](event))
 298             return true;
 299     }
 300     return false;
 301 }
 302
 303
 304 function for_each_key_binding (keymaps, callback) {
 305     var binding_sequence = [];
 306     function helper (keymap) {
 307         var binding;
 308         for each (binding in keymap.bindings) {
 309             binding_sequence.push(binding);
 310             callback(binding_sequence);
 311             if (binding.keymap)
 312                 helper(binding.keymap);
 313             binding_sequence.pop();
 314         }
 315         for each (binding in keymap.predicate_bindings) {
 316             binding_sequence.push(binding);
 317             callback(binding_sequence);
 318             if (binding.keymap)
 319                 helper(binding.keymap);
 320             binding_sequence.pop();
 321         }
 322     }
 323     //outer loop is to go down the parent-chain of keymaps
 324     var i = keymaps.length - 1;
 325     var keymap = keymaps[i];
 326     while (true) {
 327         helper(keymap);
 328         if (keymap.parent)
 329             keymap = keymap.parent;
 330         else if (i > 0)
 331             keymap = keymaps[--i];
 332         else
 333             break;
 334     }
 335 }
 336
 337
 338 function keymap_lookup_command (keymaps, command) {
 339     var list = [];
 340     for_each_key_binding(keymaps, function (bind_seq) {
 341             var bind = bind_seq[bind_seq.length - 1];
 342             if (bind.command == command)
 343                 list.push(format_binding_sequence(bind_seq));
 344         });
 345     return list;
 346 }
 347
 348
 349
 350
 351
 352
 353 /*
 354  * $fallthrough, $repeat and $browser_object are as for define_key.
 355  *
 356  * ref is the source code reference of the call to define_key.
 357  *
 358  * kmap is the keymap in which the binding is to be defined.
 359  *
 360  * seq is the key sequence being bound.  it may be necessary
 361  * to auto-generate new keymaps to accomodate the key sequence.
 362  *
 363  * only one of new_command and new_keymap will be given.
 364  * the one that is given is the thing being bound to.
 365  */
 366 define_keywords("$fallthrough", "$repeat", "$browser_object");
 367 function define_key_internal (ref, kmap, seq, new_command, new_keymap) {
 368     keywords(arguments);
 369     var args = arguments;
 370     var last_in_sequence; // flag to indicate the final key combo in the sequence.
 371     var key; // current key combo as we iterate through the sequence.
 372     var undefine_key = (new_command == null) &&
 373         (new_keymap == null) &&
 374         (! args.$fallthrough);
 375
 376     /* Replace `bind' with the binding specified by (cmd, fallthrough) */
 377     function replace_binding (bind) {
 378         if (last_in_sequence) {
 379             bind.command = new_command;
 380             bind.keymap = new_keymap;
 381             bind.fallthrough = args.$fallthrough;
 382             bind.source_code_reference = ref;
 383             bind.repeat = args.$repeat;
 384             bind.browser_object = args.$browser_object;
 385         } else {
 386             if (!bind.keymap)
 387                 throw new Error("Key sequence has a non-keymap in prefix");
 388             kmap = bind.keymap;
 389         }
 390     }
 391
 392     function make_binding () {
 393         if (last_in_sequence) {
 394             return { key: key,
 395                      fallthrough: args.$fallthrough,
 396                      command: new_command,
 397                      keymap: new_keymap,
 398                      source_code_reference: ref,
 399                      repeat: args.$repeat,
 400                      browser_object: args.$browser_object,
 401                      bound_in: kmap };
 402         } else {
 403             let old_kmap = kmap;
 404             kmap = new keymap($anonymous,
 405                               $name = old_kmap.name + " " + format_key_spec(key));
 406             kmap.bound_in = old_kmap;
 407             return { key: key,
 408                      keymap: kmap,
 409                      source_code_reference: ref,
 410                      bound_in: old_kmap };
 411         }
 412     }
 413
 414 sequence:
 415     for (var i = 0, slen = seq.length; i < slen; ++i) {
 416         key = seq[i];
 417         last_in_sequence = (i == slen - 1);
 418
 419         if (typeof key == "function") { // it's a match predicate
 420             // Check if the binding is already present in the keymap
 421             var pred_binds = kmap.predicate_bindings;
 422             for (var j = 0, pblen = pred_binds.length; j < pblen; j++) {
 423                 if (pred_binds[j].key == key) {
 424                     if (last_in_sequence && undefine_key)
 425                         pred_binds.splice(j, 1);
 426                     else
 427                         replace_binding(pred_binds[j]);
 428                     continue sequence;
 429                 }
 430             }
 431             if (! undefine_key)
 432                 pred_binds.push(make_binding());
 433         } else {
 434             // Check if the binding is already present in the keymap
 435             var bindings = kmap.bindings;
 436             var binding = bindings[key];
 437             if (binding) {
 438                 if (last_in_sequence && undefine_key)
 439                     delete bindings[key];
 440                 else
 441                     replace_binding(binding);
 442                 continue sequence;
 443             }
 444             if (! undefine_key)
 445                 bindings[key] = make_binding();
 446         }
 447     }
 448 }
 449
 450 /**
 451  * bind SEQ to a keymap or command CMD in keymap KMAP.
 452  *
 453  *   If CMD is the special value `fallthrough', it will be bound as a
 454  * fallthrough key.
 455  *
 456  * keywords:
 457  *
 458  *  $fallthrough: specifies that the keypress event will fall through
 459  *      to gecko.  Note, by this method, only keypress will fall through.
 460  *      Keyup and keydown will still be blocked.
 461  *
 462  *  $repeat: (command name) shortcut command to call if a prefix
 463  *      command key is pressed twice in a row.
 464  *
 465  *  $browser_object: (browser object) Override the default
 466  *      browser-object for the command.
 467  */
 468 define_keywords("$fallthrough", "$repeat", "$browser_object");
 469 function define_key (kmap, seq, cmd) {
 470     keywords(arguments);
 471     var orig_seq = seq;
 472     try {
 473         var ref = get_caller_source_code_reference();
 474
 475         if (typeof seq == "string" && seq.length > 1)
 476             seq = seq.split(" ");
 477
 478         if (!(typeof seq == "object") || !(seq instanceof Array))
 479             seq = [seq];
 480
 481         // normalize the order of modifiers in key combos
 482         seq = seq.map(
 483             function (k) {
 484                 if (typeof(k) == "string")
 485                     return format_key_combo(unformat_key_combo(k));
 486                 else
 487                     return k;
 488             });
 489
 490         var new_command = null;
 491         var new_keymap = null;
 492         if (typeof cmd == "string" || typeof cmd == "function")
 493             new_command = cmd;
 494         else if (cmd instanceof keymap)
 495             new_keymap = cmd;
 496         else if (cmd != null)
 497             throw new Error("Invalid `cmd' argument: " + cmd);
 498
 499         define_key_internal(ref, kmap, seq, new_command, new_keymap,
 500                             forward_keywords(arguments));
 501
 502     } catch (e if (typeof e == "string")) {
 503         dumpln("Warning: Error occurred while binding sequence: " + orig_seq);
 504         dumpln(e);
 505     }
 506 }
 507
 508
 509 function undefine_key (kmap, seq) {
 510     define_key(kmap, seq);
 511 }
 512
 513
 514 /**
 515  * define_fallthrough
 516  *
 517  *   Takes a keymap and a predicate on an event.  Fallthroughs defined by
 518  * these means will cause all three of keydown, keypress, and keyup to
 519  * fall through to gecko, whereas those defined by the $fallthrough
 520  * keyword to define_key only affect keypress events.
 521  *
 522  *   The limitations of this method are that only the keyCode is available
 523  * to the predicate, not the charCode, and keymap inheritance is not
 524  * available for these "bindings".
 525  */
 526 function define_fallthrough (keymap, predicate) {
 527     keymap.fallthrough.push(predicate);
 528 }
 529
 530
 531 /*
 532  * Minibuffer Read Key Binding
 533  */
 534
 535 define_keymap("key_binding_reader_keymap");
 536 define_key(key_binding_reader_keymap, match_any_key, "read-key-binding-key");
 537
 538 define_keywords("$keymap");
 539 function key_binding_reader (minibuffer, continuation) {
 540     keywords(arguments, $prompt = "Describe key:");
 541     minibuffer_input_state.call(this, minibuffer, key_binding_reader_keymap, arguments.$prompt);
 542     this.continuation = continuation;
 543     if (arguments.$keymap)
 544         this.target_keymap = arguments.$keymap;
 545     else
 546         this.target_keymap = get_current_keymaps(this.minibuffer.window).slice();
 547     this.key_sequence = [];
 548 }
 549 key_binding_reader.prototype = {
 550     constructor: key_binding_reader,
 551     __proto__: minibuffer_input_state.prototype,
 552     destroy: function () {
 553         if (this.continuation)
 554             this.continuation.throw(abort());
 555         minibuffer_input_state.prototype.destroy.call(this);
 556     }
 557 };
 558
 559 function invalid_key_binding (seq) {
 560     var e = new Error(seq.join(" ") + " is undefined");
 561     e.key_sequence = seq;
 562     e.__proto__ = invalid_key_binding.prototype;
 563     return e;
 564 }
 565 invalid_key_binding.prototype = {
 566     constructor: invalid_key_binding,
 567     __proto__: interactive_error.prototype
 568 };
 569
 570 function read_key_binding_key (window, state, event) {
 571     var combo = format_key_combo(event);
 572     var binding = keymap_lookup(state.target_keymap, combo, event);
 573
 574     state.key_sequence.push(combo);
 575
 576     if (binding == null) {
 577         var c = state.continuation;
 578         delete state.continuation;
 579         window.minibuffer.pop_state();
 580         c.throw(invalid_key_binding(state.key_sequence));
 581         return;
 582     }
 583
 584     if (binding.constructor == Array) { //keymaps stack
 585         window.minibuffer._restore_normal_state();
 586         window.minibuffer._input_text = state.key_sequence.join(" ") + " ";
 587         state.target_keymap = binding;
 588         return;
 589     }
 590
 591     var c = state.continuation;
 592     delete state.continuation;
 593
 594     window.minibuffer.pop_state();
 595
 596     if (c != null)
 597         c([state.key_sequence, binding]);
 598 }
 599 interactive("read-key-binding-key",
 600     "Handle a keystroke in the key binding reader minibuffer state.",
 601      function (I) {
 602          read_key_binding_key(I.window,
 603                               I.minibuffer.check_state(key_binding_reader),
 604                               I.event);
 605      });
 606
 607 minibuffer.prototype.read_key_binding = function () {
 608     keywords(arguments);
 609     var s = new key_binding_reader(this, (yield CONTINUATION), forward_keywords(arguments));
 610     this.push_state(s);
 611     var result = yield SUSPEND;
 612     yield co_return(result);
 613 };
 614
 615 provide("keymap");