add support for TextMate snippets

This commit is contained in:
nightwing 2013-01-06 17:46:04 +04:00
commit b8eb5a1fec
5 changed files with 653 additions and 1 deletions

View file

@ -444,5 +444,30 @@ event.addListener(container, "drop", function(e) {
var StatusBar = require("./statusbar").StatusBar;
new StatusBar(env.editor, cmdLine.container);
require("ace/placeholder").PlaceHolder;
var SnippetManager = require("ace/snippets").SnippetManager
var jsSnippets = require("ace/requirejs/text!./snippets/js.json")
var testSnippet = "\
\\begin{${1:document}}\n\
${2:$TM_SELECTED_TEXT:some ${3:latex}}\n\
${3:$TM_SELECTED_TEXT/a/b/c}\n\
${4:${TM_SELECTED_TEXT/(.)/\\u$1/c:7}}\n\
\\end{$1}\n\
$0";
SnippetManager.register({
content: testSnippet,
tabTrigger: "t",
name: "testSnippet"
})
SnippetManager.register(JSON.parse(jsSnippets).snippets)
ace.commands.bindKey("Tab", function(editor) {
var success = SnippetManager.expandWithTab(editor);
if (!success)
editor.execCommand("indent");
})
});

View file

@ -0,0 +1,72 @@
{"snippets":[{
"content": "var ${1:class} = function(${20}) {\n\t$40$0\n};\n\n(function() {\n\t${60:this.prop = \"\"}\n}).call(${1:class}.prototype);",
"name": "class",
"scope": "js",
"tabTrigger": "class"
}, {
"content": "for (var ${20:i} = ${1:Things}.length; ${20:i} --; ) {\n\t${100:${1:Things}[${20:i}]}$0\n};",
"name": "backwards for loop",
"scope": "js",
"tabTrigger": "for-"
}, {
"content": "for (var ${20:i} = ${1:Things}.length - 1; ${20:i} >= 0; ${20:i}--) {\n\t${100:${1:Things}[${20:i}]}$0\n};",
"name": "for (…) {…} (Improved Native For-Loop)",
"scope": "js",
"tabTrigger": "for"
}, {
"content": "for (var ${20:i}=0; ${20:i} < ${1:Things}.length; ${20:i}++) {\n\t${100:${1:Things}[${20:i}]}$0\n};",
"name": "for (…) {…}",
"scope": "js",
"tabTrigger": "for"
}, {
"content":"function ${1:function_name} (${2:argument}) {\n\t${0:// body...}\n}",
"name": "Function",
"scope": "js",
"tabTrigger": "fun"
}, {
"content": "function($1) {${0:$TM_SELECTED_TEXT}};",
"name": "Anonymous Function",
"scope": "js",
"tabTrigger": "f"
}, {
"content": "getElement${1/(T)|.*/(?1:s)/}By${1:T}${1/(T)|(I)|.*/(?1:agName)(?2:d)/}('$2')",
"name": "Get Elements",
"scope": "js",
"tabTrigger": "get"
}, {
"content": "if (${1:true}) {\n\t${0:$TM_SELECTED_TEXT}\n} else {\n\t\n}",
"name": "if … else",
"scope": "js",
"tabTrigger": "ife"
}, {
"content": "if (${1:true}) {${0:$TM_SELECTED_TEXT}}",
"name": "if",
"scope": "js",
"tabTrigger": "if"
}, {
"content": "'${1:${2:#thing}:${3:click}}': function(element){\n\t$0\n}${10:,}",
"name": "Object Method String",
"scope": "js",
"tabTrigger": "'':f"
}, {
"content": "${1:method_name}: function(${3:attribute}){\n\t$0\n}${10:,}",
"name": "Object Method",
"scope": "js",
"tabTrigger": ":f"
}, {
"content": "${1:value_name}:${0:value},",
"name": "Object Value JS",
"scope": "js",
"tabTrigger": ":,"
}, {
"content": "${1:class_name}.prototype.${2:method_name} = function(${3:first_argument}) {\n\t${0:// body...}\n};\n",
"name": "Prototype",
"scope": "js",
"tabTrigger": "proto"
}, {
"content": "setTimeout(function() {$0}${2:}, ${1:10});",
"name": "setTimeout function",
"scope": "js",
"tabTrigger": "timeout"
}]
}

