Enable (optional) auto-pairing for latex mode

This commit is contained in:
Shane Kilkelly 2017-07-06 11:06:51 +01:00
parent b73b78e570
commit 34b2012727
7 changed files with 329 additions and 4 deletions

View file

@ -275,6 +275,7 @@ module.exports = ProjectController =
theme : user.ace.theme theme : user.ace.theme
fontSize : user.ace.fontSize fontSize : user.ace.fontSize
autoComplete: user.ace.autoComplete autoComplete: user.ace.autoComplete
autoPairDelimiters: user.ace.autoPairDelimiters
pdfViewer : user.ace.pdfViewer pdfViewer : user.ace.pdfViewer
syntaxValidation: user.ace.syntaxValidation syntaxValidation: user.ace.syntaxValidation
} }

View file

@ -24,6 +24,7 @@ UserSchema = new Schema
theme : {type : String, default: 'textmate'} theme : {type : String, default: 'textmate'}
fontSize : {type : Number, default:'12'} fontSize : {type : Number, default:'12'}
autoComplete: {type : Boolean, default: true} autoComplete: {type : Boolean, default: true}
autoPairDelimiters: {type : Boolean, default: true}
spellCheckLanguage : {type : String, default: "en"} spellCheckLanguage : {type : String, default: "en"}
pdfViewer : {type : String, default: "pdfjs"} pdfViewer : {type : String, default: "pdfjs"}
syntaxValidation : {type : Boolean} syntaxValidation : {type : Boolean}

View file

