completer.js
357 lines
| 11.6 KiB
| application/javascript
|
JavascriptLexer
Matthias BUSSONNIER
|
r7131 | // function completer. | ||
// | ||||
Susan Tan
|
r13822 | // completer should be a class that takes an cell instance | ||
Matthias BUSSONNIER
|
r7191 | var IPython = (function (IPython) { | ||
Matthias BUSSONNIER
|
r7142 | // that will prevent us from misspelling | ||
Matthias BUSSONNIER
|
r7131 | "use strict"; | ||
Susan Tan
|
r13822 | // easier key mapping | ||
Matthias BUSSONNIER
|
r7137 | var key = IPython.utils.keycodes; | ||
Matthias BUSSONNIER
|
r7142 | |||
Matthias BUSSONNIER
|
r7349 | function prepend_n_prc(str, n) { | ||
Matthias BUSSONNIER
|
r12912 | for( var i =0 ; i< n ; i++){ | ||
str = '%'+str ; | ||||
} | ||||
Matthias BUSSONNIER
|
r7348 | return str; | ||
} | ||||
Matthias BUSSONNIER
|
r7293 | function _existing_completion(item, completion_array){ | ||
Matthias BUSSONNIER
|
r11282 | for( var c in completion_array ) { | ||
if(completion_array[c].trim().substr(-item.length) == item) | ||||
{ return true; } | ||||
} | ||||
Matthias BUSSONNIER
|
r7303 | return false; | ||
Matthias BUSSONNIER
|
r7288 | } | ||
Matthias BUSSONNIER
|
r7190 | |||
Matthias BUSSONNIER
|
r7303 | // what is the common start of all completions | ||
Matthias BUSSONNIER
|
r7349 | function shared_start(B, drop_prct) { | ||
Matthias BUSSONNIER
|
r7190 | if (B.length == 1) { | ||
return B[0]; | ||||
} | ||||
var A = new Array(); | ||||
Matthias BUSSONNIER
|
r7348 | var common; | ||
var min_lead_prct = 10; | ||||
Matthias BUSSONNIER
|
r7190 | for (var i = 0; i < B.length; i++) { | ||
Matthias BUSSONNIER
|
r7349 | var str = B[i].str; | ||
var localmin = 0; | ||||
Matthias BUSSONNIER
|
r12912 | if(drop_prct === true){ | ||
Matthias BUSSONNIER
|
r7349 | while ( str.substr(0, 1) == '%') { | ||
Matthias BUSSONNIER
|
r7348 | localmin = localmin+1; | ||
str = str.substring(1); | ||||
} | ||||
} | ||||
Matthias BUSSONNIER
|
r7349 | min_lead_prct = Math.min(min_lead_prct, localmin); | ||
Matthias BUSSONNIER
|
r7348 | A.push(str); | ||
Matthias BUSSONNIER
|
r7190 | } | ||
Matthias BUSSONNIER
|
r7348 | |||
Matthias BUSSONNIER
|
r7190 | if (A.length > 1) { | ||
var tem1, tem2, s; | ||||
A = A.slice(0).sort(); | ||||
tem1 = A[0]; | ||||
s = tem1.length; | ||||
tem2 = A.pop(); | ||||
while (s && tem2.indexOf(tem1) == -1) { | ||||
tem1 = tem1.substring(0, --s); | ||||
Matthias BUSSONNIER
|
r7131 | } | ||
Matthias BUSSONNIER
|
r12912 | if (tem1 === "" || tem2.indexOf(tem1) !== 0) { | ||
Matthias BUSSONNIER
|
r12068 | return { | ||
str:prepend_n_prc('', min_lead_prct), | ||||
type: "computed", | ||||
from: B[0].from, | ||||
to: B[0].to | ||||
Matthias BUSSONNIER
|
r12912 | }; | ||
Matthias BUSSONNIER
|
r7131 | } | ||
Matthias BUSSONNIER
|
r7190 | return { | ||
Matthias BUSSONNIER
|
r7349 | str: prepend_n_prc(tem1, min_lead_prct), | ||
Matthias BUSSONNIER
|
r7190 | type: "computed", | ||
from: B[0].from, | ||||
to: B[0].to | ||||
}; | ||||
Matthias BUSSONNIER
|
r7131 | } | ||
Matthias BUSSONNIER
|
r7190 | return null; | ||
} | ||||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r7141 | |||
Matthias BUSSONNIER
|
r7191 | var Completer = function (cell) { | ||
Brian E. Granger
|
r9221 | this.cell = cell; | ||
this.editor = cell.code_mirror; | ||||
var that = this; | ||||
$([IPython.events]).on('status_busy.Kernel', function () { | ||||
that.skip_kernel_completion = true; | ||||
}); | ||||
$([IPython.events]).on('status_idle.Kernel', function () { | ||||
that.skip_kernel_completion = false; | ||||
}); | ||||
}; | ||||
Matthias BUSSONNIER
|
r7141 | |||
Matthias BUSSONNIER
|
r7174 | |||
Matthias BUSSONNIER
|
r7191 | Completer.prototype.startCompletion = function () { | ||
Matthias BUSSONNIER
|
r7142 | // call for a 'first' completion, that will set the editor and do some | ||
Matthias BUSSONNIER
|
r7131 | // special behaviour like autopicking if only one completion availlable | ||
// | ||||
if (this.editor.somethingSelected()) return; | ||||
this.done = false; | ||||
// use to get focus back on opera | ||||
Matthias BUSSONNIER
|
r7192 | this.carry_on_completion(true); | ||
Matthias BUSSONNIER
|
r7170 | }; | ||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r12912 | |||
// easy access for julia to monkeypatch | ||||
// | ||||
Completer.reinvoke_re = /[%0-9a-z._/\\:~-]/i; | ||||
Completer.prototype.reinvoke= function(pre_cursor, block, cursor){ | ||||
return Completer.reinvoke_re.test(pre_cursor); | ||||
} | ||||
/** | ||||
* | ||||
* pass true as parameter if this is the first invocation of the completer | ||||
* this will prevent the completer to dissmiss itself if it is not on a | ||||
* word boundary like pressing tab after a space, and make it autopick the | ||||
* only choice if there is only one which prevent from popping the UI. as | ||||
* well as fast-forwarding the typing if all completion have a common | ||||
* shared start | ||||
**/ | ||||
Completer.prototype.carry_on_completion = function (first_invocation) { | ||||
Susan Tan
|
r13822 | // Pass true as parameter if you want the completer to autopick when | ||
Matthias BUSSONNIER
|
r7143 | // only one completion. This function is automatically reinvoked at | ||
Matthias BUSSONNIER
|
r12912 | // each keystroke with first_invocation = false | ||
Matthias BUSSONNIER
|
r7131 | var cur = this.editor.getCursor(); | ||
Matthias BUSSONNIER
|
r7174 | var line = this.editor.getLine(cur.line); | ||
Matthias BUSSONNIER
|
r7190 | var pre_cursor = this.editor.getRange({ | ||
line: cur.line, | ||||
ch: cur.ch - 1 | ||||
}, cur); | ||||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r7142 | // we need to check that we are still on a word boundary | ||
Matthias BUSSONNIER
|
r7131 | // because while typing the completer is still reinvoking itself | ||
Matthias BUSSONNIER
|
r12912 | // so dismiss if we are on a "bad" caracter | ||
if (!this.reinvoke(pre_cursor) && !first_invocation) { | ||||
Matthias BUSSONNIER
|
r7190 | this.close(); | ||
return; | ||||
} | ||||
Matthias BUSSONNIER
|
r7142 | |||
Matthias BUSSONNIER
|
r7131 | this.autopick = false; | ||
Matthias BUSSONNIER
|
r12912 | if (first_invocation) { | ||
Matthias BUSSONNIER
|
r7190 | this.autopick = true; | ||
} | ||||
Matthias BUSSONNIER
|
r7143 | |||
Matthias BUSSONNIER
|
r7131 | // We want a single cursor position. | ||
Matthias BUSSONNIER
|
r12912 | if (this.editor.somethingSelected()) { | ||
return; | ||||
}; | ||||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r7174 | // one kernel completion came back, finish_completing will be called with the results | ||
// we fork here and directly call finish completing if kernel is busy | ||||
Matthias BUSSONNIER
|
r7190 | if (this.skip_kernel_completion == true) { | ||
this.finish_completing({ | ||||
'matches': [], | ||||
matched_text: "" | ||||
}) | ||||
Matthias BUSSONNIER
|
r7174 | } else { | ||
MinRK
|
r13208 | this.cell.kernel.complete(line, cur.ch, $.proxy(this.finish_completing, this)); | ||
Matthias BUSSONNIER
|
r7174 | } | ||
Matthias BUSSONNIER
|
r7170 | }; | ||
Matthias BUSSONNIER
|
r7142 | |||
MinRK
|
r13207 | Completer.prototype.finish_completing = function (msg) { | ||
Matthias BUSSONNIER
|
r7143 | // let's build a function that wrap all that stuff into what is needed | ||
// for the new completer: | ||||
MinRK
|
r13207 | var content = msg.content; | ||
Brian Granger
|
r7168 | var matched_text = content.matched_text; | ||
var matches = content.matches; | ||||
Matthias BUSSONNIER
|
r7143 | |||
Matthias BUSSONNIER
|
r7142 | var cur = this.editor.getCursor(); | ||
var results = CodeMirror.contextHint(this.editor); | ||||
Matthias BUSSONNIER
|
r7287 | var filterd_results = Array(); | ||
//remove results from context completion | ||||
//that are already in kernel completion | ||||
Matthias BUSSONNIER
|
r7293 | for(var elm in results) { | ||
Matthias BUSSONNIER
|
r7303 | if(_existing_completion(results[elm]['str'], matches) == false) | ||
Matthias BUSSONNIER
|
r7293 | { filterd_results.push(results[elm]); } | ||
Matthias BUSSONNIER
|
r7287 | } | ||
Matthias BUSSONNIER
|
r7142 | |||
Matthias BUSSONNIER
|
r7143 | // append the introspection result, in order, at at the beginning of | ||
// the table and compute the replacement range from current cursor | ||||
// positon and matched_text length. | ||||
Matthias BUSSONNIER
|
r7190 | for (var i = matches.length - 1; i >= 0; --i) { | ||
Matthias BUSSONNIER
|
r7287 | filterd_results.unshift({ | ||
Matthias BUSSONNIER
|
r7190 | str: matches[i], | ||
type: "introspection", | ||||
from: { | ||||
line: cur.line, | ||||
ch: cur.ch - matched_text.length | ||||
}, | ||||
to: { | ||||
line: cur.line, | ||||
ch: cur.ch | ||||
} | ||||
}); | ||||
Matthias BUSSONNIER
|
r7142 | } | ||
// one the 2 sources results have been merge, deal with it | ||||
Matthias BUSSONNIER
|
r7287 | this.raw_result = filterd_results; | ||
Matthias BUSSONNIER
|
r7131 | |||
// if empty result return | ||||
if (!this.raw_result || !this.raw_result.length) return; | ||||
// When there is only one completion, use it directly. | ||||
Matthias BUSSONNIER
|
r7190 | if (this.autopick == true && this.raw_result.length == 1) { | ||
Matthias BUSSONNIER
|
r7170 | this.insert(this.raw_result[0]); | ||
return; | ||||
} | ||||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r7190 | if (this.raw_result.length == 1) { | ||
Matthias BUSSONNIER
|
r7143 | // test if first and only completion totally matches | ||
// what is typed, in this case dismiss | ||||
Matthias BUSSONNIER
|
r7170 | var str = this.raw_result[0].str; | ||
Matthias BUSSONNIER
|
r7190 | var pre_cursor = this.editor.getRange({ | ||
line: cur.line, | ||||
ch: cur.ch - str.length | ||||
}, cur); | ||||
if (pre_cursor == str) { | ||||
this.close(); | ||||
return; | ||||
} | ||||
Matthias BUSSONNIER
|
r7131 | } | ||
this.complete = $('<div/>').addClass('completions'); | ||||
Matthias BUSSONNIER
|
r7190 | this.complete.attr('id', 'complete'); | ||
Matthias BUSSONNIER
|
r7131 | |||
Brian E. Granger
|
r14022 | // Currently webkit doesn't use the size attr correctly. See: | ||
// https://code.google.com/p/chromium/issues/detail?id=4579 | ||||
Matthias BUSSONNIER
|
r12912 | this.sel = $('<select style="width: auto"/>') | ||
.attr('multiple', 'true') | ||||
.attr('size', Math.min(10, this.raw_result.length)); | ||||
Matthias BUSSONNIER
|
r7131 | this.complete.append(this.sel); | ||
$('body').append(this.complete); | ||||
Brian E. Granger
|
r12895 | |||
Brian E. Granger
|
r12897 | // After everything is on the page, compute the postion. | ||
// We put it above the code if it is too close to the bottom of the page. | ||||
Brian E. Granger
|
r12895 | var cur = this.editor.getCursor(); | ||
cur.ch = cur.ch-matched_text.length; | ||||
var pos = this.editor.cursorCoords(cur); | ||||
var left = pos.left-3; | ||||
var top; | ||||
var cheight = this.complete.height(); | ||||
var wheight = $(window).height(); | ||||
if (pos.bottom+cheight+5 > wheight) { | ||||
top = pos.top-cheight-4; | ||||
} else { | ||||
top = pos.bottom+1; | ||||
} | ||||
this.complete.css('left', left + 'px'); | ||||
this.complete.css('top', top + 'px'); | ||||
Matthias BUSSONNIER
|
r7131 | //build the container | ||
var that = this; | ||||
Brian E. Granger
|
r14021 | this.sel.dblclick(function () { | ||
that.pick(); | ||||
}); | ||||
this.sel.blur(this.close); | ||||
this.sel.keydown(function (event) { | ||||
that.keydown(event); | ||||
}); | ||||
Matthias BUSSONNIER
|
r7131 | |||
Brian E. Granger
|
r12896 | this.build_gui_list(this.raw_result); | ||
Matthias BUSSONNIER
|
r7131 | |||
Brian E. Granger
|
r14021 | this.sel.focus(); | ||
Brian E. Granger
|
r14023 | IPython.keyboard_manager.disable(); | ||
Brian E. Granger
|
r14020 | // Opera sometimes ignores focusing a freshly created node | ||
Brian E. Granger
|
r14021 | if (window.opera) setTimeout(function () { | ||
if (!this.done) this.sel.focus(); | ||||
}, 100); | ||||
Matthias BUSSONNIER
|
r7131 | return true; | ||
} | ||||
Matthias BUSSONNIER
|
r7191 | Completer.prototype.insert = function (completion) { | ||
Matthias BUSSONNIER
|
r7131 | this.editor.replaceRange(completion.str, completion.from, completion.to); | ||
Matthias BUSSONNIER
|
r7190 | } | ||
Matthias BUSSONNIER
|
r7131 | |||
Brian E. Granger
|
r12896 | Completer.prototype.build_gui_list = function (completions) { | ||
for (var i = 0; i < completions.length; ++i) { | ||||
var opt = $('<option/>').text(completions[i].str).addClass(completions[i].type); | ||||
this.sel.append(opt); | ||||
Matthias BUSSONNIER
|
r7131 | } | ||
Brian E. Granger
|
r12896 | this.sel.children().first().attr('selected', 'true'); | ||
this.sel.scrollTop(0); | ||||
Matthias BUSSONNIER
|
r7131 | } | ||
Matthias BUSSONNIER
|
r7191 | Completer.prototype.close = function () { | ||
Matthias BUSSONNIER
|
r7190 | if (this.done) return; | ||
this.done = true; | ||||
$('.completions').remove(); | ||||
Brian E. Granger
|
r14023 | IPython.keyboard_manager.enable(); | ||
Matthias BUSSONNIER
|
r7190 | } | ||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r7191 | Completer.prototype.pick = function () { | ||
Matthias BUSSONNIER
|
r7131 | this.insert(this.raw_result[this.sel[0].selectedIndex]); | ||
this.close(); | ||||
var that = this; | ||||
Matthias BUSSONNIER
|
r7191 | setTimeout(function () { | ||
Matthias BUSSONNIER
|
r7190 | that.editor.focus(); | ||
}, 50); | ||||
} | ||||
Matthias BUSSONNIER
|
r7131 | |||
Matthias BUSSONNIER
|
r7142 | |||
Matthias BUSSONNIER
|
r7191 | Completer.prototype.keydown = function (event) { | ||
Matthias BUSSONNIER
|
r7190 | var code = event.keyCode; | ||
var that = this; | ||||
Juergen Hasch
|
r10239 | var special_key = false; | ||
Matthias BUSSONNIER
|
r12912 | |||
Juergen Hasch
|
r10239 | // detect special keys like SHIFT,PGUP,... | ||
for( var _key in key ) { | ||||
if (code == key[_key] ) { | ||||
special_key = true; | ||||
} | ||||
Matthias BUSSONNIER
|
r12912 | }; | ||
Juergen Hasch
|
r10239 | |||
Matthias BUSSONNIER
|
r7190 | // Enter | ||
Matthias BUSSONNIER
|
r7193 | if (code == key.ENTER) { | ||
Matthias BUSSONNIER
|
r7190 | CodeMirror.e_stop(event); | ||
this.pick(); | ||||
} | ||||
// Escape or backspace | ||||
Matthias BUSSONNIER
|
r7193 | else if (code == key.ESC) { | ||
Matthias BUSSONNIER
|
r7190 | CodeMirror.e_stop(event); | ||
this.close(); | ||||
this.editor.focus(); | ||||
Matthias BUSSONNIER
|
r7193 | } else if (code == key.SPACE || code == key.BACKSPACE) { | ||
Matthias BUSSONNIER
|
r7190 | this.close(); | ||
this.editor.focus(); | ||||
Matthias BUSSONNIER
|
r7193 | } else if (code == key.TAB) { | ||
Matthias BUSSONNIER
|
r7142 | //all the fastforwarding operation, | ||
Matthias BUSSONNIER
|
r7132 | //Check that shared start is not null which can append with prefixed completion | ||
// like %pylab , pylab have no shred start, and ff will result in py<tab><tab> | ||||
// to erase py | ||||
Matthias BUSSONNIER
|
r7349 | var sh = shared_start(this.raw_result, true); | ||
Matthias BUSSONNIER
|
r7190 | if (sh) { | ||
Matthias BUSSONNIER
|
r7132 | this.insert(sh); | ||
} | ||||
Matthias BUSSONNIER
|
r7142 | this.close(); | ||
Matthias BUSSONNIER
|
r7131 | CodeMirror.e_stop(event); | ||
this.editor.focus(); | ||||
//reinvoke self | ||||
Matthias BUSSONNIER
|
r7191 | setTimeout(function () { | ||
Matthias BUSSONNIER
|
r7192 | that.carry_on_completion(); | ||
Matthias BUSSONNIER
|
r7190 | }, 50); | ||
Matthias BUSSONNIER
|
r7193 | } else if (code == key.UPARROW || code == key.DOWNARROW) { | ||
Matthias BUSSONNIER
|
r7190 | // need to do that to be able to move the arrow | ||
// when on the first or last line ofo a code cell | ||||
event.stopPropagation(); | ||||
Matthias BUSSONNIER
|
r12912 | } else if (special_key != true) { | ||
Matthias BUSSONNIER
|
r7190 | this.close(); | ||
this.editor.focus(); | ||||
//we give focus to the editor immediately and call sell in 50 ms | ||||
Matthias BUSSONNIER
|
r7191 | setTimeout(function () { | ||
Matthias BUSSONNIER
|
r7192 | that.carry_on_completion(); | ||
Matthias BUSSONNIER
|
r7190 | }, 50); | ||
} | ||||
Matthias BUSSONNIER
|
r7131 | } | ||
IPython.Completer = Completer; | ||||
return IPython; | ||||
}(IPython)); | ||||