View file

@ -161,7 +161,7 @@ var Editor = function(renderer, session) {
this.session.removeEventListener("changeAnnotation", this.$onChangeAnnotation);
this.session.removeEventListener("changeOverwrite", this.$onCursorChange);
this.session.removeEventListener("changeScrollTop", this.$onScrollTopChange);
this.session.removeEventListener("changeLeftTop", this.$onScrollLeftChange);
this.session.removeEventListener("changeScrollLeft", this.$onScrollLeftChange);
var selection = this.session.getSelection();
selection.removeEventListener("changeCursor", this.$onCursorChange);

488
lib/ace/snippets.js Normal file
View file

@ -0,0 +1,488 @@
/* ***** BEGIN LICENSE BLOCK *****
* Distributed under the BSD license:
*
* Copyright (c) 2010, Ajax.org B.V.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Ajax.org B.V. nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ***** END LICENSE BLOCK ***** */
define(function(require, exports, module) {
"use strict";
var Range = require("ace/range").Range
var HashHandler = require("ace/keyboard/hash_handler").HashHandler;
var RangeList = require("ace/range_list").RangeList;
var SnippetManager = function() {
this.snippets = [];
};
(function() {
this.tokenizeTmSnippet = function(str) {
var stringBuilder = [];
var addText = function(str) {
str && stringBuilder.push(str);
};
var addVar = function(text, placeholder) {
if (/^\d+$/.test(text))
placeholder.tabstopId = parseInt(text, 10);
else
placeholder.text = text;
addText(placeholder);
return placeholder;
};
str = str.replace(/\r/g, "");
var stack = [], index = 0, m;
// m[1] = \\([\$}`\\]) escapes
// m[2] = }
// m[3] = \$(\w+) variables or tabstops
// m[4] = \$\{([\dA-Z_]+)
// m[5] = format string
var re = /\\([\$}`\\])|(})|\n|\$(\w+)|\$\{([\dA-Z_]+)((?:\/(?:\\.|[^\/])+?){2}\/\w*)?(:?)/g;
while (m = re.exec(str)) {
addText(str.substring(index, m.index)); // skipped text
index = m.index + m[0].length;
if (m[1]) { // escape
addText(m[1] == "}" && !stack.length ? m[0] : m[1]);
} else if (m[3]) { // variable
addVar(m[3], {});
} else if (m[4]) { // variable
var placeholder = {fmt: m[5]};
addVar(m[4], placeholder);
if (stack[0])
stack[0].child = placeholder;
stack.unshift(placeholder);
} else if (m[2] && stack.length) {
addText(stack.shift());
} else {
addText(m[0]);
}
}
addText(str.substring(index));
return stringBuilder;
};
this.$getDefaultValue = function(editor, name) {
name = name.replace(/^TM_/, "");
var s = editor.session;
switch(name) {
case "CURRENT_WORD":
var r = s.getWordRange();
case "SELECTION":
case "SELECTED_TEXT":
return s.getTextRange(r);
case "CURRENT_LINE":
return s.getLine(e.getCursorPosition().row);
case "LINE_INDEX":
return e.getCursorPosition().column;
case "LINE_NUMBER":
return e.getCursorPosition().row + 1;
case "SOFT_TABS":
return s.getUseSoftTabs() ? "YES" : "NO";
case "TAB_SIZE":
return s.getTabSize();
// defult but can't fill :(
case "FILENAME":
case "FILEPATH":
return "ace.ajax.org";
case "FULLNAME":
return "Ace";
}
};
this.variables = {};
this.getVariableValue = function(editor, varName) {
if (this.variables.hasOwnProperty(varName))
return this.variables[varName](editor, varName);
return this.$getDefaultValue(editor, varName);
};
//
// TODO: support \U \L \E
this.tmStrFormat = function(str, fmt) {
fmt = fmt.split("/");
fmt.shift();
if (fmt.length < 3)
return str;
var flags = fmt.pop().replace(/[^gmi]/g, "");
var search = fmt.shift();
while (search[search.length - 1] == "\\")
search += "/" + fmt.shift();
fmt = fmt.join("/");
var re = new RegExp(search, flags);
return str.replace(re, function() {
var matches = arguments;
var result = fmt.replace(/(\\[ul])?\$(\d)/g, function(_, flag, index) {
var $ = matches[index] || "";
if (flag == "\\u") {
$ = $[0].toUpperCase() + $.substr(1);
} else if (flag == "\\l") {
$ = $[0].toLowerCase() + $.substr(1);
}
return $;
});
return result;
});
};
this.resolveVariables = function(snippet, editor) {
var result = [];
for (var i = 0; i < snippet.length; i++) {
var ch = snippet[i]
if (typeof ch == "string") {
result.push(ch);
} else if (typeof ch == "object" && !ch.processed) {
if (ch.text) {
var value = this.getVariableValue(editor, ch.text);
if (value) {
var i1 = snippet.indexOf(ch, i + 1);
if (i1 != -1)
i = i1;
if (ch.fmt)
value = this.tmStrFormat(value, ch.fmt);
result.push(value);
} else {
ch.processed = true;
}
} else if (ch.tabstopId != null) {
result.push(ch);
}
}
}
return result;
};
this.insertSnippet = function(editor, snippetText) {
var cursor = editor.getCursorPosition();
var line = editor.session.getLine(cursor.row);
var indentString = line.match(/^\s*/)[0];
var tabString = editor.session.getTabString();
var tokens = this.tokenizeTmSnippet(snippetText);
tokens = this.resolveVariables(tokens, editor);
// indent
tokens = tokens.map(function(x) {
if (x == "\n")
return x + indentString;
if (typeof x == "string")
return x.replace(/\t/g, tabString);
return x;
});
// tabstop values
var tabstops = [];
tokens.forEach(function(p, i) {
if (typeof p != "object")
return;
var id = p.tabstopId;
if (!tabstops[id]) {
tabstops[id] = [];
tabstops[id].index = id;
tabstops[id].value = "";
}
if (tabstops[id].indexOf(p) != -1)
return;
tabstops[id].push(p);
var i1 = tokens.indexOf(p, i + 1);
if (i1 == -1)
return;
var value = tokens.slice(i + 1, i1).join("");
if (value)
tabstops[id].value = value;
});
tabstops.forEach(function(ts) {
if (ts.value) {
ts.forEach(function(p) {
var i = tokens.indexOf(p);
var i1 = tokens.indexOf(p, i + 1);
if (i1 == -1)
tokens.splice(i + 1, 0, ts.value, p);
else if (i1 == i + 1)
tokens.splice(i + 1, 0, ts.value);
});
}
});
// convert to plain text
var row = 0, column = 0;
var text = "";
tokens.forEach(function(t) {
if (typeof t == "string") {
if (t[0] == "\n"){
column = t.length - 1;
row ++;
} else
column += t.length;
text += t;
} else {
if (!t.start)
t.start = {row: row, column: column};
else
t.end = {row: row, column: column};
}
});
var range = editor.getSelectionRange();
var end = editor.session.replace(range, text);
var tabstopManager = new TabstopManager(editor);
tabstopManager.addTabstops(tabstops, range.start, end);
tabstopManager.tabNext();
};
this.expandWithTab = function(editor) {
var cursor = editor.getCursorPosition();
var line = editor.session.getLine(cursor.row);
var before = line.substring(0, cursor.column);
var s = this.snippets;
for (var i = this.snippets.length; i--;) {
var tabTrigger = this.snippets[i].tabTrigger;
if (tabTrigger && before.slice(-tabTrigger.length) == tabTrigger) {
var match = this.snippets[i];
break;
}
}
if (match) {
ace.session.doc.removeInLine(cursor.row, cursor.column - tabTrigger.length, cursor.column);
this.insertSnippet(editor, match.content);
return true;
}
};
this.register = function(snippets) {
if (snippets.content) {
this.snippets.push(snippets)
} else {
this.snippets.push.apply(this.snippets, snippets)
}
};
this.parseSnippetFile = function(str) {
var snippets = []
var re = /(?:# (.*)\n)?snippet (.*)\n((?:\n?\t.*)+)/g
while(m = re.exec(str)){
snippets.push({
name: m[1],
tabTrigger:m[2],
content:m[3].replace(/^\t/gm, "")
});
}
return snippets;
};
}).call(SnippetManager.prototype);
var TabstopManager = function(editor) {
if (editor.tabstopManager)
return editor.tabstopManager;
editor.tabstopManager = this;
this.$onChange = this.onChange.bind(this);
this.$onChangeSelection = this.onChangeSelection.bind(this);
this.$onChangeSession = this.onChangeSession.bind(this);
this.attach(editor);
};
(function() {
this.attach = function(editor) {
this.index = -1;
this.ranges = [];
this.tabstops = [];
this.editor = editor;
this.editor.on("change", this.$onChange);
this.editor.on("changeSelection", this.$onChangeSelection);
this.editor.on("changeSession", this.$onChangeSession);
this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler);
};
this.detach = function() {
this.tabstops.forEach(this.removeTabstopMarkers, this);
this.ranges = null;
this.tabstops = null;
this.editor.removeListener("change", this.$onChange);
this.editor.removeListener("changeSelection", this.$onChangeSelection);
this.editor.removeListener("changeSession", this.$onChangeSession);
this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler);
this.editor.tabstopManager = null;
this.editor = null;
};
this.onChange = function(e) {
var changeRange = e.data.range;
if (e.data.action[0] == "i"){
var start = changeRange.start;
var end = changeRange.end;
} else {
var end = changeRange.start;
var start = changeRange.end;
}
var startRow = start.row;
var endRow = end.row;
var lineDif = endRow - startRow;
var colDiff = end.column - start.column;
var ranges = this.ranges;
for (var i = 0, n = ranges.length; i < n; i++) {
var r = ranges[i];
if (r.end.row < startRow)
continue;
if (r.start.row == startRow && r.start.column > start.column) {
r.start.column += colDiff;
}
if (r.end.row == startRow && r.end.column >= start.column) {
r.end.column += colDiff;
}
if (r.start.row >= startRow) {
r.start.row += lineDif;
}
if (r.end.row >= startRow) {
r.end.row += lineDif;
}
}
};
this.onChangeSelection = function() {
setTimeout(function() {
if (!this.editor)
return
var lead = this.editor.selection.lead;
var row = lead.row, column = lead.column;
for (var i = this.ranges.length; i--;) {
if (this.ranges[i].contains(row, column))
return;
}
this.detach();
}.bind(this));
};
this.onChangeSession = function() {
this.detach();
};
this.tabNext = function(dir) {
var max = this.tabstops.length - 1;
var index = this.index + (dir || 1);
index = Math.min(Math.max(index, 0), max);
this.selectTabstop(index);
if (index == max)
this.detach();
};
this.selectTabstop = function(index) {
var ts = this.tabstops[this.index];
if (ts)
this.addTabstopMarkers(ts);
this.index = index;
ts = this.tabstops[this.index];
if (!ts)
return;
// this.removeTabstopMarkers(ts);
var sel = this.editor.multiSelect;
sel.toSingleRange(ts[0].range.clone());
for (var i = ts.length; i--; )
sel.addRange(ts[i].range.clone(), true);
this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler);
};
this.addTabstops = function(tabstops, start, end) {
// add final tabstop if missing
if (!tabstops[0]) {
var p = Range.fromPoints(end, end);
moveRelative(p.start, start);
moveRelative(p.end, start);
this.tabstops[0] = [p];
this.tabstops[0].index = 0;
}
var i = this.index;
var arg = [i, 0];
var ranges = this.ranges;
var editor = this.editor;
tabstops.forEach(function(ts) {
ts.forEach(function(p) {
var range = Range.fromPoints(p.start, p.end || p.start);
movePoint(range.start, start);
movePoint(range.end, start);
p.range = range;
ranges.push(range);
});
arg.push(ts);
this.addTabstopMarkers(ts);
}, this);
// tabstop 0 is the last one
arg.push(arg.splice(2, 1)[0]);
this.tabstops.splice.apply(this.tabstops, arg);
};
this.addTabstopMarkers = function(ts) {
var session = this.editor.session;
ts.forEach(function(p) {
if (!p.markerId)
p.markerId = session.addMarker(p.range, "ace_snippet-marker", "text");
});
};
this.removeTabstopMarkers = function(ts) {
var session = this.editor.session;
ts.forEach(function(p) {
session.removeMarker(p.markerId);
p.markerId = null
});
};
this.keyboardHandler = new HashHandler();
this.keyboardHandler.bindKeys({
"Tab": function(ed) {
ed.tabstopManager.tabNext(1);
},
"Shift-Tab": function(ed) {
ed.tabstopManager.tabNext(-1);
},
"Esc": function(ed) {
ed.tabstopManager.detach();
}
});
}).call(TabstopManager.prototype);
var movePoint = function(point, diff) {
if (point.row == 0)
point.column += diff.column;
point.row += diff.row;
};
var moveRelative = function(point, start) {
if (point.row == start.row)
point.column -= start.column;
point.row -= start.row;
};
require("ace/lib/dom").importCssString("\
.ace_snippet-marker {\
-moz-box-sizing: border-box;\
box-sizing: border-box;\
background: rgba(194, 193, 208, 0.09);\
border: 1px dotted rgba(119, 116, 139, 0.5);\
position: absolute;\
}");
exports.SnippetManager = new SnippetManager();
});

67
tool/tmsnippets.js Normal file
View file

@ -0,0 +1,67 @@
var fs = require('fs')
var plist = require('plist')
var snippets = [];
var path = process.argv[2] || process.cwd();
function readSnippet(path, name) {
if (name)
path += name
if (!/\.tmSnippet$/i.test(path))
return
console.log(name)
var plistString = fs.readFileSync(path, "utf8");
plist.parseString(plistString, function(_, plist){
snippets.push(plist)
})
}
// read
if (fs.statSync(path).isDirectory()) {
path += "/"
fs.readdirSync(path).forEach(function(name) {
readSnippet(path, name)
})
} else {
readSnippet(path)
}
// transform
snippets = snippets.map(function(s) {
if (s.length == 1)
s = s[0]
if (s.scope)
s.scope = s.scope.replace(/source\./g, "")
delete s.uuid
return s
})
// stringify
var indent = ""
var text = JSON.stringify(snippets, null, 1)
// .replace(/(\n\s*)"(\w+)"\:/g, "$1$2:")
.replace(/(\n\s*)\},\n\s*{/g, "$1}, {")
.replace(/\[\n\s*\{\n/g, "[{\n").replace(/(\n\s*)\}\n\s*\]/g, "$1}]")
.replace(/\[\n\s*[^\[\{\}\]]{0,100}\]/g, function(x){return x.replace(/\n\s*/g, " ")})
.replace(/\:\s*\{\n\s*(.*)\n\s*\}/g, ": {$1}")
.split(/\n\s*/).map(function(x){
if (x[0] == "}" || x[0] == "]")
indent = indent.substr(1)
if (x.slice(-1) == "{" || x.slice(-1) == "[") {
indent += "\t"
return indent.substr(1) + x
}
return indent +x
}).join("\n")
.replace(/\\[\\tnr]/g, function(a){
if (a[1] == "\\")
return a
else if (a[1] == "t")
return "\t"
else
return "\\n"+"\\" + "\n"
})
fs.writeFileSync(path += "./ace.snippets.js", text)
console.log(path)