modules/minibuffer-read.js

   1 /**
   2  * (C) Copyright 2007-2010 John J. Foerch
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  *
   5  * Use, modification, and distribution are subject to the terms specified in the
   6  * COPYING file.
   7 **/
   8
   9 in_module(null);
  10
  11 define_variable("default_minibuffer_auto_complete_delay", 150,
  12     "Delay (in milliseconds) after the most recent key-stroke "+
  13     "before auto-completing.");
  14
  15 define_variable("minibuffer_auto_complete_preferences", {});
  16
  17 define_variable("minibuffer_auto_complete_default", false,
  18     "Boolean specifying whether to auto-complete by default. "+
  19     "The user variable `minibuffer_auto_complete_preferences' "+
  20     "overrides this.");
  21
  22 var minibuffer_history_data = {};
  23
  24 /* FIXME: These should possibly be saved to disk somewhere */
  25 define_variable("minibuffer_history_max_items", 100,
  26     "Maximum number of minibuffer history entries stored. Older "+
  27     "history entries are truncated after this limit is reached.");
  28
  29
  30 /* The parameter `args' specifies the arguments.  In addition, the
  31  * arguments for basic_minibuffer_state are also allowed.
  32  *
  33  * history:           [optional] specifies a string to identify the history list to use
  34  *
  35  * completer
  36  *
  37  * match_required
  38  *
  39  * default_completion  only used if match_required is set to true
  40  *
  41  * $valiator          [optional]
  42  *          specifies a function
  43  */
  44 define_keywords("$keymap", "$history", "$validator",
  45                 "$completer", "$match_required", "$default_completion",
  46                 "$auto_complete", "$auto_complete_initial", "$auto_complete_conservative",
  47                 "$auto_complete_delay",
  48                 "$space_completes");
  49 /* FIXME: support completing in another thread */
  50 function text_entry_minibuffer_state (minibuffer, continuation) {
  51     keywords(arguments, $keymap = minibuffer_keymap);
  52
  53     basic_minibuffer_state.call(this, minibuffer, forward_keywords(arguments));
  54
  55     this.continuation = continuation;
  56     if (arguments.$history) {
  57         this.history = minibuffer_history_data[arguments.$history] =
  58             minibuffer_history_data[arguments.$history] || [];
  59         this.history_index = -1;
  60         this.saved_last_history_entry = null;
  61     }
  62
  63     this.validator = arguments.$validator;
  64
  65     if (arguments.$completer != null) {
  66         this.completer = arguments.$completer;
  67         let auto = arguments.$auto_complete;
  68         while (typeof(auto) == "string")
  69             auto = minibuffer_auto_complete_preferences[auto];
  70         if (auto == null)
  71             auto = minibuffer_auto_complete_default;
  72         this.auto_complete = auto;
  73         this.auto_complete_initial = !!arguments.$auto_complete_initial;
  74         this.auto_complete_conservative = !!arguments.$auto_complete_conservative;
  75         let delay = arguments.$auto_complete_delay;
  76         if (delay == null)
  77             delay = default_minibuffer_auto_complete_delay;
  78         this.auto_complete_delay = delay;
  79         this.completions = null;
  80         this.completions_valid = false;
  81         this.space_completes = !!arguments.$space_completes;
  82         this.completions_timer_ID = null;
  83         this.completions_display_element = null;
  84         this.selected_completion_index = -1;
  85         this.match_required  = !!arguments.$match_required;
  86         this.match_required_default = this.match_required;
  87         if (this.match_required)
  88             this.default_completion = arguments.$default_completion;
  89     }
  90 }
  91
  92 function completions_tree_view (minibuffer_state) {
  93     this.minibuffer_state = minibuffer_state;
  94 }
  95
  96 var atom_service = Cc["@mozilla.org/atom-service;1"].getService(Ci.nsIAtomService);
  97
  98 completions_tree_view.prototype = {
  99     constructor: completions_tree_view,
 100     get rowCount () {
 101         var c = this.minibuffer_state.completions;
 102         if (!c)
 103             return 0;
 104         return c.count;
 105     },
 106     getCellText: function (row,column) {
 107         var c = this.minibuffer_state.completions;
 108         if (row >= c.count)
 109             return null;
 110         if (column.index == 0)
 111             return c.get_string(row);
 112         if (c.get_description)
 113             return c.get_description(row);
 114         return "";
 115     },
 116     setTree: function (treebox) { this.treebox = treebox; },
 117     isContainer: function (row) { return false; },
 118     isSeparator: function (row) { return false; },
 119     isSorted: function () { return false; },
 120     getLevel: function (row) { return 0; },
 121     getImageSrc: function (row, col) { return null; },
 122     getRowProperties: function (row, props) {},
 123     getCellProperties: function (row, col, props) {
 124         if (col.index == 0)
 125             props.AppendElement(atom_service.getAtom("completion-string"));
 126         else
 127             props.AppendElement(atom_service.getAtom("completion-description"));
 128     },
 129     getColumnProperties: function (colid, col, props) {}
 130 };
 131
 132 // inherit from basic_minibuffer_state
 133 text_entry_minibuffer_state.prototype = {
 134     constructor: text_entry_minibuffer_state,
 135     __proto__: basic_minibuffer_state.prototype,
 136     load: function () {
 137         basic_minibuffer_state.prototype.load.call(this);
 138         var window = this.minibuffer.window;
 139         if (this.completer) {
 140             // Create completion display element if needed
 141             if (!this.completion_element) {
 142                 /* FIXME: maybe use the dom_generator */
 143                 var tree = create_XUL(window, "tree");
 144                 var s = this;
 145                 tree.addEventListener("select", function () {
 146                         s.selected_completion_index = s.completions_display_element.currentIndex;
 147                         s.handle_completion_selected();
 148                     }, true);
 149                 tree.setAttribute("class", "completions");
 150
 151                 tree.setAttribute("rows", "8");
 152
 153                 tree.setAttribute("collapsed", "true");
 154
 155                 tree.setAttribute("hidecolumnpicker", "true");
 156                 tree.setAttribute("hideheader", "true");
 157
 158                 var treecols = create_XUL(window, "treecols");
 159                 tree.appendChild(treecols);
 160                 var treecol = create_XUL(window, "treecol");
 161                 treecol.setAttribute("flex", "1");
 162                 treecols.appendChild(treecol);
 163                 treecol = create_XUL(window, "treecol");
 164                 treecol.setAttribute("flex", "1");
 165                 treecols.appendChild(treecol);
 166                 tree.appendChild(create_XUL(window, "treechildren"));
 167
 168                 this.minibuffer.insert_before(tree);
 169                 tree.view = new completions_tree_view(this);
 170                 this.completions_display_element = tree;
 171
 172                 /* This is the initial loading of this minibuffer
 173                  * state.  If this.complete_initial is true, generate
 174                  * completions. */
 175                 if (this.auto_complete_initial)
 176                     this.handle_input();
 177             }
 178             this.update_completions_display();
 179         }
 180     },
 181
 182     unload: function () {
 183         if (this.completions_display_element)
 184             this.completions_display_element.setAttribute("collapsed", "true");
 185         basic_minibuffer_state.prototype.unload.call(this);
 186     },
 187
 188     destroy: function () {
 189         if (this.completions != null && this.completions.destroy)
 190             this.completions.destroy();
 191         delete this.completions;
 192         if (this.completions_cont)
 193             this.completions_cont.throw(abort());
 194         delete this.completions_cont;
 195
 196         var el = this.completions_display_element;
 197         if (el) {
 198             el.parentNode.removeChild(el);
 199             this.completions_display_element = null;
 200         }
 201         if (this.continuation)
 202             this.continuation.throw(abort());
 203         basic_minibuffer_state.prototype.destroy.call(this);
 204     },
 205
 206     handle_input: function () {
 207         if (!this.completer) return;
 208
 209         this.completions_valid = false;
 210
 211         if (!this.auto_complete) return;
 212
 213         var s = this;
 214         var window = this.minibuffer.window;
 215
 216         if (this.auto_complete_delay > 0) {
 217             if (this.completions_timer_ID != null)
 218                 window.clearTimeout(this.completions_timer_ID);
 219             this.completions_timer_ID = window.setTimeout(
 220                 function () {
 221                     s.completions_timer_ID = null;
 222                     s.update_completions(true /* auto */, true /* update completions display */);
 223                 }, this.auto_complete_delay);
 224             return;
 225         }
 226         s.update_completions(true /* auto */, true /* update completions display */);
 227     },
 228
 229     ran_minibuffer_command: function () {
 230         this.handle_input();
 231     },
 232
 233     update_completions_display: function () {
 234         var m = this.minibuffer;
 235         if (m.current_state == this) {
 236             if (this.completions && this.completions.count > 0) {
 237                 this.completions_display_element.view = this.completions_display_element.view;
 238                 this.completions_display_element.setAttribute("collapsed", "false");
 239
 240                 this.completions_display_element.currentIndex = this.selected_completion_index;
 241                 this.completions_display_element.treeBoxObject.scrollToRow(this.selected_completion_index);
 242             } else {
 243                 this.completions_display_element.setAttribute("collapsed", "true");
 244             }
 245         }
 246     },
 247
 248     /* If auto is true, this update is due to auto completion, rather
 249      * than specifically requested. */
 250     update_completions: function (auto, update_display) {
 251         var window = this.minibuffer.window;
 252         if (this.completions_timer_ID != null) {
 253             window.clearTimeout(this.completions_timer_ID);
 254             this.completions_timer_ID = null;
 255         }
 256
 257         let m = this.minibuffer;
 258
 259         if (this.completions_cont) {
 260             this.completions_cont.throw(abort());
 261             this.completions_cont = null;
 262         }
 263
 264         let c = this.completer(m._input_text, m._selection_start,
 265                                auto && this.auto_complete_conservative);
 266
 267         if (is_coroutine(c)) {
 268             let s = this;
 269             let already_done = false;
 270             this.completions_cont = co_call(function () {
 271                 var x;
 272                 try {
 273                     x = yield c;
 274                 } catch (e) {
 275                     handle_interactive_error(window, e);
 276                 } finally {
 277                     s.completions_cont = null;
 278                     already_done = true;
 279                 }
 280                 s.update_completions_done(x, update_display);
 281             }());
 282
 283             // In case the completer actually already finished
 284             if (already_done)
 285                 this.completions_cont = null;
 286             return;
 287         } else
 288             this.update_completions_done(c, update_display);
 289     },
 290
 291     update_completions_done: function (c, update_display) {
 292         /* The completer should return undefined if completion was not
 293          * attempted due to auto being true.  Otherwise, it can return
 294          * null to indicate no completions. */
 295         if (this.completions != null && this.completions.destroy)
 296             this.completions.destroy();
 297
 298         this.completions = c;
 299         this.completions_valid = true;
 300         this.applied_common_prefix = false;
 301
 302         if (c && ("get_match_required" in c))
 303             this.match_required = c.get_match_required();
 304         if (this.match_required == null)
 305             this.match_required = this.match_required_default;
 306
 307         let i = -1;
 308         if (c && c.count > 0) {
 309             if (this.match_required) {
 310                 if (c.count == 1)
 311                     i = 0;
 312                 else if (c.default_completion != null)
 313                     i = c.default_completion;
 314                 else if (this.default_completion && this.completions.index_of)
 315                     i = this.completions.index_of(this.default_completion);
 316             }
 317             this.selected_completion_index = i;
 318         }
 319
 320         if (update_display)
 321             this.update_completions_display();
 322     },
 323
 324     select_completion: function (i) {
 325         this.selected_completion_index = i;
 326         this.completions_display_element.currentIndex = i;
 327         if (i >= 0)
 328             this.completions_display_element.treeBoxObject.ensureRowIsVisible(i);
 329         this.handle_completion_selected();
 330     },
 331
 332     handle_completion_selected: function () {
 333         /**
 334          * When a completion is selected, apply it to the input text
 335          * if a match is not "required"; otherwise, the completion is
 336          * only displayed.
 337          */
 338         var i = this.selected_completion_index;
 339         var m = this.minibuffer;
 340         var c = this.completions;
 341
 342         if (this.completions_valid && c && !this.match_required && i >= 0 && i < c.count)
 343             m.set_input_state(c.get_input_state(i));
 344     }
 345 };
 346
 347 function minibuffer_complete (window, count) {
 348     var m = window.minibuffer;
 349     var s = m.current_state;
 350     if (!(s instanceof text_entry_minibuffer_state))
 351         throw new Error("Invalid minibuffer state");
 352     if (!s.completer)
 353         return;
 354     var just_completed_manually = false;
 355     if (!s.completions_valid || s.completions === undefined) {
 356         if (s.completions_timer_ID == null)
 357             just_completed_manually = true;
 358         s.update_completions(false /* not auto */, true /* update completions display */);
 359
 360         // If the completer is a coroutine, nothing we can do here
 361         if (!s.completions_valid)
 362             return;
 363     }
 364
 365     var c = s.completions;
 366
 367     if (!c || c.count == 0)
 368         return;
 369
 370     var e = s.completions_display_element;
 371     var new_index = -1;
 372
 373     let common_prefix;
 374
 375     if (count == 1 && !s.applied_common_prefix && (common_prefix = c.common_prefix_input_state)) {
 376         m.set_input_state(common_prefix);
 377         s.applied_common_prefix = true;
 378     } else if (!just_completed_manually) {
 379         if (e.currentIndex != -1) {
 380             new_index = (e.currentIndex + count) % c.count;
 381             if (new_index < 0)
 382                 new_index += c.count;
 383         } else {
 384             new_index = (count - 1) % c.count;
 385             if (new_index < 0)
 386                 new_index += c.count;
 387         }
 388     }
 389
 390     if (new_index != -1)
 391         s.select_completion(new_index);
 392 }
 393 interactive("minibuffer-complete", null,
 394     function (I) { minibuffer_complete(I.window, I.p); });
 395 interactive("minibuffer-complete-previous", null,
 396     function (I) { minibuffer_complete(I.window, -I.p); });
 397
 398 function exit_minibuffer (window) {
 399     var m = window.minibuffer;
 400     var s = m.current_state;
 401     if (!(s instanceof text_entry_minibuffer_state))
 402         throw new Error("Invalid minibuffer state");
 403
 404     var val = m._input_text;
 405
 406     if (s.validator != null && !s.validator(val, m))
 407         return;
 408
 409     var match = null;
 410
 411     if (s.completer && s.match_required) {
 412         if (!s.completions_valid || s.completions === undefined)
 413             s.update_completions(false /* not conservative */, false /* don't update */);
 414
 415         let c = s.completions;
 416         let i = s.selected_completion_index;
 417         if (c != null && i >= 0 && i < c.count) {
 418             if (c.get_value != null)
 419                 match = c.get_value(i);
 420             else
 421                 match = c.get_string(i);
 422         } else {
 423             m.message("No match");
 424             return;
 425         }
 426     }
 427
 428     if (s.history) {
 429         s.history.push(val);
 430         if (s.history.length > minibuffer_history_max_items)
 431             s.history.splice(0, s.history.length - minibuffer_history_max_items);
 432     }
 433     var cont = s.continuation;
 434     delete s.continuation;
 435     m.pop_state();
 436     if (cont) {
 437         if (s.match_required)
 438             cont(match);
 439         else
 440             cont(val);
 441     }
 442 }
 443 interactive("exit-minibuffer", null,
 444     function (I) { exit_minibuffer(I.window); });
 445
 446 function minibuffer_history_next (window, count) {
 447     var m = window.minibuffer;
 448     var s = m.current_state;
 449     if (!(s instanceof text_entry_minibuffer_state))
 450         throw new Error("Invalid minibuffer state");
 451     if (!s.history || s.history.length == 0)
 452         throw interactive_error("No history available.");
 453     if (count == 0)
 454         return;
 455     var index = s.history_index;
 456     if (count > 0 && index == -1)
 457         throw interactive_error("End of history; no next item");
 458     else if (count < 0 && index == 0)
 459         throw interactive_error("Beginning of history; no preceding item");
 460     if (index == -1) {
 461         s.saved_last_history_entry = m._input_text;
 462         index = s.history.length + count;
 463     } else
 464         index = index + count;
 465
 466     if (index < 0)
 467         index = 0;
 468
 469     m._restore_normal_state();
 470     if (index >= s.history.length) {
 471         index = -1;
 472         m._input_text = s.saved_last_history_entry;
 473     } else {
 474         m._input_text = s.history[index];
 475     }
 476     s.history_index = index;
 477     m._set_selection();
 478     s.handle_input();
 479 }
 480 interactive("minibuffer-history-next", null,
 481     function (I) { minibuffer_history_next(I.window, I.p); });
 482 interactive("minibuffer-history-previous", null,
 483     function (I) { minibuffer_history_next(I.window, -I.p); });
 484
 485 // Define the asynchronous minibuffer.read function
 486 minibuffer.prototype.read = function () {
 487     var s = new text_entry_minibuffer_state(this, (yield CONTINUATION), forward_keywords(arguments));
 488     this.push_state(s);
 489     var result = yield SUSPEND;
 490     yield co_return(result);
 491 };
 492
 493 minibuffer.prototype.read_command = function () {
 494     keywords(
 495         arguments,
 496         $prompt = "Command", $history = "command",
 497         $completer = prefix_completer(
 498             $completions = function (visitor) interactive_commands.for_each_value(visitor),
 499             $get_string = function (x) x.name,
 500             $get_description = function (x) x.shortdoc || "",
 501             $get_value = function (x) x.name),
 502         $match_required = true);
 503     var result = yield this.read(forward_keywords(arguments));
 504     yield co_return(result);
 505 };
 506
 507 minibuffer.prototype.read_user_variable = function () {
 508     keywords(
 509         arguments,
 510         $prompt = "User variable", $history = "user_variable",
 511         $completer = prefix_completer(
 512             $completions = function (visitor) {
 513                 for (var i in user_variables) visitor(i);
 514             },
 515             $get_string = function (x) x,
 516             $get_description = function (x) user_variables[x].shortdoc || "",
 517             $get_value = function (x) x),
 518         $match_required = true);
 519     var result = yield this.read(forward_keywords(arguments));
 520     yield co_return(result);
 521 };
 522
 523 minibuffer.prototype.read_preference = function () {
 524     keywords(arguments,
 525              $prompt = "Preference:", $history = "preference",
 526              $completer = prefix_completer(
 527                  $completions = preferences.getBranch(null).getChildList("", {}),
 528                  $get_description = function (pref) {
 529                      let default_value = get_default_pref(pref);
 530                      let value = get_pref(pref);
 531                      if (value == default_value)
 532                          value = null;
 533                      let type;
 534                      switch (preferences.getBranch(null).getPrefType(pref)) {
 535                      case Ci.nsIPrefBranch.PREF_STRING:
 536                          type = "string";
 537                          break;
 538                      case Ci.nsIPrefBranch.PREF_INT:
 539                          type = "int";
 540                          break;
 541                      case Ci.nsIPrefBranch.PREF_BOOL:
 542                          type = "boolean";
 543                          break;
 544                      }
 545                      let out = type + ":";
 546                      if (value != null)
 547                          out += " " + pretty_print_value(value);
 548                      if (default_value != null)
 549                          out += " (" + pretty_print_value(default_value) + ")";
 550                      return out;
 551                  }),
 552              $match_required = true);
 553     var result = yield this.read(forward_keywords(arguments));
 554     yield co_return(result);
 555 };
 556
 557 provide("minibuffer-read");