2 * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
3 * (C) Copyright 2009-2010 John J. Foerch
5 * Use, modification, and distribution are subject to the terms specified in the
12 * minibuffer_state: abstact base class for minibuffer states.
14 function minibuffer_state (minibuffer, keymap) {
15 this.minibuffer = minibuffer;
16 this.keymaps = [default_base_keymap, keymap];
18 minibuffer_state.prototype = {
19 constructor: minibuffer_state,
21 unload: function () {},
22 destroy: function () {}
27 * minibuffer_message_state: base class for minibuffer states which do not
28 * use the input element, but still may use a keymap.
30 function minibuffer_message_state (minibuffer, keymap, message, cleanup_function) {
31 minibuffer_state.call(this, minibuffer, keymap);
32 this._message = message;
33 this.cleanup_function = cleanup_function;
35 minibuffer_message_state.prototype = {
36 constructor: minibuffer_message_state,
37 __proto__: minibuffer_state.prototype,
39 get message () { return this._message; },
41 this.minibuffer._restore_normal_state();
42 this.minibuffer._show(this._message);
45 minibuffer_state.prototype.load.call(this);
46 this.minibuffer._show(this.message);
48 cleanup_function: null,
49 destroy: function () {
50 if (this.cleanup_function)
51 this.cleanup_function();
52 minibuffer_state.prototype.destroy.call(this);
58 * minibuffer_input_state: base class for minibuffer states which use the
61 function minibuffer_input_state (minibuffer, keymap, prompt, input, selection_start, selection_end) {
62 minibuffer_state.call(this, minibuffer, keymap);
69 this.selection_start = selection_start;
71 this.selection_start = 0;
73 this.selection_end = selection_end;
75 this.selection_end = this.selection_start;
76 this.minibuffer.window.input.begin_recursion();
78 minibuffer_input_state.prototype = {
79 constructor: minibuffer_input_state,
80 __proto__: minibuffer_state.prototype,
83 minibuffer_state.prototype.load.call(this);
84 this.minibuffer.ignore_input_events = true;
85 this.minibuffer._input_text = this.input;
86 this.minibuffer.ignore_input_events = false;
87 this.minibuffer.prompt = this.prompt;
88 this.minibuffer._set_selection(this.selection_start,
92 this.input = this.minibuffer._input_text;
93 this.prompt = this.minibuffer.prompt;
94 this.selection_start = this.minibuffer._selection_start;
95 this.selection_end = this.minibuffer._selection_end;
96 minibuffer_state.prototype.unload.call(this);
98 destroy: function () {
99 this.minibuffer.window.input.end_recursion();
100 minibuffer_state.prototype.destroy.call(this);
106 * The parameter `args' is an object specifying the arguments for
107 * basic_minibuffer_state. The following properties of args must/may
112 * initial_value: [optional] specifies the initial text
114 * select: [optional] specifies to select the initial text if set to non-null
116 define_keywords("$keymap", "$prompt", "$initial_value", "$select");
117 function basic_minibuffer_state (minibuffer) {
118 keywords(arguments, $keymap = minibuffer_base_keymap);
119 var initial_value = arguments.$initial_value || "";
120 var sel_start, sel_end;
121 if (arguments.$select) {
123 sel_end = initial_value.length;
125 sel_start = sel_end = initial_value.length;
127 minibuffer_input_state.call(this, minibuffer, arguments.$keymap,
128 arguments.$prompt, initial_value,
131 basic_minibuffer_state.prototype = {
132 constructor: basic_minibuffer_state,
133 __proto__: minibuffer_input_state.prototype
137 define_variable("minibuffer_input_mode_show_message_timeout", 1000,
138 "Time duration (in milliseconds) to flash minibuffer messages while in "+
139 "minibuffer input mode.");
142 function minibuffer (window) {
143 this.element = window.document.getElementById("minibuffer");
144 this.output_element = window.document.getElementById("minibuffer-message");
145 this.input_prompt_element = window.document.getElementById("minibuffer-prompt");
146 this.input_element = window.document.getElementById("minibuffer-input");
148 this.input_element.inputField.addEventListener("blur",
150 if (m.active && m._input_mode_enabled && !m._showing_message) {
151 window.setTimeout(function () {
152 m.input_element.inputField.focus();
156 function dispatch_handle_input () {
157 if (m.ignore_input_events || !m._input_mode_enabled)
159 var s = m.current_state;
160 if (s && s.handle_input)
163 this.input_element.addEventListener("input", dispatch_handle_input, true);
164 this.input_element.watch("value",
165 function (prop, oldval, newval) {
166 if (newval != oldval &&
167 !m.ignore_input_events)
169 call_after_timeout(dispatch_handle_input, 0);
173 // Ensure that the input area will have focus if a message is
174 // currently being flashed so that the default handler for key
175 // events will properly add text to the input area.
176 window.addEventListener("keydown",
178 if (m._input_mode_enabled && m._showing_message)
179 m._restore_normal_state();
181 this.window = window;
182 this.last_message = "";
185 minibuffer.prototype = {
186 constructor: minibuffer,
187 get _selection_start () { return this.input_element.selectionStart; },
188 get _selection_end () { return this.input_element.selectionEnd; },
189 get _input_text () { return this.input_element.value; },
190 set _input_text (text) { this.input_element.value = text; },
191 get prompt () { return this.input_prompt_element.value; },
192 set prompt (s) { this.input_prompt_element.value = s; },
194 set_input_state: function (x) {
195 this._input_text = x[0];
196 this._set_selection(x[1], x[2]);
199 _set_selection: function (start, end) {
201 start = this._input_text.length;
203 end = this._input_text.length;
204 this.input_element.setSelectionRange(start,end);
207 /* Saved focus state */
208 saved_focused_frame: null,
209 saved_focused_element: null,
213 current_message: null,
215 /* This method will display the specified string in the
216 * minibuffer, without recording it in any log/Messages buffer. */
217 show: function (str, force) {
218 if (!this.active || force) {
219 this.current_message = str;
224 _show: function (str) {
225 if (this.last_message != str) {
226 this.output_element.value = str;
227 this.last_message = str;
231 message: function (str) {
235 this.show(str, true /* force */);
237 this._flash_temporary_message();
242 this.current_message = null;
244 this._show(this.default_message);
247 set_default_message: function (str) {
248 this.default_message = str;
249 if (this.current_message == null)
253 get current_state () {
254 if (! this.states[0])
256 return this.states[this.states.length - 1];
259 push_state: function (state) {
261 this.states.push(state);
262 this._restore_state();
265 pop_state: function () {
266 this.current_state.destroy();
268 this._restore_state();
271 pop_all: function () {
273 while ((state = this.current_state)) {
279 //XXX: breaking stack discipline can cause incorrect
280 // input recursion termination
281 remove_state: function (state) {
282 var i = this.states.indexOf(state);
285 var was_current = (i == (this.states.length - 1));
287 this.states.splice(i, 1);
289 this._restore_state();
292 _input_mode_enabled: false,
296 /* If _input_mode_enabled is true, this is set to indicate that
297 * the message area is being temporarily shown instead of the
299 _showing_message: false,
301 _message_timer_ID: null,
303 /* This must only be called if _input_mode_enabled is true */
304 //XXX: if it must only be called if _input_mode_enabled is true, then
305 // why does it have an else condition for handling
306 // minibuffer_message_state states?
307 _restore_normal_state: function () {
308 if (this._showing_message) {
309 this.window.clearTimeout(this._message_timer_ID);
310 this._message_timer_ID = null;
311 this._showing_message = false;
313 if (this._input_mode_enabled)
314 this._switch_to_input_mode();
316 // assumes that anything other than an input state is a
317 // minibuffer_message_state.
318 this._show(this.current_state._message);
322 /* This must only be called if _input_mode_enabled is true */
323 _flash_temporary_message: function () {
324 if (this._showing_message)
325 this.window.clearTimeout(this._message_timer_ID);
327 this._showing_message = true;
328 if (this._input_mode_enabled)
329 this._switch_to_message_mode();
332 this._message_timer_ID = this.window.setTimeout(function () {
333 obj._restore_normal_state();
334 }, minibuffer_input_mode_show_message_timeout);
337 _switch_to_input_mode: function () {
338 this.element.setAttribute("minibuffermode", "input");
339 this.input_element.inputField.focus();
342 _switch_to_message_mode: function () {
343 this.element.setAttribute("minibuffermode", "message");
346 _restore_state: function () {
347 var s = this.current_state;
350 this.saved_focused_frame = this.window.document.commandDispatcher.focusedWindow;
351 this.saved_focused_element = this.window.document.commandDispatcher.focusedElement;
358 this.window.buffers.current.browser.focus();
359 if (this.saved_focused_element && this.saved_focused_element.focus)
360 set_focus_no_scroll(this.window, this.saved_focused_element);
361 else if (this.saved_focused_frame)
362 set_focus_no_scroll(this.window, this.saved_focused_frame);
363 this.saved_focused_element = null;
364 this.saved_focused_frame = null;
365 this._show(this.current_message || this.default_message);
368 if (this._showing_message) {
369 this.window.clearTimeout(this._message_timer_ID);
370 this._message_timer_ID = null;
371 this._showing_message = false;
373 var want_input_mode = s instanceof minibuffer_input_state;
374 var in_input_mode = this._input_mode_enabled && !this._showing_message;
375 if (want_input_mode && !in_input_mode)
376 this._switch_to_input_mode();
377 else if (!want_input_mode && in_input_mode)
378 this._switch_to_message_mode();
379 this._input_mode_enabled = want_input_mode;
382 _save_state: function () {
383 var s = this.current_state;
388 insert_before: function (element) {
389 this.element.parentNode.insertBefore(element, this.element);
394 function minibuffer_initialize_window (window) {
395 window.minibuffer = new minibuffer(window);
397 add_hook("window_initialize_early_hook", minibuffer_initialize_window);
400 function minibuffer_window_close_handler (window) {
401 window.minibuffer.pop_all();
403 add_hook("window_close_hook", minibuffer_window_close_handler);
406 /* Note: This is concise, but doesn't seem to be useful in practice,
407 * because nothing can be done with the state alone. */
408 minibuffer.prototype.check_state = function (type) {
409 var s = this.current_state;
410 if (!(s instanceof type))
411 throw new Error("Invalid minibuffer state.");
415 minibuffer.prototype.show_wait_message = function (initial_message, cleanup_function) {
416 var s = new minibuffer_message_state(this, minibuffer_message_keymap, initial_message, cleanup_function);
421 minibuffer.prototype.wait_for = function (message, coroutine) {
422 var cc = yield CONTINUATION;
424 var s = this.show_wait_message(message, function () { if (!done) cc.throw(abort()); });
427 result = yield coroutine;
430 this.remove_state(s);
432 yield co_return(result);
436 // This should only be used for minibuffer states where it makes
437 // sense. In particular, it should not be used if additional cleanup
439 function minibuffer_abort (window) {
440 var m = window.minibuffer;
441 var s = m.current_state;
443 throw "Invalid minibuffer state";
445 input_sequence_abort.call(window);
447 interactive("minibuffer-abort", null, function (I) { minibuffer_abort(I.window); });
450 provide("minibuffer");