modules/hints.js

   1 /**
   2  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   3  * (C) Copyright 2009-2010 John J. Foerch
   4  *
   5  * Portions of this file are derived from Vimperator,
   6  * (C) Copyright 2006-2007 Martin Stubenschrott.
   7  *
   8  * Use, modification, and distribution are subject to the terms specified in the
   9  * COPYING file.
  10 **/
  11
  12 define_variable("active_img_hint_background_color", "#88FF00",
  13     "Color for the active image hint background.");
  14
  15 define_variable("img_hint_background_color", "yellow",
  16     "Color for inactive image hint backgrounds.");
  17
  18 define_variable("active_hint_background_color", "#88FF00",
  19     "Color for the active hint background.");
  20
  21 define_variable("hint_background_color", "yellow",
  22     "Color for the inactive hint.");
  23
  24
  25 define_variable("hint_digits", null,
  26     "Null or a string of the digits to use as the counting base "+
  27     "for hint numbers, starting with the digit that represents zero "+
  28     "and ascending.  If null, base 10 will be used with the normal "+
  29     "hindu-arabic numerals.");
  30
  31
  32 /**
  33  * hints_enumerate is a generator of natural numbers in the base defined
  34  * by hint_digits.
  35  */
  36 function hints_enumerate () {
  37     var base = hint_digits.length;
  38     var n = [1];
  39     var p = 1;
  40     while (true) {
  41         yield n.map(function (x) hint_digits[x]).join("");
  42         var i = p-1;
  43         n[i]++;
  44         while (n[i] >= base && i > 0) {
  45             n[i] = 0;
  46             n[--i]++;
  47         }
  48         if (n[0] >= base) {
  49             n[0] = 0;
  50             n.unshift(1);
  51             p++;
  52         }
  53     }
  54 }
  55
  56 /**
  57  * hints_parse converts a string that represents a natural number to an
  58  * int.  When hint_digits is non-null, it defines the base for conversion.
  59  */
  60 function hints_parse (str) {
  61     if (hint_digits) {
  62         var base = hint_digits.length;
  63         var n = 0;
  64         for (var i = 0, p = str.length - 1; p >= 0; i++, p--) {
  65             n += hint_digits.indexOf(str[i]) * Math.pow(base, p);
  66         }
  67         return n;
  68     } else
  69         return parseInt(str);
  70 }
  71
  72 /**
  73  * Register hints style sheet
  74  */
  75 const hints_stylesheet = "chrome://conkeror-gui/content/hints.css";
  76 register_user_stylesheet(hints_stylesheet);
  77
  78
  79 function hints_simple_text_match (text, pattern) {
  80     var pos = text.indexOf(pattern);
  81     if (pos == -1)
  82         return false;
  83     return [pos, pos + pattern.length];
  84 }
  85
  86 define_variable('hints_text_match', hints_simple_text_match,
  87     "A function which takes a string and a pattern (another string) "+
  88     "and returns an array of [start, end] indices if the pattern was "+
  89     "found in the string, or false if it was not.");
  90
  91
  92 /**
  93  *   In the hints interaction, a node can be selected either by typing
  94  * the number of its associated hint, or by typing substrings of the
  95  * text content of the node.  In the case of selecting by text
  96  * content, multiple substrings can be given by separating them with
  97  * spaces.
  98  */
  99 function hint_manager (window, xpath_expr, focused_frame, focused_element) {
 100     this.window = window;
 101     this.hints = [];
 102     this.valid_hints = [];
 103     this.xpath_expr = xpath_expr;
 104     this.focused_frame = focused_frame;
 105     this.focused_element = focused_element;
 106     this.last_selected_hint = null;
 107
 108     // Generate
 109     this.generate_hints();
 110 }
 111 hint_manager.prototype = {
 112     constructor: hint_manager,
 113     current_hint_string: "",
 114     current_hint_number: -1,
 115
 116     /**
 117      * Create an initially hidden hint span element absolutely
 118      * positioned over each element that matches
 119      * hint_xpath_expression.  This is done recursively for all frames
 120      * and iframes.  Information about the resulting hints are also
 121      * stored in the hints array.
 122      */
 123     generate_hints: function () {
 124         var topwin = this.window;
 125         var top_height = topwin.innerHeight;
 126         var top_width = topwin.innerWidth;
 127         var hints = this.hints;
 128         var xpath_expr = this.xpath_expr;
 129         var focused_frame_hint = null, focused_element_hint = null;
 130         var focused_frame = this.focused_frame;
 131         var focused_element = this.focused_element;
 132
 133         function helper (window, offsetX, offsetY) {
 134             var win_height = window.height;
 135             var win_width = window.width;
 136
 137             // Bounds
 138             var minX = offsetX < 0 ? -offsetX : 0;
 139             var minY = offsetY < 0 ? -offsetY : 0;
 140             var maxX = offsetX + win_width > top_width ? top_width - offsetX : top_width;
 141             var maxY = offsetY + win_height > top_height ? top_height - offsetY : top_height;
 142
 143             var scrollX = window.scrollX;
 144             var scrollY = window.scrollY;
 145
 146             var doc = window.document;
 147             if (! doc.documentElement)
 148                 return;
 149             var res = doc.evaluate(xpath_expr, doc, xpath_lookup_namespace,
 150                                    Ci.nsIDOMXPathResult.UNORDERED_NODE_SNAPSHOT_TYPE,
 151                                    null /* existing results */);
 152
 153             var base_node = doc.createElementNS(XHTML_NS, "span");
 154             base_node.className = "__conkeror_hint";
 155
 156             var fragment = doc.createDocumentFragment();
 157             var rect, elem, text, node, show_text;
 158             for (var j = 0; j < res.snapshotLength; j++) {
 159                 elem = res.snapshotItem(j);
 160                 rect = elem.getBoundingClientRect();
 161                 if (elem instanceof Ci.nsIDOMHTMLAreaElement) {
 162                     rect = { top: rect.top,
 163                              left: rect.left,
 164                              bottom: rect.bottom,
 165                              right: rect.right };
 166                     try {
 167                         var coords = elem.getAttribute("coords")
 168                             .match(/^\D*(-?\d+)\D+(-?\d+)/);
 169                         if (coords.length == 3) {
 170                             rect.left += parseInt(coords[1]);
 171                             rect.top += parseInt(coords[2]);
 172                         }
 173                     } catch (e) {}
 174                 }
 175                 if (!rect || rect.left > maxX || rect.right < minX || rect.top > maxY || rect.bottom < minY)
 176                     continue;
 177                 let style = topwin.getComputedStyle(elem, "");
 178                 if (style.display == "none" || style.visibility == "hidden")
 179                     continue;
 180                 if (! (elem instanceof Ci.nsIDOMHTMLAreaElement))
 181                     rect = elem.getClientRects()[0];
 182                 if (!rect)
 183                     continue;
 184                 var nchildren = elem.childNodes.length;
 185                 if (elem instanceof Ci.nsIDOMHTMLAnchorElement &&
 186                     rect.width == 0 && rect.height == 0)
 187                 {
 188                     for (var c = 0; c < nchildren; ++c) {
 189                         var cc = elem.childNodes.item(c);
 190                         if (cc.getBoundingClientRect) {
 191                             rect = cc.getBoundingClientRect();
 192                             break;
 193                         }
 194                     }
 195                 }
 196                 show_text = false;
 197                 if (elem instanceof Ci.nsIDOMHTMLInputElement || elem instanceof Ci.nsIDOMHTMLTextAreaElement)
 198                     text = elem.value;
 199                 else if (elem instanceof Ci.nsIDOMHTMLSelectElement) {
 200                     if (elem.selectedIndex >= 0)
 201                         text = elem.item(elem.selectedIndex).text;
 202                     else
 203                         text = "";
 204                 } else if (elem instanceof Ci.nsIDOMHTMLFrameElement) {
 205                     text = elem.name ? elem.name : "";
 206                 } else if (/^\s*$/.test(elem.textContent) &&
 207                            nchildren == 1 &&
 208                            elem.childNodes.item(0) instanceof Ci.nsIDOMHTMLImageElement) {
 209                     text = elem.childNodes.item(0).alt;
 210                     show_text = true;
 211                 } else
 212                     text = elem.textContent;
 213
 214                 node = base_node.cloneNode(true);
 215                 node.style.left = (rect.left + scrollX) + "px";
 216                 node.style.top = (rect.top + scrollY) + "px";
 217                 fragment.appendChild(node);
 218
 219                 let hint = { text: text,
 220                              ltext: text.toLowerCase(),
 221                              elem: elem,
 222                              hint: node,
 223                              img_hint: null,
 224                              visible: false,
 225                              show_text: show_text };
 226                 if (elem.style) {
 227                     hint.saved_color = elem.style.color;
 228                     hint.saved_bgcolor = elem.style.backgroundColor;
 229                 }
 230                 hints.push(hint);
 231
 232                 if (elem == focused_element)
 233                     focused_element_hint = hint;
 234                 else if ((elem instanceof Ci.nsIDOMHTMLFrameElement ||
 235                           elem instanceof Ci.nsIDOMHTMLIFrameElement) &&
 236                          elem.contentWindow == focused_frame)
 237                     focused_frame_hint = hint;
 238             }
 239             doc.documentElement.appendChild(fragment);
 240
 241             /* Recurse into any IFRAME or FRAME elements */
 242             var frametag = "frame";
 243             while (true) {
 244                 var frames = doc.getElementsByTagName(frametag);
 245                 for (var i = 0, nframes = frames.length; i < nframes; ++i) {
 246                     elem = frames[i];
 247                     rect = elem.getBoundingClientRect();
 248                     if (!rect || rect.left > maxX || rect.right < minX || rect.top > maxY || rect.bottom < minY)
 249                         continue;
 250                     helper(elem.contentWindow, offsetX + rect.left, offsetY + rect.top);
 251                 }
 252                 if (frametag == "frame") frametag = "iframe"; else break;
 253             }
 254         }
 255         helper(topwin, 0, 0);
 256         this.last_selected_hint = focused_element_hint || focused_frame_hint;
 257     },
 258
 259     /* Updates valid_hints and also re-numbers and re-displays all hints. */
 260     update_valid_hints: function () {
 261         this.valid_hints = [];
 262         var cur_number = 1;
 263         if (hint_digits)
 264             var number_generator = hints_enumerate();
 265         var active_number = this.current_hint_number;
 266         var tokens = this.current_hint_string.split(" ");
 267         var case_sensitive = (this.current_hint_string !=
 268                               this.current_hint_string.toLowerCase());
 269         var rect, text, img_hint, doc, scrollX, scrollY;
 270     outer:
 271         for (var i = 0, h; (h = this.hints[i]); ++i) {
 272             if (case_sensitive)
 273                 text = h.text;
 274             else
 275                 text = h.ltext;
 276             for (var j = 0, ntokens = tokens.length; j < ntokens; ++j) {
 277                 if (! hints_text_match(text, tokens[j])) {
 278                     if (h.visible) {
 279                         h.visible = false;
 280                         h.hint.style.display = "none";
 281                         if (h.img_hint)
 282                             h.img_hint.style.display = "none";
 283                         if (h.saved_color != null) {
 284                             h.elem.style.backgroundColor = h.saved_bgcolor;
 285                             h.elem.style.color = h.saved_color;
 286                         }
 287                     }
 288                     continue outer;
 289                 }
 290             }
 291
 292             h.visible = true;
 293
 294             if (h == this.last_selected_hint && active_number == -1)
 295                 this.current_hint_number = active_number = cur_number;
 296
 297             var img_elem = null;
 298
 299             if (text == "" && h.elem.firstChild &&
 300                 h.elem.firstChild instanceof Ci.nsIDOMHTMLImageElement)
 301                 img_elem = h.elem.firstChild;
 302             else if (h.elem instanceof Ci.nsIDOMHTMLImageElement)
 303                 img_elem = h.elem;
 304
 305             if (img_elem) {
 306                 if (!h.img_hint) {
 307                     rect = img_elem.getBoundingClientRect();
 308                     if (rect) {
 309                         doc = h.elem.ownerDocument;
 310                         scrollX = doc.defaultView.scrollX;
 311                         scrollY = doc.defaultView.scrollY;
 312                         img_hint = doc.createElementNS(XHTML_NS, "span");
 313                         img_hint.className = "__conkeror_img_hint";
 314                         img_hint.style.left = (rect.left + scrollX) + "px";
 315                         img_hint.style.top = (rect.top + scrollY) + "px";
 316                         img_hint.style.width = (rect.right - rect.left) + "px";
 317                         img_hint.style.height = (rect.bottom - rect.top) + "px";
 318                         h.img_hint = img_hint;
 319                         doc.documentElement.appendChild(img_hint);
 320                     } else
 321                         img_elem = null;
 322                 }
 323                 if (img_elem) {
 324                     var bgcolor = (active_number == cur_number) ?
 325                         active_img_hint_background_color : img_hint_background_color;
 326                     h.img_hint.style.backgroundColor = bgcolor;
 327                     h.img_hint.style.display = "inline";
 328                 }
 329             }
 330
 331             if (!h.img_hint && h.elem.style)
 332                 h.elem.style.backgroundColor = (active_number == cur_number) ?
 333                     active_hint_background_color : hint_background_color;
 334
 335             if (h.elem.style)
 336                 h.elem.style.color = "black";
 337
 338             var label = "";
 339             if (hint_digits)
 340                 label = number_generator.next();
 341             else
 342                 label += cur_number;
 343             if (h.elem instanceof Ci.nsIDOMHTMLFrameElement) {
 344                 label +=  " " + text;
 345             } else if (h.show_text && !/^\s*$/.test(text)) {
 346                 let substrs = [[0,4]];
 347                 for (j = 0; j < ntokens; ++j) {
 348                     let m = hints_text_match(text, tokens[j]);
 349                     if (m == false) continue;
 350                     splice_range(substrs, m[0], m[1] + 2);
 351                 }
 352                 label += " " + substrs.map(function (x) {
 353                     return text.substring(x[0],Math.min(x[1], text.length));
 354                 }).join("..") + "..";
 355             }
 356             h.hint.textContent = label;
 357             h.hint.style.display = "inline";
 358             this.valid_hints.push(h);
 359             cur_number++;
 360         }
 361
 362         if (active_number == -1)
 363             this.select_hint(1);
 364     },
 365
 366     select_hint: function (index) {
 367         var old_index = this.current_hint_number;
 368         if (index == old_index)
 369             return;
 370         var vh = this.valid_hints;
 371         var vl = this.valid_hints.length;
 372         if (old_index >= 1 && old_index <= vl) {
 373             var h = vh[old_index - 1];
 374             if (h.img_hint)
 375                 h.img_hint.style.backgroundColor = img_hint_background_color;
 376             if (h.elem.style)
 377                 h.elem.style.backgroundColor = hint_background_color;
 378         }
 379         this.current_hint_number = index;
 380         this.last_selected_hint = null;
 381         if (index >= 1 && index <= vl) {
 382             h = vh[index - 1];
 383             if (h.img_hint)
 384                 h.img_hint.style.backgroundColor = active_img_hint_background_color;
 385             if (h.elem.style)
 386                 h.elem.style.backgroundColor = active_hint_background_color;
 387             this.last_selected_hint = h;
 388         }
 389     },
 390
 391     hide_hints: function () {
 392         for (var i = 0, h; h = this.hints[i]; ++i) {
 393             if (h.visible) {
 394                 h.visible = false;
 395                 if (h.saved_color != null) {
 396                     try {
 397                         h.elem.style.color = h.saved_color;
 398                         h.elem.style.backgroundColor = h.saved_bgcolor;
 399                     } catch (e) { /* element may be dead */ }
 400                 }
 401                 if (h.img_hint) {
 402                     try {
 403                         h.img_hint.style.display = "none";
 404                     } catch (e) { /* element may be dead */ }
 405                 }
 406                 try {
 407                     h.hint.style.display = "none";
 408                 } catch (e) { /* element may be dead */ }
 409             }
 410         }
 411     },
 412
 413     remove: function () {
 414         for (var i = 0, h; h = this.hints[i]; ++i) {
 415             if (h.visible && h.saved_color != null) {
 416                 try {
 417                     h.elem.style.color = h.saved_color;
 418                     h.elem.style.backgroundColor = h.saved_bgcolor;
 419                 } catch (e) { /* element may be dead */ }
 420             }
 421             if (h.img_hint) {
 422                 try {
 423                     h.img_hint.parentNode.removeChild(h.img_hint);
 424                 } catch (e) { /* element may be dead */ }
 425             }
 426             try {
 427                 h.hint.parentNode.removeChild(h.hint);
 428             } catch (e) { /* element may be dead */ }
 429         }
 430         this.hints = [];
 431         this.valid_hints = [];
 432     }
 433 };
 434
 435 /**
 436  * Display the URL and other information for the currently selected node.
 437  */
 438 function hints_minibuffer_annotation (hints, window) {
 439     this.hints = hints;
 440     this.input = window.minibuffer.input_element;
 441 }
 442 hints_minibuffer_annotation.prototype = {
 443     constructor: hints_minibuffer_annotation,
 444
 445     update: function () {
 446         var s = [];
 447         if (this.hints.manager && this.hints.manager.last_selected_hint) {
 448             var elem = this.hints.manager.last_selected_hint.elem;
 449             if (elem.hasAttribute("onmousedown") ||
 450                 elem.hasAttribute("onclick"))
 451             {
 452                 s.push("[script]");
 453             }
 454             var tag = elem.localName.toLowerCase();
 455             if ((tag == "input" || tag == "button") &&
 456                 elem.type == "submit" && elem.form && elem.form.action)
 457             {
 458                 s.push((elem.form.method || "GET").toUpperCase() + ":" +
 459                        elem.form.action);
 460             } else {
 461                 try {
 462                     var spec = load_spec(elem);
 463                     var uri = load_spec_uri_string(spec);
 464                     if (uri)
 465                         s.push(uri);
 466                 } catch (e) {}
 467             }
 468         }
 469         this.input.annotation = s.join(" ");
 470     },
 471
 472     load: function () {
 473         this.input.annotate = true;
 474         this.update();
 475     },
 476
 477     unload: function () {
 478         this.input.annotate = false;
 479     }
 480 };
 481
 482 define_global_mode("hints_minibuffer_annotation_mode",
 483     function enable () {
 484         minibuffer_annotation_mode.register(hints_minibuffer_annotation_mode);
 485     },
 486     function disable () {
 487         minibuffer_annotation_mode.unregister(hints_minibuffer_annotation_mode);
 488     },
 489     $doc = "Display the URL associated with the currently selected hint in "+
 490            "a minibuffer annotation.\nThis mode is most useful when "+
 491            "hints_auto_exit_delay is long or disabled.");
 492
 493 hints_minibuffer_annotation_mode(true);
 494
 495 /**
 496  * keyword arguments:
 497  *
 498  * $prompt
 499  * $callback
 500  * $abort_callback
 501  */
 502 define_keywords("$keymap", "$auto", "$hint_xpath_expression", "$multiple");
 503 function hints_minibuffer_state (minibuffer, buffer) {
 504     keywords(arguments, $keymap = hint_keymap, $auto);
 505     basic_minibuffer_state.call(this, minibuffer, $prompt = arguments.$prompt,
 506                                 $keymap = arguments.$keymap);
 507     if (hints_minibuffer_annotation_mode_enabled)
 508         this.hints_minibuffer_annotation = new hints_minibuffer_annotation(this, buffer.window);
 509     this.original_prompt = arguments.$prompt;
 510
 511     let deferred = Promise.defer();
 512     this.deferred = deferred;
 513     this.promise = make_simple_cancelable(deferred);
 514
 515     this.auto_exit = arguments.$auto ? true : false;
 516     this.xpath_expr = arguments.$hint_xpath_expression;
 517     this.auto_exit_timer_ID = null;
 518     this.multiple = arguments.$multiple;
 519     this.focused_element = buffer.focused_element;
 520     this.focused_frame = buffer.focused_frame;
 521 }
 522 hints_minibuffer_state.prototype = {
 523     constructor: hints_minibuffer_state,
 524     __proto__: basic_minibuffer_state.prototype,
 525     manager: null,
 526     typed_string: "",
 527     typed_number: "",
 528     load: function () {
 529         basic_minibuffer_state.prototype.load.call(this);
 530         if (!this.manager) {
 531             var buf = this.minibuffer.window.buffers.current;
 532             this.manager = new hint_manager(buf.top_frame, this.xpath_expr,
 533                                             this.focused_frame, this.focused_element);
 534         }
 535         this.manager.update_valid_hints();
 536         if (this.hints_minibuffer_annotation)
 537             this.hints_minibuffer_annotation.load();
 538     },
 539     clear_auto_exit_timer: function () {
 540         var window = this.minibuffer.window;
 541         if (this.auto_exit_timer_ID != null) {
 542             window.clearTimeout(this.auto_exit_timer_ID);
 543             this.auto_exit_timer_ID = null;
 544         }
 545     },
 546     unload: function () {
 547         this.clear_auto_exit_timer();
 548         this.manager.hide_hints();
 549         if (this.hints_minibuffer_annotation)
 550             this.hints_minibuffer_annotation.unload();
 551         basic_minibuffer_state.prototype.unload.call(this);
 552     },
 553     destroy: function () {
 554         this.promise.cancel();
 555         this.clear_auto_exit_timer();
 556         this.manager.remove();
 557         if (this.hints_minibuffer_annotation)
 558             this.hints_minibuffer_annotation.unload();
 559         basic_minibuffer_state.prototype.destroy.call(this);
 560     },
 561     update_minibuffer: function (m) {
 562         if (this.typed_number.length > 0)
 563             m.prompt = this.original_prompt + " #" + this.typed_number;
 564         else
 565             m.prompt = this.original_prompt;
 566         if (this.hints_minibuffer_annotation)
 567             this.hints_minibuffer_annotation.update();
 568     },
 569
 570     handle_auto_exit: function (ambiguous) {
 571         var window = this.minibuffer.window;
 572         var num = this.manager.current_hint_number;
 573         if (!this.auto_exit)
 574             return;
 575         let s = this;
 576         let delay = ambiguous ? hints_ambiguous_auto_exit_delay : hints_auto_exit_delay;
 577         if (delay > 0)
 578             this.auto_exit_timer_ID = window.setTimeout(function () { hints_exit(window, s); },
 579                                                         delay);
 580     },
 581
 582     handle_input: function (m) {
 583         this.clear_auto_exit_timer();
 584         this.typed_number = "";
 585         this.typed_string = m._input_text;
 586         this.manager.current_hint_string = this.typed_string;
 587         this.manager.current_hint_number = -1;
 588         this.manager.update_valid_hints();
 589         if (this.manager.valid_hints.length == 1)
 590             this.handle_auto_exit(false /* unambiguous */);
 591         else if (this.manager.valid_hints.length > 1)
 592         this.handle_auto_exit(true /* ambiguous */);
 593         this.update_minibuffer(m);
 594     }
 595 };
 596
 597 define_variable("hints_auto_exit_delay", 0,
 598     "Delay (in milliseconds) after the most recent key stroke before a "+
 599     "sole matching element is automatically selected.  When zero, "+
 600     "automatic selection is disabled.  A value of 500 is a good "+
 601     "starting point for an average-speed typist.");
 602
 603 define_variable("hints_ambiguous_auto_exit_delay", 0,
 604     "Delay (in milliseconds) after the most recent key stroke before the "+
 605     "first of an ambiguous match is automatically selected.  If this is "+
 606     "set to 0, automatic selection in ambiguous matches is disabled.");
 607
 608
 609 define_key_match_predicate("match_hint_digit", "hint digit",
 610     function (e) {
 611         if (e.type != "keypress")
 612             return false;
 613         if (e.charCode == 48) //0 is special
 614             return true;
 615         if (hint_digits) {
 616             if (hint_digits.indexOf(String.fromCharCode(e.charCode)) > -1)
 617                 return true;
 618         } else if (e.charCode >= 49 && e.charCode <= 57)
 619             return true;
 620         return false;
 621     });
 622
 623 interactive("hints-handle-number",
 624     "This is the handler for numeric keys in hinting mode.  Normally, "+
 625     "that means '1' through '9' and '0', but the numeric base (and digits) "+
 626     "can be configured via the user variable 'hint_digits'.  No matter "+
 627     "what numeric base is in effect, the character '0' is special, and "+
 628     "will always be treated as a number 0, translated into the current "+
 629     "base if necessary.",
 630     function (I) {
 631         let s = I.minibuffer.check_state(hints_minibuffer_state);
 632         s.clear_auto_exit_timer();
 633         var ch = String.fromCharCode(I.event.charCode);
 634         if (hint_digits && ch == "0")
 635             ch = hint_digits[0];
 636         var auto_exit_ambiguous = null; // null -> no auto exit; false -> not ambiguous; true -> ambiguous
 637         s.typed_number += ch;
 638         s.manager.select_hint(hints_parse(s.typed_number));
 639         var num = s.manager.current_hint_number;
 640         if (num > 0 && num <= s.manager.valid_hints.length)
 641             auto_exit_ambiguous = num * 10 > s.manager.valid_hints.length ? false : true;
 642         else if (num == 0) {
 643             if (!s.multiple) {
 644                 hints_exit(I.window, s);
 645                 return;
 646             }
 647             auto_exit_ambiguous = false;
 648         }
 649         if (auto_exit_ambiguous !== null)
 650             s.handle_auto_exit(auto_exit_ambiguous);
 651         s.update_minibuffer(I.minibuffer);
 652     });
 653
 654 function hints_backspace (window, s) {
 655     let m = window.minibuffer;
 656     s.clear_auto_exit_timer();
 657     var l = s.typed_number.length;
 658     if (l > 0) {
 659         s.typed_number = s.typed_number.substring(0, --l);
 660         var num = l > 0 ? hints_parse(s.typed_number) : 1;
 661         s.manager.select_hint(num);
 662     } else if (s.typed_string.length > 0) {
 663         call_builtin_command(window, 'cmd_deleteCharBackward');
 664         s.typed_string = m._input_text;
 665         //m._set_selection();
 666         s.manager.current_hint_string = s.typed_string;
 667         s.manager.current_hint_number = -1;
 668         s.manager.update_valid_hints();
 669     }
 670     s.update_minibuffer(m);
 671 }
 672 interactive("hints-backspace", null,
 673     function (I) {
 674         hints_backspace(I.window, I.minibuffer.check_state(hints_minibuffer_state));
 675     });
 676
 677 function hints_next (window, s, count) {
 678     s.clear_auto_exit_timer();
 679     s.typed_number = "";
 680     var cur = s.manager.current_hint_number - 1;
 681     var vh = s.manager.valid_hints;
 682     var vl = s.manager.valid_hints.length;
 683     if (vl > 0) {
 684         cur = (cur + count) % vl;
 685         if (cur < 0)
 686             cur += vl;
 687         s.manager.select_hint(cur + 1);
 688     }
 689     s.update_minibuffer(window.minibuffer);
 690 }
 691 interactive("hints-next", null,
 692     function (I) {
 693         hints_next(I.window, I.minibuffer.check_state(hints_minibuffer_state), I.p);
 694     });
 695
 696 interactive("hints-previous", null,
 697     function (I) {
 698         hints_next(I.window, I.minibuffer.check_state(hints_minibuffer_state), -I.p);
 699     });
 700
 701 function hints_exit (window, s) {
 702     var cur = s.manager.current_hint_number;
 703     var elem = null;
 704     if (cur > 0 && cur <= s.manager.valid_hints.length)
 705         elem = s.manager.valid_hints[cur - 1].elem;
 706     else if (cur == 0)
 707         elem = window.buffers.current.top_frame;
 708     if (elem !== null) {
 709         s.deferred.resolve(elem);
 710         window.minibuffer.pop_state();
 711     }
 712 }
 713
 714 interactive("hints-exit", null,
 715     function (I) {
 716         hints_exit(I.window, I.minibuffer.check_state(hints_minibuffer_state));
 717     });
 718
 719 interactive("hints-quote-next", null,
 720     function (I) {
 721         I.overlay_keymap = hint_quote_next_keymap;
 722     },
 723     $prefix);
 724
 725
 726 define_keywords("$buffer");
 727 minibuffer.prototype.read_hinted_element = function () {
 728     keywords(arguments);
 729     var buf = arguments.$buffer;
 730     var s = new hints_minibuffer_state(this, buf, forward_keywords(arguments));
 731     this.push_state(s);
 732     yield co_return(yield s.promise);
 733 };
 734
 735 provide("hints");