modules/hints.js

   1 /**
   2  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   3  *
   4  * Portions of this file are derived from Vimperator,
   5  * (C) Copyright 2006-2007 Martin Stubenschrott.
   6  *
   7  * Use, modification, and distribution are subject to the terms specified in the
   8  * COPYING file.
   9 **/
  10
  11 define_variable("active_img_hint_background_color", "#88FF00",
  12     "Color for the active image hint background.");
  13
  14 define_variable("img_hint_background_color", "yellow",
  15     "Color for inactive image hint backgrounds.");
  16
  17 define_variable("active_hint_background_color", "#88FF00",
  18     "Color for the active hint background.");
  19
  20 define_variable("hint_background_color", "yellow",
  21     "Color for the inactive hint.");
  22
  23
  24 /**
  25  * Register hints style sheet
  26  */
  27 const hints_stylesheet = "chrome://conkeror-gui/content/hints.css";
  28 register_user_stylesheet(hints_stylesheet);
  29
  30 /**
  31  *   In the hints interaction, a node can be selected either by typing
  32  * the number of its associated hint, or by typing substrings of the
  33  * text content of the node.  In the case of selecting by text
  34  * content, multiple substrings can be given by separating them with
  35  * spaces.
  36  */
  37 function hint_manager(window, xpath_expr, focused_frame, focused_element)
  38 {
  39     this.window = window;
  40     this.hints = [];
  41     this.valid_hints = [];
  42     this.xpath_expr = xpath_expr;
  43     this.focused_frame = focused_frame;
  44     this.focused_element = focused_element;
  45     this.last_selected_hint = null;
  46
  47     // Generate
  48     this.generate_hints();
  49 }
  50
  51 hint_manager.prototype = {
  52     current_hint_string : "",
  53     current_hint_number : -1,
  54
  55     /**
  56      * Create an initially hidden hint span element absolutely
  57      * positioned over each element that matches
  58      * hint_xpath_expression.  This is done recursively for all frames
  59      * and iframes.  Information about the resulting hints are also
  60      * stored in the hints array.
  61      */
  62     generate_hints : function () {
  63         var topwin = this.window;
  64         var top_height = topwin.innerHeight;
  65         var top_width = topwin.innerWidth;
  66         var hints = this.hints;
  67         var xpath_expr = this.xpath_expr;
  68         var focused_frame_hint = null, focused_element_hint = null;
  69         var focused_frame = this.focused_frame;
  70         var focused_element = this.focused_element;
  71         function helper(window, offsetX, offsetY) {
  72             var win_height = window.height;
  73             var win_width = window.width;
  74
  75             // Bounds
  76             var minX = offsetX < 0 ? -offsetX : 0;
  77             var minY = offsetY < 0 ? -offsetY : 0;
  78             var maxX = offsetX + win_width > top_width ? top_width - offsetX : top_width;
  79             var maxY = offsetY + win_height > top_height ? top_height - offsetY : top_height;
  80
  81             var scrollX = window.scrollX;
  82             var scrollY = window.scrollY;
  83
  84             var doc = window.document;
  85             var res = doc.evaluate(xpath_expr, doc, xpath_lookup_namespace,
  86                                    Ci.nsIDOMXPathResult.UNORDERED_NODE_ITERATOR_TYPE,
  87                                    null /* existing results */);
  88
  89             var base_node = doc.createElementNS(XHTML_NS, "span");
  90             base_node.className = "__conkeror_hint";
  91
  92             var fragment = doc.createDocumentFragment();
  93             var rect, elem, text, node, show_text;
  94             while (true)
  95             {
  96                 try {
  97                     elem = res.iterateNext();
  98                     if (!elem)
  99                         break;
 100                 } catch (e) {
 101                     break; // Iterator may have been invalidated by page load activity
 102                 }
 103                 rect = elem.getBoundingClientRect();
 104                 if (!rect || rect.left > maxX || rect.right < minX || rect.top > maxY || rect.bottom < minY)
 105                     continue;
 106                 let style = topwin.getComputedStyle(elem, "");
 107                 if (style.display == "none" || style.visibility == "hidden")
 108                     continue;
 109                 rect = elem.getClientRects()[0];
 110                 if (!rect)
 111                     continue;
 112                 show_text = false;
 113                 if (elem instanceof Ci.nsIDOMHTMLInputElement || elem instanceof Ci.nsIDOMHTMLTextAreaElement)
 114                     text = elem.value;
 115                 else if (elem instanceof Ci.nsIDOMHTMLSelectElement) {
 116                     if (elem.selectedIndex >= 0)
 117                         text = elem.item(elem.selectedIndex).text;
 118                     else
 119                         text = "";
 120                 } else if (elem instanceof Ci.nsIDOMHTMLFrameElement) {
 121                     text = elem.name ? elem.name : "";
 122                 } else if (/^\s*$/.test(elem.textContent) &&
 123                            elem.childNodes.length == 1 &&
 124                            elem.childNodes.item(0) instanceof Ci.nsIDOMHTMLImageElement) {
 125                     text = elem.childNodes.item(0).alt;
 126                     show_text = true;
 127                 } else
 128                     text = elem.textContent;
 129                 text = text.toLowerCase();
 130
 131                 node = base_node.cloneNode(true);
 132                 node.style.left = (rect.left + scrollX) + "px";
 133                 node.style.top = (rect.top + scrollY) + "px";
 134                 fragment.appendChild(node);
 135
 136                 let hint = {text: text,
 137                             elem: elem,
 138                             hint: node,
 139                             img_hint: null,
 140                             visible: false,
 141                             show_text: show_text};
 142                 if (elem.style) {
 143                     hint.saved_color = elem.style.color;
 144                     hint.saved_bgcolor = elem.style.backgroundColor;
 145                 }
 146                 hints.push(hint);
 147
 148                 if (elem == focused_element)
 149                     focused_element_hint = hint;
 150                 else if ((elem instanceof Ci.nsIDOMHTMLFrameElement ||
 151                           elem instanceof Ci.nsIDOMHTMLIFrameElement) &&
 152                          elem.contentWindow == focused_frame)
 153                     focused_frame_hint = hint;
 154             }
 155             doc.documentElement.appendChild(fragment);
 156
 157             /* Recurse into any IFRAME or FRAME elements */
 158             var frametag = "frame";
 159             while (true) {
 160                 var frames = doc.getElementsByTagName(frametag);
 161                 for (var i = 0; i < frames.length; ++i)
 162                 {
 163                     elem = frames[i];
 164                     rect = elem.getBoundingClientRect();
 165                     if (!rect || rect.left > maxX || rect.right < minX || rect.top > maxY || rect.bottom < minY)
 166                         continue;
 167                     helper(elem.contentWindow, offsetX + rect.left, offsetY + rect.top);
 168                 }
 169                 if (frametag == "frame") frametag = "iframe"; else break;
 170             }
 171         }
 172         helper(topwin, 0, 0);
 173         this.last_selected_hint = focused_element_hint || focused_frame_hint;
 174     },
 175
 176     /* Updates valid_hints and also re-numbers and re-displays all hints. */
 177     update_valid_hints : function () {
 178         this.valid_hints = [];
 179         var active_number = this.current_hint_number;
 180
 181         var tokens = this.current_hint_string.split(" ");
 182         var rect, h, text, img_hint, doc, scrollX, scrollY;
 183         var hints = this.hints;
 184
 185     outer:
 186         for (var i = 0; i < hints.length; ++i)
 187         {
 188             h = hints[i];
 189             text = h.text;
 190             for (var j = 0; j < tokens.length; ++j)
 191             {
 192                 if (text.indexOf(tokens[j]) == -1)
 193                 {
 194                     if (h.visible)
 195                     {
 196                         h.visible = false;
 197                         h.hint.style.display = "none";
 198                         if (h.img_hint)
 199                             h.img_hint.style.display = "none";
 200                         if (h.saved_color != null) {
 201                             h.elem.style.backgroundColor = h.saved_bgcolor;
 202                             h.elem.style.color = h.saved_color;
 203                         }
 204                     }
 205                     continue outer;
 206                 }
 207             }
 208
 209             var cur_number = this.valid_hints.length + 1;
 210             h.visible = true;
 211
 212             if (h == this.last_selected_hint && active_number == -1)
 213                 this.current_hint_number = active_number = cur_number;
 214
 215             var img_elem = null;
 216
 217             if (text.length == 0 && h.elem.firstChild &&
 218                 h.elem.firstChild instanceof Ci.nsIDOMHTMLImageElement)
 219                 img_elem = h.elem.firstChild;
 220             else if (h.elem instanceof Ci.nsIDOMHTMLImageElement)
 221                 img_elem = h.elem;
 222
 223             if (img_elem)
 224             {
 225                 if (!h.img_hint)
 226                 {
 227                     rect = img_elem.getBoundingClientRect();
 228                     if (rect) {
 229                         doc = h.elem.ownerDocument;
 230                         scrollX = doc.defaultView.scrollX;
 231                         scrollY = doc.defaultView.scrollY;
 232                         img_hint = doc.createElementNS(XHTML_NS, "span");
 233                         img_hint.className = "__conkeror_img_hint";
 234                         img_hint.style.left = (rect.left + scrollX) + "px";
 235                         img_hint.style.top = (rect.top + scrollY) + "px";
 236                         img_hint.style.width = (rect.right - rect.left) + "px";
 237                         img_hint.style.height = (rect.bottom - rect.top) + "px";
 238                         h.img_hint = img_hint;
 239                         doc.documentElement.appendChild(img_hint);
 240                     } else
 241                         img_elem = null;
 242                 }
 243                 if (img_elem) {
 244                     var bgcolor = (active_number == cur_number) ?
 245                         active_img_hint_background_color : img_hint_background_color;
 246                     h.img_hint.style.backgroundColor = bgcolor;
 247                     h.img_hint.style.display = "inline";
 248                 }
 249             }
 250
 251             if (!h.img_hint && h.elem.style)
 252                 h.elem.style.backgroundColor = (active_number == cur_number) ?
 253                     active_hint_background_color : hint_background_color;
 254
 255             if (h.elem.style)
 256                 h.elem.style.color = "black";
 257
 258             var label = "" + cur_number;
 259             if (h.elem instanceof Ci.nsIDOMHTMLFrameElement) {
 260                 label +=  " " + text;
 261             } else if (h.show_text && !/^\s*$/.test(text)) {
 262                 let substrs = [[0,4]];
 263                 for (j = 0; j < tokens.length; ++j)
 264                 {
 265                     let pos = text.indexOf(tokens[j]);
 266                     if(pos == -1) continue;
 267                     splice_range(substrs, pos, pos + tokens[j].length + 2);
 268                 }
 269                 label += " " + substrs.map(function(x) {
 270                     return text.substring(x[0],Math.min(x[1], text.length));
 271                 }).join("..") + "..";
 272             }
 273             h.hint.textContent = label;
 274             h.hint.style.display = "inline";
 275             this.valid_hints.push(h);
 276         }
 277
 278         if (active_number == -1)
 279             this.select_hint(1);
 280     },
 281
 282     select_hint : function (index) {
 283         var old_index = this.current_hint_number;
 284         if (index == old_index)
 285             return;
 286         var vh = this.valid_hints;
 287         if (old_index >= 1 && old_index <= vh.length)
 288         {
 289             var h = vh[old_index - 1];
 290             if (h.img_hint)
 291                 h.img_hint.style.backgroundColor = img_hint_background_color;
 292             if (h.elem.style)
 293                 h.elem.style.backgroundColor = hint_background_color;
 294         }
 295         this.current_hint_number = index;
 296         if (index >= 1 && index <= vh.length)
 297         {
 298             var h = vh[index - 1];
 299             if (h.img_hint)
 300                 h.img_hint.style.backgroundColor = active_img_hint_background_color;
 301             if (h.elem.style)
 302                 h.elem.style.backgroundColor = active_hint_background_color;
 303             this.last_selected_hint = h;
 304         }
 305     },
 306
 307     hide_hints : function () {
 308         for (var i = 0; i < this.hints.length; ++i)
 309         {
 310             var h = this.hints[i];
 311             if (h.visible) {
 312                 h.visible = false;
 313                 if (h.saved_color != null)
 314                 {
 315                     h.elem.style.color = h.saved_color;
 316                     h.elem.style.backgroundColor = h.saved_bgcolor;
 317                 }
 318                 if (h.img_hint)
 319                     h.img_hint.style.display = "none";
 320                 h.hint.style.display = "none";
 321             }
 322         }
 323     },
 324
 325     remove : function () {
 326         for (var i = 0; i < this.hints.length; ++i)
 327         {
 328             var h = this.hints[i];
 329             if (h.visible && h.saved_color != null) {
 330                 h.elem.style.color = h.saved_color;
 331                 h.elem.style.backgroundColor = h.saved_bgcolor;
 332             }
 333             if (h.img_hint)
 334                 h.img_hint.parentNode.removeChild(h.img_hint);
 335             h.hint.parentNode.removeChild(h.hint);
 336         }
 337         this.hints = [];
 338         this.valid_hints = [];
 339     }
 340 };
 341
 342 /* Show panel with currently selected URL below the minibuffer. */
 343 function hints_url_panel(hints, window) {
 344     var g = new dom_generator(window.document, XUL_NS);
 345
 346     var p = g.element("hbox", "class", "panel url", "flex", "0");
 347     g.element("label", p, "value", "URL:", "class", "url-panel-label");
 348     var url_value = g.element("label", p, "class", "url-panel-value",
 349                               "crop", "end", "flex", "1");
 350     window.minibuffer.insert_before(p);
 351
 352     p.update = function() {
 353         url_value.value = "";
 354         if (hints.manager && hints.manager.last_selected_hint) {
 355             var spec;
 356             try {
 357                 spec = load_spec(hints.manager.last_selected_hint.elem);
 358             } catch (e) {}
 359             if (spec) {
 360                 var uri = load_spec_uri_string(spec);
 361                 if (uri) url_value.value = uri;
 362             }
 363         }
 364     };
 365
 366     p.destroy = function() {
 367         this.parentNode.removeChild(this);
 368     };
 369
 370     return p;
 371 }
 372
 373 define_variable("hints_display_url_panel", false,
 374     "When selecting a hint, the URL can be displayed in a panel above "+
 375     "the minibuffer.  This is useful for confirming that the correct "+
 376     "link is selected and that the URL is not evil.  This option is "+
 377     "most useful when hints_auto_exit_delay is long or disabled.");
 378
 379 /**
 380  * keyword arguments:
 381  *
 382  * $prompt
 383  * $callback
 384  * $abort_callback
 385  */
 386 define_keywords("$keymap", "$auto", "$hint_xpath_expression", "$multiple");
 387 function hints_minibuffer_state(continuation, buffer)
 388 {
 389     keywords(arguments, $keymap = hint_keymap, $auto);
 390     basic_minibuffer_state.call(this, $prompt = arguments.$prompt);
 391     if (hints_display_url_panel)
 392         this.url_panel = hints_url_panel(this, buffer.window);
 393     this.original_prompt = arguments.$prompt;
 394     this.continuation = continuation;
 395     this.keymap = arguments.$keymap;
 396     this.auto_exit = arguments.$auto ? true : false;
 397     this.xpath_expr = arguments.$hint_xpath_expression;
 398     this.auto_exit_timer_ID = null;
 399     this.multiple = arguments.$multiple;
 400     this.focused_element = buffer.focused_element;
 401     this.focused_frame = buffer.focused_frame;
 402 }
 403 hints_minibuffer_state.prototype = {
 404     __proto__: basic_minibuffer_state.prototype,
 405     manager : null,
 406     typed_string : "",
 407     typed_number : "",
 408     load : function (window) {
 409         if (!this.manager) {
 410             var buf = window.buffers.current;
 411             this.manager = new hint_manager(buf.top_frame, this.xpath_expr,
 412                                             this.focused_frame, this.focused_element);
 413         }
 414         this.manager.update_valid_hints();
 415         this.window = window;
 416         if (this.url_panel)
 417             this.url_panel.update();
 418     },
 419     clear_auto_exit_timer : function () {
 420         if (this.auto_exit_timer_ID != null) {
 421             this.window.clearTimeout(this.auto_exit_timer_ID);
 422             this.auto_exit_timer_ID = null;
 423         }
 424     },
 425     unload : function (window) {
 426         this.clear_auto_exit_timer();
 427         this.manager.hide_hints();
 428         delete this.window;
 429     },
 430     destroy : function () {
 431         this.clear_auto_exit_timer();
 432         this.manager.remove();
 433         if (this.url_panel)
 434             this.url_panel.destroy();
 435     },
 436     update_minibuffer : function (m) {
 437         if (this.typed_number.length > 0)
 438             m.prompt = this.original_prompt + " #" + this.typed_number;
 439         else
 440             m.prompt = this.original_prompt;
 441         if (this.url_panel)
 442             this.url_panel.update();
 443     },
 444
 445     handle_auto_exit : function (m, ambiguous) {
 446         let window = m.window;
 447         var num = this.manager.current_hint_number;
 448         if (!this.auto_exit)
 449             return;
 450         let s = this;
 451         let delay = ambiguous ? hints_ambiguous_auto_exit_delay : hints_auto_exit_delay;
 452         if (delay > 0)
 453             this.auto_exit_timer_ID = window.setTimeout(function() { hints_exit(window, s); },
 454                                                         delay);
 455     },
 456
 457     ran_minibuffer_command : function (m) {
 458         this.handle_input(m);
 459     },
 460
 461     handle_input : function (m) {
 462         m._set_selection();
 463         this.clear_auto_exit_timer();
 464         this.typed_number = "";
 465         this.typed_string = m._input_text;
 466         this.manager.current_hint_string = this.typed_string;
 467         this.manager.current_hint_number = -1;
 468         this.manager.update_valid_hints();
 469         if (this.manager.valid_hints.length == 1)
 470             this.handle_auto_exit(m, false /* unambiguous */);
 471         else if (this.manager.valid_hints.length > 1)
 472         this.handle_auto_exit(m, true /* ambiguous */);
 473         this.update_minibuffer(m);
 474     }
 475 };
 476
 477 define_variable("hints_auto_exit_delay", 500,
 478     "Delay (in milliseconds) after the most recent key stroke before a "+
 479     "sole matching element is automatically selected.  If this is set to "+
 480     "0, automatic selection is disabled.");
 481
 482 define_variable("hints_ambiguous_auto_exit_delay", 0,
 483     "Delay (in milliseconds) after the most recent key stroke before the "+
 484     "first of an ambiguous match is automatically selected.  If this is "+
 485     "set to 0, automatic selection in ambiguous matches is disabled.");
 486
 487 interactive("hints-handle-number", null, function (I) {
 488                 let s = I.minibuffer.check_state(hints_minibuffer_state);
 489                 s.clear_auto_exit_timer();
 490                 var ch = String.fromCharCode(I.event.charCode);
 491                 var auto_exit_ambiguous = null; // null -> no auto exit; false -> not ambiguous; true -> ambiguous
 492                 /* TODO: implement number escaping */
 493                 // Number entered
 494                 s.typed_number += ch;
 495
 496                 s.manager.select_hint(parseInt(s.typed_number));
 497                 var num = s.manager.current_hint_number;
 498                 if (num > 0 && num <= s.manager.valid_hints.length)
 499                     auto_exit_ambiguous = num * 10 > s.manager.valid_hints.length ? false : true;
 500                 else if (num == 0) {
 501                     if (!s.multiple) {
 502                         hints_exit(I.window, s);
 503                         return;
 504                     }
 505                     auto_exit_ambiguous = false;
 506                 }
 507                 if (auto_exit_ambiguous !== null)
 508                     s.handle_auto_exit(I.minibuffer, auto_exit_ambiguous);
 509                 s.update_minibuffer(I.minibuffer);
 510             });
 511
 512 function hints_backspace(window, s) {
 513     let m = window.minibuffer;
 514     s.clear_auto_exit_timer();
 515     if (s.typed_number.length > 0) {
 516         s.typed_number = s.typed_number.substring(0, s.typed_number.length - 1);
 517         var num = s.typed_number.length > 0 ? parseInt(s.typed_number) : 1;
 518         s.manager.select_hint(num);
 519     } else if (s.typed_string.length > 0) {
 520         s.typed_string = s.typed_string.substring(0, s.typed_string.length - 1);
 521         m._input_text = s.typed_string;
 522         m._set_selection();
 523         s.manager.current_hint_string = s.typed_string;
 524         s.manager.current_hint_number = -1;
 525         s.manager.update_valid_hints();
 526     }
 527     s.update_minibuffer(m);
 528 }
 529 interactive("hints-backspace", null, function (I) {
 530     hints_backspace(I.window, I.minibuffer.check_state(hints_minibuffer_state));
 531 });
 532
 533 function hints_next(window, s, count) {
 534     s.clear_auto_exit_timer();
 535     s.typed_number = "";
 536     var cur = s.manager.current_hint_number - 1;
 537     var vh = s.manager.valid_hints;
 538     if (vh.length > 0) {
 539         cur = (cur + count) % vh.length;
 540         if (cur < 0)
 541             cur += vh.length;
 542         s.manager.select_hint(cur + 1);
 543     }
 544     s.update_minibuffer(window);
 545 }
 546 interactive("hints-next", null, function (I) {
 547     hints_next(I.window, I.minibuffer.check_state(hints_minibuffer_state), I.p);
 548 });
 549
 550 interactive("hints-previous", null, function (I) {
 551     hints_next(I.window, I.minibuffer.check_state(hints_minibuffer_state), -I.p);
 552 });
 553
 554 function hints_exit(window, s)
 555 {
 556     var cur = s.manager.current_hint_number;
 557     var elem = null;
 558     if (cur > 0 && cur <= s.manager.valid_hints.length)
 559         elem = s.manager.valid_hints[cur - 1].elem;
 560     else if (cur == 0)
 561         elem = window.buffers.current.top_frame;
 562     if (elem !== null) {
 563         var c = s.continuation;
 564         delete s.continuation;
 565         window.minibuffer.pop_state();
 566         if (c)
 567             c(elem);
 568     }
 569 }
 570
 571 interactive("hints-exit", null, function (I) {
 572     hints_exit(I.window, I.minibuffer.check_state(hints_minibuffer_state));
 573 });
 574
 575
 576 define_keywords("$buffer");
 577 minibuffer.prototype.read_hinted_element = function () {
 578     keywords(arguments);
 579     var buf = arguments.$buffer;
 580     var s = new hints_minibuffer_state((yield CONTINUATION), buf, forward_keywords(arguments));
 581     this.push_state(s);
 582     var result = yield SUSPEND;
 583     yield co_return(result);
 584 };