browser/devtools/sourceeditor/codemirror/keymap/sublime.js

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 // A rough approximation of Sublime Text's keybindings
     2 // Depends on addon/search/searchcursor.js and optionally addon/dialog/dialogs.js
     4 (function(mod) {
     5   if (typeof exports == "object" && typeof module == "object") // CommonJS
     6     mod(require("../lib/codemirror"), require("../addon/search/searchcursor"), require("../addon/edit/matchbrackets"));
     7   else if (typeof define == "function" && define.amd) // AMD
     8     define(["../lib/codemirror", "../addon/search/searchcursor", "../addon/edit/matchbrackets"], mod);
     9   else // Plain browser env
    10     mod(CodeMirror);
    11 })(function(CodeMirror) {
    12   "use strict";
    14   var map = CodeMirror.keyMap.sublime = {fallthrough: "default"};
    15   var cmds = CodeMirror.commands;
    16   var Pos = CodeMirror.Pos;
    17   var ctrl = CodeMirror.keyMap["default"] == CodeMirror.keyMap.pcDefault ? "Ctrl-" : "Cmd-";
    19   // This is not exactly Sublime's algorithm. I couldn't make heads or tails of that.
    20   function findPosSubword(doc, start, dir) {
    21     if (dir < 0 && start.ch == 0) return doc.clipPos(Pos(start.line - 1));
    22     var line = doc.getLine(start.line);
    23     if (dir > 0 && start.ch >= line.length) return doc.clipPos(Pos(start.line + 1, 0));
    24     var state = "start", type;
    25     for (var pos = start.ch, e = dir < 0 ? 0 : line.length, i = 0; pos != e; pos += dir, i++) {
    26       var next = line.charAt(dir < 0 ? pos - 1 : pos);
    27       var cat = next != "_" && CodeMirror.isWordChar(next) ? "w" : "o";
    28       if (cat == "w" && next.toUpperCase() == next) cat = "W";
    29       if (state == "start") {
    30         if (cat != "o") { state = "in"; type = cat; }
    31       } else if (state == "in") {
    32         if (type != cat) {
    33           if (type == "w" && cat == "W" && dir < 0) pos--;
    34           if (type == "W" && cat == "w" && dir > 0) { type = "w"; continue; }
    35           break;
    36         }
    37       }
    38     }
    39     return Pos(start.line, pos);
    40   }
    42   function moveSubword(cm, dir) {
    43     cm.extendSelectionsBy(function(range) {
    44       if (cm.display.shift || cm.doc.extend || range.empty())
    45         return findPosSubword(cm.doc, range.head, dir);
    46       else
    47         return dir < 0 ? range.from() : range.to();
    48     });
    49   }
    51   cmds[map["Alt-Left"] = "goSubwordLeft"] = function(cm) { moveSubword(cm, -1); };
    52   cmds[map["Alt-Right"] = "goSubwordRight"] = function(cm) { moveSubword(cm, 1); };
    54   cmds[map[ctrl + "Up"] = "scrollLineUp"] = function(cm) {
    55     cm.scrollTo(null, cm.getScrollInfo().top - cm.defaultTextHeight());
    56   };
    57   cmds[map[ctrl + "Down"] = "scrollLineDown"] = function(cm) {
    58     cm.scrollTo(null, cm.getScrollInfo().top + cm.defaultTextHeight());
    59   };
    61   cmds[map["Shift-" + ctrl + "L"] = "splitSelectionByLine"] = function(cm) {
    62     var ranges = cm.listSelections(), lineRanges = [];
    63     for (var i = 0; i < ranges.length; i++) {
    64       var from = ranges[i].from(), to = ranges[i].to();
    65       for (var line = from.line; line <= to.line; ++line)
    66         if (!(to.line > from.line && line == to.line && to.ch == 0))
    67           lineRanges.push({anchor: line == from.line ? from : Pos(line, 0),
    68                            head: line == to.line ? to : Pos(line)});
    69     }
    70     cm.setSelections(lineRanges, 0);
    71   };
    73   map["Shift-Tab"] = "indentLess";
    75   cmds[map["Esc"] = "singleSelectionTop"] = function(cm) {
    76     var range = cm.listSelections()[0];
    77     cm.setSelection(range.anchor, range.head, {scroll: false});
    78   };
    80   cmds[map[ctrl + "L"] = "selectLine"] = function(cm) {
    81     var ranges = cm.listSelections(), extended = [];
    82     for (var i = 0; i < ranges.length; i++) {
    83       var range = ranges[i];
    84       extended.push({anchor: Pos(range.from().line, 0),
    85                      head: Pos(range.to().line + 1, 0)});
    86     }
    87     cm.setSelections(extended);
    88   };
    90   map["Shift-" + ctrl + "K"] = "deleteLine";
    92   function insertLine(cm, above) {
    93     cm.operation(function() {
    94       var len = cm.listSelections().length, newSelection = [], last = -1;
    95       for (var i = 0; i < len; i++) {
    96         var head = cm.listSelections()[i].head;
    97         if (head.line <= last) continue;
    98         var at = Pos(head.line + (above ? 0 : 1), 0);
    99         cm.replaceRange("\n", at, null, "+insertLine");
   100         cm.indentLine(at.line, null, true);
   101         newSelection.push({head: at, anchor: at});
   102         last = head.line + 1;
   103       }
   104       cm.setSelections(newSelection);
   105     });
   106   }
   108   cmds[map[ctrl + "Enter"] = "insertLineAfter"] = function(cm) { insertLine(cm, false); };
   110   cmds[map["Shift-" + ctrl + "Enter"] = "insertLineBefore"] = function(cm) { insertLine(cm, true); };
   112   function wordAt(cm, pos) {
   113     var start = pos.ch, end = start, line = cm.getLine(pos.line);
   114     while (start && CodeMirror.isWordChar(line.charAt(start - 1))) --start;
   115     while (end < line.length && CodeMirror.isWordChar(line.charAt(end))) ++end;
   116     return {from: Pos(pos.line, start), to: Pos(pos.line, end), word: line.slice(start, end)};
   117   }
   119   cmds[map[ctrl + "D"] = "selectNextOccurrence"] = function(cm) {
   120     var from = cm.getCursor("from"), to = cm.getCursor("to");
   121     var fullWord = cm.state.sublimeFindFullWord == cm.doc.sel;
   122     if (CodeMirror.cmpPos(from, to) == 0) {
   123       var word = wordAt(cm, from);
   124       if (!word.word) return;
   125       cm.setSelection(word.from, word.to);
   126       fullWord = true;
   127     } else {
   128       var text = cm.getRange(from, to);
   129       var query = fullWord ? new RegExp("\\b" + text + "\\b") : text;
   130       var cur = cm.getSearchCursor(query, to);
   131       if (cur.findNext()) {
   132         cm.addSelection(cur.from(), cur.to());
   133       } else {
   134         cur = cm.getSearchCursor(query, Pos(cm.firstLine(), 0));
   135         if (cur.findNext())
   136           cm.addSelection(cur.from(), cur.to());
   137       }
   138     }
   139     if (fullWord)
   140       cm.state.sublimeFindFullWord = cm.doc.sel;
   141   };
   143   var mirror = "(){}[]";
   144   function selectBetweenBrackets(cm) {
   145     var pos = cm.getCursor(), opening = cm.scanForBracket(pos, -1);
   146     if (!opening) return;
   147     for (;;) {
   148       var closing = cm.scanForBracket(pos, 1);
   149       if (!closing) return;
   150       if (closing.ch == mirror.charAt(mirror.indexOf(opening.ch) + 1)) {
   151         cm.setSelection(Pos(opening.pos.line, opening.pos.ch + 1), closing.pos, false);
   152         return true;
   153       }
   154       pos = Pos(closing.pos.line, closing.pos.ch + 1);
   155     }
   156   }
   158   cmds[map["Shift-" + ctrl + "Space"] = "selectScope"] = function(cm) {
   159     selectBetweenBrackets(cm) || cm.execCommand("selectAll");
   160   };
   161   cmds[map["Shift-" + ctrl + "M"] = "selectBetweenBrackets"] = function(cm) {
   162     if (!selectBetweenBrackets(cm)) return CodeMirror.Pass;
   163   };
   165   cmds[map[ctrl + "M"] = "goToBracket"] = function(cm) {
   166     cm.extendSelectionsBy(function(range) {
   167       var next = cm.scanForBracket(range.head, 1);
   168       if (next && CodeMirror.cmpPos(next.pos, range.head) != 0) return next.pos;
   169       var prev = cm.scanForBracket(range.head, -1);
   170       return prev && Pos(prev.pos.line, prev.pos.ch + 1) || range.head;
   171     });
   172   };
   174   cmds[map["Shift-" + ctrl + "Up"] = "swapLineUp"] = function(cm) {
   175     var ranges = cm.listSelections(), linesToMove = [], at = cm.firstLine() - 1;
   176     for (var i = 0; i < ranges.length; i++) {
   177       var range = ranges[i], from = range.from().line - 1, to = range.to().line;
   178       if (from > at) linesToMove.push(from, to);
   179       else if (linesToMove.length) linesToMove[linesToMove.length - 1] = to;
   180       at = to;
   181     }
   182     cm.operation(function() {
   183       for (var i = 0; i < linesToMove.length; i += 2) {
   184         var from = linesToMove[i], to = linesToMove[i + 1];
   185         var line = cm.getLine(from);
   186         cm.replaceRange("", Pos(from, 0), Pos(from + 1, 0), "+swapLine");
   187         if (to > cm.lastLine()) {
   188           cm.replaceRange("\n" + line, Pos(cm.lastLine()), null, "+swapLine");
   189           var sels = cm.listSelections(), last = sels[sels.length - 1];
   190           var head = last.head.line == to ? Pos(to - 1) : last.head;
   191           var anchor = last.anchor.line == to ? Pos(to - 1) : last.anchor;
   192           cm.setSelections(sels.slice(0, sels.length - 1).concat([{head: head, anchor: anchor}]));
   193         } else {
   194           cm.replaceRange(line + "\n", Pos(to, 0), null, "+swapLine");
   195         }
   196       }
   197       cm.scrollIntoView();
   198     });
   199   };
   201   cmds[map["Shift-" + ctrl + "Down"] = "swapLineDown"] = function(cm) {
   202     var ranges = cm.listSelections(), linesToMove = [], at = cm.lastLine() + 1;
   203     for (var i = ranges.length - 1; i >= 0; i--) {
   204       var range = ranges[i], from = range.to().line + 1, to = range.from().line;
   205       if (from < at) linesToMove.push(from, to);
   206       else if (linesToMove.length) linesToMove[linesToMove.length - 1] = to;
   207       at = to;
   208     }
   209     cm.operation(function() {
   210       for (var i = linesToMove.length - 2; i >= 0; i -= 2) {
   211         var from = linesToMove[i], to = linesToMove[i + 1];
   212         var line = cm.getLine(from);
   213         if (from == cm.lastLine())
   214           cm.replaceRange("", Pos(from - 1), Pos(from), "+swapLine");
   215         else
   216           cm.replaceRange("", Pos(from, 0), Pos(from + 1, 0), "+swapLine");
   217         cm.replaceRange(line + "\n", Pos(to, 0), null, "+swapLine");
   218       }
   219       cm.scrollIntoView();
   220     });
   221   };
   223   map[ctrl + "/"] = "toggleComment";
   225   cmds[map[ctrl + "J"] = "joinLines"] = function(cm) {
   226     var ranges = cm.listSelections(), joined = [];
   227     for (var i = 0; i < ranges.length; i++) {
   228       var range = ranges[i], from = range.from();
   229       var start = from.line, end = range.to().line;
   230       while (i < ranges.length - 1 && ranges[i + 1].from().line == end)
   231         end = ranges[++i].to().line;
   232       joined.push({start: start, end: end, anchor: !range.empty() && from});
   233     }
   234     cm.operation(function() {
   235       var offset = 0, ranges = [];
   236       for (var i = 0; i < joined.length; i++) {
   237         var obj = joined[i];
   238         var anchor = obj.anchor && Pos(obj.anchor.line - offset, obj.anchor.ch), head;
   239         for (var line = obj.start; line <= obj.end; line++) {
   240           var actual = line - offset;
   241           if (line == obj.end) head = Pos(actual, cm.getLine(actual).length + 1);
   242           if (actual < cm.lastLine()) {
   243             cm.replaceRange(" ", Pos(actual), Pos(actual + 1, /^\s*/.exec(cm.getLine(actual + 1))[0].length));
   244             ++offset;
   245           }
   246         }
   247         ranges.push({anchor: anchor || head, head: head});
   248       }
   249       cm.setSelections(ranges, 0);
   250     });
   251   };
   253   cmds[map["Shift-" + ctrl + "D"] = "duplicateLine"] = function(cm) {
   254     cm.operation(function() {
   255       var rangeCount = cm.listSelections().length;
   256       for (var i = 0; i < rangeCount; i++) {
   257         var range = cm.listSelections()[i];
   258         if (range.empty())
   259           cm.replaceRange(cm.getLine(range.head.line) + "\n", Pos(range.head.line, 0));
   260         else
   261           cm.replaceRange(cm.getRange(range.from(), range.to()), range.from());
   262       }
   263       cm.scrollIntoView();
   264     });
   265   };
   267   map[ctrl + "T"] = "transposeChars";
   269   function sortLines(cm, caseSensitive) {
   270     var ranges = cm.listSelections(), toSort = [], selected;
   271     for (var i = 0; i < ranges.length; i++) {
   272       var range = ranges[i];
   273       if (range.empty()) continue;
   274       var from = range.from().line, to = range.to().line;
   275       while (i < ranges.length - 1 && ranges[i + 1].from().line == to)
   276         to = range[++i].to().line;
   277       toSort.push(from, to);
   278     }
   279     if (toSort.length) selected = true;
   280     else toSort.push(cm.firstLine(), cm.lastLine());
   282     cm.operation(function() {
   283       var ranges = [];
   284       for (var i = 0; i < toSort.length; i += 2) {
   285         var from = toSort[i], to = toSort[i + 1];
   286         var start = Pos(from, 0), end = Pos(to);
   287         var lines = cm.getRange(start, end, false);
   288         if (caseSensitive)
   289           lines.sort();
   290         else
   291           lines.sort(function(a, b) {
   292             var au = a.toUpperCase(), bu = b.toUpperCase();
   293             if (au != bu) { a = au; b = bu; }
   294             return a < b ? -1 : a == b ? 0 : 1;
   295           });
   296         cm.replaceRange(lines, start, end);
   297         if (selected) ranges.push({anchor: start, head: end});
   298       }
   299       if (selected) cm.setSelections(ranges, 0);
   300     });
   301   }
   303   cmds[map["F9"] = "sortLines"] = function(cm) { sortLines(cm, true); };
   304   cmds[map[ctrl + "F9"] = "sortLinesInsensitive"] = function(cm) { sortLines(cm, false); };
   306   cmds[map["F2"] = "nextBookmark"] = function(cm) {
   307     var marks = cm.state.sublimeBookmarks;
   308     if (marks) while (marks.length) {
   309       var current = marks.shift();
   310       var found = current.find();
   311       if (found) {
   312         marks.push(current);
   313         return cm.setSelection(found.from, found.to);
   314       }
   315     }
   316   };
   318   cmds[map["Shift-F2"] = "prevBookmark"] = function(cm) {
   319     var marks = cm.state.sublimeBookmarks;
   320     if (marks) while (marks.length) {
   321       marks.unshift(marks.pop());
   322       var found = marks[marks.length - 1].find();
   323       if (!found)
   324         marks.pop();
   325       else
   326         return cm.setSelection(found.from, found.to);
   327     }
   328   };
   330   cmds[map[ctrl + "F2"] = "toggleBookmark"] = function(cm) {
   331     var ranges = cm.listSelections();
   332     var marks = cm.state.sublimeBookmarks || (cm.state.sublimeBookmarks = []);
   333     for (var i = 0; i < ranges.length; i++) {
   334       var from = ranges[i].from(), to = ranges[i].to();
   335       var found = cm.findMarks(from, to);
   336       for (var j = 0; j < found.length; j++) {
   337         if (found[j].sublimeBookmark) {
   338           found[j].clear();
   339           for (var k = 0; k < marks.length; k++)
   340             if (marks[k] == found[j])
   341               marks.splice(k--, 1);
   342           break;
   343         }
   344       }
   345       if (j == found.length)
   346         marks.push(cm.markText(from, to, {sublimeBookmark: true, clearWhenEmpty: false}));
   347     }
   348   };
   350   cmds[map["Shift-" + ctrl + "F2"] = "clearBookmarks"] = function(cm) {
   351     var marks = cm.state.sublimeBookmarks;
   352     if (marks) for (var i = 0; i < marks.length; i++) marks[i].clear();
   353     marks.length = 0;
   354   };
   356   cmds[map["Alt-F2"] = "selectBookmarks"] = function(cm) {
   357     var marks = cm.state.sublimeBookmarks, ranges = [];
   358     if (marks) for (var i = 0; i < marks.length; i++) {
   359       var found = marks[i].find();
   360       if (!found)
   361         marks.splice(i--, 0);
   362       else
   363         ranges.push({anchor: found.from, head: found.to});
   364     }
   365     if (ranges.length)
   366       cm.setSelections(ranges, 0);
   367   };
   369   map["Alt-Q"] = "wrapLines";
   371   var mapK = CodeMirror.keyMap["sublime-Ctrl-K"] = {auto: "sublime", nofallthrough: true};
   373   map[ctrl + "K"] = function(cm) {cm.setOption("keyMap", "sublime-Ctrl-K");};
   375   function modifyWordOrSelection(cm, mod) {
   376     cm.operation(function() {
   377       var ranges = cm.listSelections(), indices = [], replacements = [];
   378       for (var i = 0; i < ranges.length; i++) {
   379         var range = ranges[i];
   380         if (range.empty()) { indices.push(i); replacements.push(""); }
   381         else replacements.push(mod(cm.getRange(range.from(), range.to())));
   382       }
   383       cm.replaceSelections(replacements, "around", "case");
   384       for (var i = indices.length - 1, at; i >= 0; i--) {
   385         var range = ranges[indices[i]];
   386         if (at && CodeMirror.cmpPos(range.head, at) > 0) continue;
   387         var word = wordAt(cm, range.head);
   388         at = word.from;
   389         cm.replaceRange(mod(word.word), word.from, word.to);
   390       }
   391     });
   392   }
   394   mapK[ctrl + "Backspace"] = "delLineLeft";
   396   cmds[mapK[ctrl + "K"] = "delLineRight"] = function(cm) {
   397     cm.operation(function() {
   398       var ranges = cm.listSelections();
   399       for (var i = ranges.length - 1; i >= 0; i--)
   400         cm.replaceRange("", ranges[i].anchor, Pos(ranges[i].to().line), "+delete");
   401       cm.scrollIntoView();
   402     });
   403   };
   405   cmds[mapK[ctrl + "U"] = "upcaseAtCursor"] = function(cm) {
   406     modifyWordOrSelection(cm, function(str) { return str.toUpperCase(); });
   407   };
   408   cmds[mapK[ctrl + "L"] = "downcaseAtCursor"] = function(cm) {
   409     modifyWordOrSelection(cm, function(str) { return str.toLowerCase(); });
   410   };
   412   cmds[mapK[ctrl + "Space"] = "setSublimeMark"] = function(cm) {
   413     if (cm.state.sublimeMark) cm.state.sublimeMark.clear();
   414     cm.state.sublimeMark = cm.setBookmark(cm.getCursor());
   415   };
   416   cmds[mapK[ctrl + "A"] = "selectToSublimeMark"] = function(cm) {
   417     var found = cm.state.sublimeMark && cm.state.sublimeMark.find();
   418     if (found) cm.setSelection(cm.getCursor(), found);
   419   };
   420   cmds[mapK[ctrl + "W"] = "deleteToSublimeMark"] = function(cm) {
   421     var found = cm.state.sublimeMark && cm.state.sublimeMark.find();
   422     if (found) {
   423       var from = cm.getCursor(), to = found;
   424       if (CodeMirror.cmpPos(from, to) > 0) { var tmp = to; to = from; from = tmp; }
   425       cm.state.sublimeKilled = cm.getRange(from, to);
   426       cm.replaceRange("", from, to);
   427     }
   428   };
   429   cmds[mapK[ctrl + "X"] = "swapWithSublimeMark"] = function(cm) {
   430     var found = cm.state.sublimeMark && cm.state.sublimeMark.find();
   431     if (found) {
   432       cm.state.sublimeMark.clear();
   433       cm.state.sublimeMark = cm.setBookmark(cm.getCursor());
   434       cm.setCursor(found);
   435     }
   436   };
   437   cmds[mapK[ctrl + "Y"] = "sublimeYank"] = function(cm) {
   438     if (cm.state.sublimeKilled != null)
   439       cm.replaceSelection(cm.state.sublimeKilled, null, "paste");
   440   };
   442   mapK[ctrl + "G"] = "clearBookmarks";
   443   cmds[mapK[ctrl + "C"] = "showInCenter"] = function(cm) {
   444     var pos = cm.cursorCoords(null, "local");
   445     cm.scrollTo(null, (pos.top + pos.bottom) / 2 - cm.getScrollInfo().clientHeight / 2);
   446   };
   448   cmds[map["Shift-Alt-Up"] = "selectLinesUpward"] = function(cm) {
   449     cm.operation(function() {
   450       var ranges = cm.listSelections();
   451       for (var i = 0; i < ranges.length; i++) {
   452         var range = ranges[i];
   453         if (range.head.line > cm.firstLine())
   454           cm.addSelection(Pos(range.head.line - 1, range.head.ch));
   455       }
   456     });
   457   };
   458   cmds[map["Shift-Alt-Down"] = "selectLinesDownward"] = function(cm) {
   459     cm.operation(function() {
   460       var ranges = cm.listSelections();
   461       for (var i = 0; i < ranges.length; i++) {
   462         var range = ranges[i];
   463         if (range.head.line < cm.lastLine())
   464           cm.addSelection(Pos(range.head.line + 1, range.head.ch));
   465       }
   466     });
   467   };
   469   function findAndGoTo(cm, forward) {
   470     var from = cm.getCursor("from"), to = cm.getCursor("to");
   471     if (CodeMirror.cmpPos(from, to) == 0) {
   472       var word = wordAt(cm, from);
   473       if (!word.word) return;
   474       from = word.from;
   475       to = word.to;
   476     }
   478     var query = cm.getRange(from, to);
   479     var cur = cm.getSearchCursor(query, forward ? to : from);
   481     if (forward ? cur.findNext() : cur.findPrevious()) {
   482       cm.setSelection(cur.from(), cur.to());
   483     } else {
   484       cur = cm.getSearchCursor(query, forward ? Pos(cm.firstLine(), 0)
   485                                               : cm.clipPos(Pos(cm.lastLine())));
   486       if (forward ? cur.findNext() : cur.findPrevious())
   487         cm.setSelection(cur.from(), cur.to());
   488       else if (word)
   489         cm.setSelection(from, to);
   490     }
   491   };
   492   cmds[map[ctrl + "F3"] = "findUnder"] = function(cm) { findAndGoTo(cm, true); };
   493   cmds[map["Shift-" + ctrl + "F3"] = "findUnderPrevious"] = function(cm) { findAndGoTo(cm,false); };
   495   map["Shift-" + ctrl + "["] = "fold";
   496   map["Shift-" + ctrl + "]"] = "unfold";
   497   mapK[ctrl + "0"] = mapK[ctrl + "j"] = "unfoldAll";
   499   map[ctrl + "I"] = "findIncremental";
   500   map["Shift-" + ctrl + "I"] = "findIncrementalReverse";
   501   map[ctrl + "H"] = "replace";
   502   map["F3"] = "findNext";
   503   map["Shift-F3"] = "findPrev";
   505 });

mercurial