modules/minibuffer.js

   1
   2 /* This should only be used for minibuffer states where it makes
   3  * sense.  In particular, it should not be used if additional cleanup
   4  * must be done. */
   5 function minibuffer_abort (window)
   6 {
   7     var m = window.minibuffer;
   8     var s = m.current_state;
   9     if (s == null)
  10         throw "Invalid minibuffer state";
  11     m.pop_state();
  12 }
  13 interactive("minibuffer-abort", function (I) {minibuffer_abort(I.window);});
  14
  15 define_builtin_commands(
  16     "minibuffer-",
  17     function (I, command) {
  18         try {
  19             var m = I.minibuffer;
  20             if (m._input_mode_enabled)
  21             {
  22                 m._restore_normal_state();
  23                 var e = m.input_element;
  24                 var c = e.controllers.getControllerForCommand(command);
  25                 try {
  26                     m.ignore_input_events = true;
  27                     if (c && c.isCommandEnabled(command))
  28                         c.doCommand(command);
  29                 } finally {
  30                     m.ignore_input_events = false;
  31                 }
  32                 var s = m.current_state;
  33                 let x = s.ran_minibuffer_command;
  34                 if (x)
  35                     x(command);
  36             }
  37         } catch (e)
  38         {
  39             /* Ignore exceptions. */
  40         }
  41     },
  42     function (I) {
  43         I.minibuffer.current_state.mark_active = !I.minibuffer.current_state.mark_active;
  44     },
  45
  46     function (I) I.minibuffer.current_state.mark_active
  47 );
  48
  49 function minibuffer_state(keymap, use_input_mode)
  50 {
  51     this.keymap = keymap;
  52     this.use_input_mode = use_input_mode;
  53 }
  54 minibuffer_state.prototype.load = function () {}
  55 minibuffer_state.prototype.unload = function () {}
  56 minibuffer_state.prototype.destroy = function () {}
  57
  58 function minibuffer_message_state(keymap, message, destroy_function)
  59 {
  60     minibuffer_state.call(this, keymap, false);
  61     this._message = message;
  62     if (destroy_function)
  63         this.destroy = destroy_function;
  64 }
  65 minibuffer_message_state.prototype = {
  66     __proto__: minibuffer_state.prototype,
  67     load : function (window) {
  68         this.window = window;
  69     },
  70     unload : function (window) {
  71         this.window = null;
  72     },
  73     get message () { return this._message; },
  74     set message (x) {
  75         if (this.window) {
  76             this.window.minibuffer._restore_normal_state();
  77             this.window.minibuffer._show(this._message);
  78         }
  79     }
  80 };
  81
  82 function minibuffer_input_state(keymap, prompt, input, selection_start, selection_end)
  83 {
  84     this.prompt = prompt;
  85     if (input)
  86         this.input = input;
  87     else
  88         this.input = "";
  89     if (selection_start)
  90         this.selection_start = selection_start;
  91     else
  92         this.selection_start = 0;
  93     if (selection_end)
  94         this.selection_end = selection_end;
  95     else
  96         this.selection_end = this.selection_start;
  97
  98     minibuffer_state.call(this, keymap, true);
  99 }
 100 minibuffer_input_state.prototype.__proto__ = minibuffer_state.prototype;
 101
 102
 103 /**
 104  * The parameter `args' is an object specifying the arguments for
 105  * basic_minibuffer_state.  The following properties of args must/may
 106  * be set:
 107  *
 108  * prompt:            [required]
 109  *
 110  * initial_value:     [optional] specifies the initial text
 111  *
 112  * select:            [optional] specifies to select the initial text if set to non-null
 113  */
 114 define_keywords("$prompt", "$initial_value", "$select");
 115 function basic_minibuffer_state()
 116 {
 117     keywords(arguments);
 118     var initial_value = arguments.$initial_value || "";
 119     var sel_start, sel_end;
 120     if (arguments.$select)
 121     {
 122         sel_start = 0;
 123         sel_end = initial_value.length;
 124     } else {
 125         sel_start = sel_end = initial_value.length;
 126     }
 127     minibuffer_input_state.call(this, minibuffer_base_keymap,
 128                                 arguments.$prompt, initial_value,
 129                                 sel_start, sel_end);
 130 }
 131 basic_minibuffer_state.prototype.__proto__ = minibuffer_input_state.prototype; // inherit from minibuffer_state
 132
 133 define_variable("minibuffer_input_mode_show_message_timeout", 1000, "Time duration (in milliseconds) to flash minibuffer messages while in minibuffer input mode.");
 134
 135 function minibuffer (window)
 136 {
 137     this.element = window.document.getElementById("minibuffer");
 138     this.output_element = window.document.getElementById("minibuffer-message");
 139     this.input_prompt_element = window.document.getElementById("minibuffer-prompt");
 140     this.input_element = window.document.getElementById("minibuffer-input");
 141     var m = this;
 142     this.input_element.inputField.addEventListener("blur", function() {
 143             if (m.active && m._input_mode_enabled && !m._showing_message)
 144             {
 145                 window.setTimeout(
 146                     function(){
 147                         m.input_element.inputField.focus();
 148                     }, 0);
 149             }
 150         }, false);
 151     this.input_element.addEventListener("input", function(e) {
 152         if (m.ignore_input_events || !m._input_mode_enabled)
 153             return;
 154         var s = m.current_state;
 155         if (s) {
 156             if (s.handle_input)
 157                 s.handle_input(m);
 158         }
 159     }, true);
 160
 161     // Ensure that the input area will have focus if a message is
 162     // currently being flashed so that the default handler for key
 163     // events will properly add text to the input area.
 164     window.addEventListener("keydown", function (e) {
 165         if (m._input_mode_enabled && m._showing_message)
 166             m._restore_normal_state();
 167     }, true);
 168     this.window = window;
 169     this.last_message = "";
 170     this.states = [];
 171 }
 172
 173 minibuffer.prototype = {
 174     constructor : minibuffer.constructor,
 175     get _selection_start () { return this.input_element.selectionStart; },
 176     get _selection_end () { return this.input_element.selectionEnd; },
 177     get _input_text () { return this.input_element.value; },
 178     set _input_text (text) { this.input_element.value = text; },
 179     get prompt () { return this.input_prompt_element.value; },
 180     set prompt (s) { this.input_prompt_element.value = s; },
 181
 182     _set_selection : function (start, end) {
 183         if (start == null)
 184             start = this._input_text.length;
 185         if (end == null)
 186             end = this._input_text.length;
 187         this.input_element.setSelectionRange(start,end);
 188     },
 189
 190     /* Saved focus state */
 191     saved_focused_frame : null,
 192     saved_focused_element : null,
 193
 194     default_message : "",
 195
 196     current_message : null,
 197
 198     /* This method will display the specified string in the
 199      * minibuffer, without recording it in any log/Messages buffer. */
 200     show : function (str, force) {
 201         if (!this.active || force) {
 202             this.current_message = str;
 203             this._show(str);
 204         }
 205     },
 206
 207     _show : function (str, force) {
 208         if (this.last_message != str)
 209         {
 210             this.output_element.value = str;
 211             this.last_message = str;
 212         }
 213     },
 214
 215     message : function (str) {
 216         /* TODO: add the message to a *Messages* buffer, and/or
 217          * possibly dump them to the console. */
 218         this.show(str, true /* force */);
 219
 220         if (str.length > 0 && this.active)
 221             this._flash_temporary_message();
 222     },
 223     clear : function () {
 224         this.current_message = null;
 225         if (!this.active)
 226             this._show(this.default_message);
 227     },
 228
 229     set_default_message : function (str) {
 230         this.default_message = str;
 231         if (this.current_message == null)
 232             this._show(str);
 233     },
 234
 235     get current_state () {
 236         if (this.states.length == 0)
 237             return null;
 238         return this.states[this.states.length - 1];
 239     },
 240
 241     push_state : function (state) {
 242         this._save_state();
 243         this.states.push(state);
 244         this._restore_state();
 245         state.load(this.window);
 246     },
 247
 248     pop_state : function () {
 249         this.current_state.destroy();
 250         this.states.pop();
 251         this._restore_state();
 252     },
 253
 254     pop_all : function () {
 255         while (this.states.length > 0) {
 256             this.current_state.destroy();
 257             this.states.pop();
 258         }
 259     },
 260
 261     remove_state : function (state) {
 262         var i = this.states.indexOf(state);
 263         var was_current = (i == this.states.length);
 264         state.destroy();
 265         this.states.splice(i, 1);
 266         if (was_current)
 267             this._restore_state();
 268     },
 269
 270     _input_mode_enabled : false,
 271
 272     active : false,
 273
 274     /* If _input_mode_enabled is true, this is set to indicate that
 275      * the message area is being temporarily shown instead of the
 276      * input box. */
 277     _showing_message : false,
 278
 279     _message_timer_ID : null,
 280
 281     /* This must only be called if _input_mode_enabled is true */
 282     _restore_normal_state : function () {
 283         if (this._showing_message)
 284         {
 285             this.window.clearTimeout(this._message_timer_ID);
 286             this._message_timer_ID = null;
 287             this._showing_message = false;
 288
 289             if (this._input_mode_enabled)
 290                 this._switch_to_input_mode();
 291             else
 292                 this._show(this.current_state._message);
 293         }
 294     },
 295
 296     /* This must only be called if _input_mode_enabled is true */
 297     _flash_temporary_message : function () {
 298         if (this._showing_message)
 299             this.window.clearTimeout(this._message_timer_ID);
 300         else {
 301             this._showing_message = true;
 302             if (this._input_mode_enabled)
 303                 this._switch_to_message_mode();
 304         }
 305         var obj = this;
 306         this._message_timer_ID = this.window.setTimeout(function(){
 307             obj._restore_normal_state();
 308         }, minibuffer_input_mode_show_message_timeout);
 309     },
 310
 311     _switch_to_input_mode : function () {
 312         this.element.setAttribute("minibuffermode", "input");
 313         this.input_element.inputField.focus();
 314     },
 315
 316     _switch_to_message_mode : function () {
 317         this.element.setAttribute("minibuffermode", "message");
 318     },
 319
 320     _restore_state : function () {
 321         var s = this.current_state;
 322         var want_input_mode = false;
 323         if (s) {
 324             if (!this.active) {
 325                 this.saved_focused_frame = this.window.document.commandDispatcher.focusedWindow;
 326                 this.saved_focused_element = this.window.document.commandDispatcher.focusedElement;
 327             }
 328             if (s.use_input_mode) {
 329                 want_input_mode = true;
 330                 this._input_text = s.input;
 331                 this.prompt = s.prompt;
 332                 this._set_selection(s.selection_start, s.selection_end);
 333             } else {
 334                 this._show(s._message);
 335             }
 336             this.window.keyboard.set_override_keymap(s.keymap);
 337             this.active = true;
 338         } else {
 339             if (this.active) {
 340                 this.active = false;
 341                 this.window.keyboard.set_override_keymap(null);
 342                 if (this.saved_focused_element)
 343                     set_focus_no_scroll(this.window, this.saved_focused_element);
 344                 else if (this.saved_focused_frame)
 345                     set_focus_no_scroll(this.window, this.saved_focused_frame);
 346                 this.saved_focused_element = null;
 347                 this.saved_focused_frame = null;
 348                 this._show(this.current_message || this.default_message);
 349             }
 350         }
 351         var in_input_mode = this._input_mode_enabled && !this._showing_message;
 352         if (this._showing_message) {
 353             this.window.clearTimeout(this._message_timer_ID);
 354             this._message_timer_ID = null;
 355             this._showing_message = false;
 356         }
 357         if (want_input_mode && !in_input_mode)
 358             this._switch_to_input_mode();
 359         else if (!want_input_mode && in_input_mode)
 360             this._switch_to_message_mode();
 361         this._input_mode_enabled = want_input_mode;
 362     },
 363
 364     _save_state : function () {
 365         var s = this.current_state;
 366         if (s)
 367         {
 368             if (s.use_input_mode) {
 369                 s.input = this._input_text;
 370                 s.prompt = this.prompt;
 371                 s.selection_start = this._selection_start;
 372                 s.selection_end = this._selection_end;
 373             }
 374             s.unload(this.window);
 375         }
 376     },
 377
 378     insert_before : function (element) {
 379         this.element.parentNode.insertBefore(element, this.element);
 380     }
 381 };
 382
 383 function minibuffer_initialize_window(window)
 384 {
 385     window.minibuffer = new minibuffer(window);
 386 }
 387
 388 add_hook("window_initialize_early_hook", minibuffer_initialize_window);
 389
 390 function minibuffer_window_close_handler(window) {
 391     window.minibuffer.pop_all();
 392 }
 393 add_hook("window_close_hook", minibuffer_window_close_handler);
 394
 395 /* Note: This is concise, but doesn't seem to be useful in practice,
 396  * because nothing can be done with the state alone. */
 397 minibuffer.prototype.check_state = function(type) {
 398     var s = this.current_state;
 399     if (!(s instanceof type))
 400         throw new Error("Invalid minibuffer state.");
 401     return s;
 402 };
 403
 404 minibuffer.prototype.show_wait_message = function (initial_message, destroy_function) {
 405     var s = new minibuffer_message_state(minibuffer_message_keymap, initial_message, destroy_function);
 406     this.push_state(s);
 407     return s;
 408 };