@ -37,6 +37,7 @@ div.full-size(
keybindings="settings.mode", keybindings="settings.mode",
font-size="settings.fontSize", font-size="settings.fontSize",
auto-complete="settings.autoComplete", auto-complete="settings.autoComplete",
auto-pair-delimiters="settings.autoPairDelimiters",
spell-check="!anonymous", spell-check="!anonymous",
spell-check-language="project.spellCheckLanguage" spell-check-language="project.spellCheckLanguage"
highlights="onlineUserCursorHighlights[editor.open_doc_id]" highlights="onlineUserCursorHighlights[editor.open_doc_id]"

View file

@ -105,6 +105,14 @@ aside#left-menu.full-size(
ng-options="o.v as o.n for o in [{ n: 'On', v: true }, { n: 'Off', v: false }]" ng-options="o.v as o.n for o in [{ n: 'On', v: true }, { n: 'Off', v: false }]"
) )
.form-controls
label(for="autoPairDelimiters") #{translate("auto_pair_delimiters")}
select(
name="autoPairDelimiters"
ng-model="settings.autoPairDelimiters"
ng-options="o.v as o.n for o in [{ n: 'On', v: true }, { n: 'Off', v: false }]"
)
.form-controls.code-check-setting .form-controls.code-check-setting
label(for="syntaxValidation") #{translate("syntax_validation")} label(for="syntaxValidation") #{translate("syntax_validation")}
select( select(

View file

@ -44,6 +44,7 @@ define [
keybindings: "=" keybindings: "="
fontSize: "=" fontSize: "="
autoComplete: "=" autoComplete: "="
autoPairDelimiters: "="
sharejsDoc: "=" sharejsDoc: "="
spellCheck: "=" spellCheck: "="
spellCheckLanguage: "=" spellCheckLanguage: "="
@ -78,10 +79,16 @@ define [
editor = ace.edit(element.find(".ace-editor-body")[0]) editor = ace.edit(element.find(".ace-editor-body")[0])
editor.$blockScrolling = Infinity editor.$blockScrolling = Infinity
# disable auto insertion of brackets and quotes # auto-insertion of braces, brackets, dollars
editor.setOption('behavioursEnabled', false) editor.setOption('behavioursEnabled', scope.autoPairDelimiters || false)
editor.setOption('wrapBehavioursEnabled', false) editor.setOption('wrapBehavioursEnabled', false)
scope.$watch "autoPairDelimiters", (autoPairDelimiters) =>
if autoPairDelimiters
editor.setOption('behavioursEnabled', true)
else
editor.setOption('behavioursEnabled', false)
window.editors ||= [] window.editors ||= []
window.editors.push editor window.editors.push editor

View file

@ -24,6 +24,10 @@ define [
if autoComplete != oldAutoComplete if autoComplete != oldAutoComplete
settings.saveSettings({autoComplete: autoComplete}) settings.saveSettings({autoComplete: autoComplete})
$scope.$watch "settings.autoPairDelimiters", (autoPairDelimiters, oldAutoPairDelimiters) =>
if autoPairDelimiters != oldAutoPairDelimiters
settings.saveSettings({autoPairDelimiters: autoPairDelimiters})
$scope.$watch "settings.pdfViewer", (pdfViewer, oldPdfViewer) => $scope.$watch "settings.pdfViewer", (pdfViewer, oldPdfViewer) =>
if pdfViewer != oldPdfViewer if pdfViewer != oldPdfViewer
settings.saveSettings({pdfViewer: pdfViewer}) settings.saveSettings({pdfViewer: pdfViewer})
@ -61,4 +65,4 @@ define [
$scope.$apply () => $scope.$apply () =>
$scope.project.spellCheckLanguage = languageCode $scope.project.spellCheckLanguage = languageCode
delete @ignoreUpdates delete @ignoreUpdates
] ]

View file

@ -195,7 +195,308 @@ oop.inherits(FoldMode, BaseFoldMode);
}); });
ace.define("ace/mode/latex",["require","exports","module","ace/lib/oop","ace/mode/text","ace/mode/latex_highlight_rules","ace/mode/folding/latex","ace/range","ace/worker/worker_client"], function(require, exports, module) { ace.define("ace/mode/behaviour/latex",["require","exports","module","ace/lib/oop","ace/mode/behaviour","ace/token_iterator","ace/lib/lang"], function(require, exports, module) {
"use strict";
var oop = require("../../lib/oop");
var Behaviour = require("../behaviour").Behaviour;
var TokenIterator = require("../../token_iterator").TokenIterator;
var lang = require("../../lib/lang");
var SAFE_INSERT_IN_TOKENS =
["text", "paren.rparen", "punctuation.operator"];
var SAFE_INSERT_BEFORE_TOKENS =
["text", "paren.rparen", "punctuation.operator", "comment"];
var context;
var contextCache = {};
var initContext = function(editor) {
var id = -1;
if (editor.multiSelect) {
id = editor.selection.index;
if (contextCache.rangeCount != editor.multiSelect.rangeCount)
contextCache = {rangeCount: editor.multiSelect.rangeCount};
}
if (contextCache[id])
return context = contextCache[id];
context = contextCache[id] = {
autoInsertedBrackets: 0,
autoInsertedRow: -1,
autoInsertedLineEnd: "",
maybeInsertedBrackets: 0,
maybeInsertedRow: -1,
maybeInsertedLineStart: "",
maybeInsertedLineEnd: ""
};
};
var getWrapped = function(selection, selected, opening, closing) {
var rowDiff = selection.end.row - selection.start.row;
return {
text: opening + selected + closing,
selection: [
0,
selection.start.column + 1,
rowDiff,
selection.end.column + (rowDiff ? 0 : 1)
]
};
};
var LatexBehaviour = function() {
this.add("braces", "insertion", function(state, action, editor, session, text) {
if (editor.completer && editor.completer.popup && editor.completer.popup.isOpen) {
return;
}
var cursor = editor.getCursorPosition();
var line = session.doc.getLine(cursor.row);
var lastChar = line[cursor.column-1];
if (lastChar === '\\') {
return;
}
if (text == '{') {
initContext(editor);
var selection = editor.getSelectionRange();
var selected = session.doc.getTextRange(selection);
if (selected !== "" && editor.getWrapBehavioursEnabled()) {
return getWrapped(selection, selected, '{', '}');
} else if (LatexBehaviour.isSaneInsertion(editor, session)) {
LatexBehaviour.recordAutoInsert(editor, session, "}");
return {
text: '{}',
selection: [1, 1]
};
}
} else if (text == '}') {
initContext(editor);
var rightChar = line.substring(cursor.column, cursor.column + 1);
if (rightChar == '}') {
var matching = session.$findOpeningBracket('}', {column: cursor.column + 1, row: cursor.row});
if (matching !== null && LatexBehaviour.isAutoInsertedClosing(cursor, line, text)) {
LatexBehaviour.popAutoInsertedClosing();
return {
text: '',
selection: [1, 1]
};
}
}
}
});
this.add("braces", "deletion", function(state, action, editor, session, range) {
if (editor.completer && editor.completer.popup && editor.completer.popup.isOpen) {
return;
}
var selected = session.doc.getTextRange(range);
if (!range.isMultiLine() && selected == '{') {
initContext(editor);
var line = session.doc.getLine(range.start.row);
var rightChar = line.substring(range.start.column + 1, range.start.column + 2);
if (rightChar == '}') {
range.end.column++;
return range;
}
}
});
this.add("brackets", "insertion", function(state, action, editor, session, text) {
if (editor.completer && editor.completer.popup && editor.completer.popup.isOpen) {
return;
}
var cursor = editor.getCursorPosition();
var line = session.doc.getLine(cursor.row);
var lastChar = line[cursor.column-1];
if (lastChar === '\\') {
return;
}
if (text == '[') {
initContext(editor);
var selection = editor.getSelectionRange();
var selected = session.doc.getTextRange(selection);
if (selected !== "" && editor.getWrapBehavioursEnabled()) {
return getWrapped(selection, selected, '[', ']');
} else if (LatexBehaviour.isSaneInsertion(editor, session)) {
LatexBehaviour.recordAutoInsert(editor, session, "]");
return {
text: '[]',
selection: [1, 1]
};
}
} else if (text == ']') {
initContext(editor);
var rightChar = line.substring(cursor.column, cursor.column + 1);
if (rightChar == ']') {
var matching = session.$findOpeningBracket(']', {column: cursor.column + 1, row: cursor.row});
if (matching !== null && LatexBehaviour.isAutoInsertedClosing(cursor, line, text)) {
LatexBehaviour.popAutoInsertedClosing();
return {
text: '',
selection: [1, 1]
};
}
}
}
});
this.add("brackets", "deletion", function(state, action, editor, session, range) {
if (editor.completer && editor.completer.popup && editor.completer.popup.isOpen) {
return;
}
var selected = session.doc.getTextRange(range);
if (!range.isMultiLine() && selected == '[') {
initContext(editor);
var line = session.doc.getLine(range.start.row);
var rightChar = line.substring(range.start.column + 1, range.start.column + 2);
if (rightChar == ']') {
range.end.column++;
return range;
}
}
});
this.add("dollars", "insertion", function(state, action, editor, session, text) {
var cursor = editor.getCursorPosition();
var line = session.doc.getLine(cursor.row);
var lastChar = line[cursor.column-1];
if (lastChar === '\\') {
return;
}
if (text == '$') {
if (this.lineCommentStart && this.lineCommentStart.indexOf(text) != -1)
return;
initContext(editor);
var quote = text;
var selection = editor.getSelectionRange();
var selected = session.doc.getTextRange(selection);
if (selected !== "" && selected !== "$" && editor.getWrapBehavioursEnabled()) {
return getWrapped(selection, selected, quote, quote);
} else if (!selected) {
var leftChar = line.substring(cursor.column-1, cursor.column);
var rightChar = line.substring(cursor.column, cursor.column + 1);
var token = session.getTokenAt(cursor.row, cursor.column);
var rightToken = session.getTokenAt(cursor.row, cursor.column + 1);
var stringBefore = token && /string|escape/.test(token.type);
var stringAfter = !rightToken || /string|escape/.test(rightToken.type);
var pair;
if (rightChar == quote) {
pair = stringBefore !== stringAfter;
if (pair && /string\.end/.test(rightToken.type))
pair = false;
} else {
if (stringBefore && !stringAfter)
return null; // wrap string with different quote
if (stringBefore && stringAfter)
return null; // do not pair quotes inside strings
var wordRe = session.$mode.tokenRe;
wordRe.lastIndex = 0;
var isWordBefore = wordRe.test(leftChar);
wordRe.lastIndex = 0;
var isWordAfter = wordRe.test(leftChar);
if (isWordBefore || isWordAfter)
return null; // before or after alphanumeric
if (rightChar && !/[\s;,.})\]\\]/.test(rightChar))
return null; // there is rightChar and it isn't closing
pair = true;
}
return {
text: pair ? quote + quote : "",
selection: [1,1]
};
}
}
});
this.add("dollars", "deletion", function(state, action, editor, session, range) {
var selected = session.doc.getTextRange(range);
if (!range.isMultiLine() && (selected == '$')) {
initContext(editor);
var line = session.doc.getLine(range.start.row);
var rightChar = line.substring(range.start.column + 1, range.start.column + 2);
if (rightChar == selected) {
range.end.column++;
return range;
}
}
});
};
LatexBehaviour.isSaneInsertion = function(editor, session) {
var cursor = editor.getCursorPosition();
var iterator = new TokenIterator(session, cursor.row, cursor.column);
if (!this.$matchTokenType(iterator.getCurrentToken() || "text", SAFE_INSERT_IN_TOKENS)) {
var iterator2 = new TokenIterator(session, cursor.row, cursor.column + 1);
if (!this.$matchTokenType(iterator2.getCurrentToken() || "text", SAFE_INSERT_IN_TOKENS))
return false;
}
iterator.stepForward();
return iterator.getCurrentTokenRow() !== cursor.row ||
this.$matchTokenType(iterator.getCurrentToken() || "text", SAFE_INSERT_BEFORE_TOKENS);
};
LatexBehaviour.$matchTokenType = function(token, types) {
return types.indexOf(token.type || token) > -1;
};
LatexBehaviour.recordAutoInsert = function(editor, session, bracket) {
var cursor = editor.getCursorPosition();
var line = session.doc.getLine(cursor.row);
if (!this.isAutoInsertedClosing(cursor, line, context.autoInsertedLineEnd[0]))
context.autoInsertedBrackets = 0;
context.autoInsertedRow = cursor.row;
context.autoInsertedLineEnd = bracket + line.substr(cursor.column);
context.autoInsertedBrackets++;
};
LatexBehaviour.recordMaybeInsert = function(editor, session, bracket) {
var cursor = editor.getCursorPosition();
var line = session.doc.getLine(cursor.row);
if (!this.isMaybeInsertedClosing(cursor, line))
context.maybeInsertedBrackets = 0;
context.maybeInsertedRow = cursor.row;
context.maybeInsertedLineStart = line.substr(0, cursor.column) + bracket;
context.maybeInsertedLineEnd = line.substr(cursor.column);
context.maybeInsertedBrackets++;
};
LatexBehaviour.isAutoInsertedClosing = function(cursor, line, bracket) {
return context.autoInsertedBrackets > 0 &&
cursor.row === context.autoInsertedRow &&
bracket === context.autoInsertedLineEnd[0] &&
line.substr(cursor.column) === context.autoInsertedLineEnd;
};
LatexBehaviour.isMaybeInsertedClosing = function(cursor, line) {
return context.maybeInsertedBrackets > 0 &&
cursor.row === context.maybeInsertedRow &&
line.substr(cursor.column) === context.maybeInsertedLineEnd &&
line.substr(0, cursor.column) == context.maybeInsertedLineStart;
};
LatexBehaviour.popAutoInsertedClosing = function() {
context.autoInsertedLineEnd = context.autoInsertedLineEnd.substr(1);
context.autoInsertedBrackets--;
};
LatexBehaviour.clearMaybeInsertedClosing = function() {
if (context) {
context.maybeInsertedBrackets = 0;
context.maybeInsertedRow = -1;
}
};
oop.inherits(LatexBehaviour, Behaviour);
exports.LatexBehaviour = LatexBehaviour;
});
ace.define("ace/mode/latex",["require","exports","module","ace/lib/oop","ace/mode/text","ace/mode/latex_highlight_rules","ace/mode/folding/latex","ace/range","ace/worker/worker_client","ace/mode/behaviour/latex"], function(require, exports, module) {
"use strict"; "use strict";
var oop = require("../lib/oop"); var oop = require("../lib/oop");
@ -204,6 +505,7 @@ var LatexHighlightRules = require("./latex_highlight_rules").LatexHighlightRules
var LatexFoldMode = require("./folding/latex").FoldMode; var LatexFoldMode = require("./folding/latex").FoldMode;
var Range = require("../range").Range; var Range = require("../range").Range;
var WorkerClient = require("ace/worker/worker_client").WorkerClient; var WorkerClient = require("ace/worker/worker_client").WorkerClient;
var LatexBehaviour = require("./behaviour/latex").LatexBehaviour;
var createLatexWorker = function (session) { var createLatexWorker = function (session) {
var doc = session.getDocument(); var doc = session.getDocument();
@ -361,6 +663,7 @@ var createLatexWorker = function (session) {
var Mode = function() { var Mode = function() {
this.HighlightRules = LatexHighlightRules; this.HighlightRules = LatexHighlightRules;
this.foldingRules = new LatexFoldMode(); this.foldingRules = new LatexFoldMode();
this.$behaviour = new LatexBehaviour();
this.createWorker = createLatexWorker; this.createWorker = createLatexWorker;
}; };
oop.inherits(Mode, TextMode); oop.inherits(Mode, TextMode);