modules/buffer.js

   1 /**
   2  * (C) Copyright 2004-2007 Shawn Betts
   3  * (C) Copyright 2007-2012 John J. Foerch
   4  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   5  *
   6  * Use, modification, and distribution are subject to the terms specified in the
   7  * COPYING file.
   8 **/
   9
  10 var define_buffer_local_hook = local_hook_definer("window");
  11
  12 function define_current_buffer_hook (hook_name, existing_hook) {
  13     define_buffer_local_hook(hook_name);
  14     add_hook(existing_hook, function (buffer) {
  15             if (!buffer.window.buffers || buffer != buffer.window.buffers.current)
  16                 return;
  17             var hook = conkeror[hook_name];
  18             hook.run.apply(hook, Array.prototype.slice.call(arguments));
  19         });
  20 }
  21
  22 define_buffer_local_hook("buffer_title_change_hook");
  23 define_buffer_local_hook("buffer_description_change_hook");
  24 define_buffer_local_hook("buffer_icon_change_hook");
  25 define_buffer_local_hook("select_buffer_hook");
  26 define_buffer_local_hook("create_buffer_early_hook");
  27 define_buffer_local_hook("create_buffer_late_hook");
  28 define_buffer_local_hook("create_buffer_hook");
  29 define_buffer_local_hook("kill_buffer_hook");
  30 define_buffer_local_hook("move_buffer_hook");
  31 define_buffer_local_hook("buffer_scroll_hook");
  32 define_buffer_local_hook("buffer_dom_content_loaded_hook");
  33 define_buffer_local_hook("buffer_loaded_hook");
  34 define_buffer_local_hook("set_input_mode_hook");
  35 define_buffer_local_hook("zoom_hook");
  36
  37 define_current_buffer_hook("current_buffer_title_change_hook", "buffer_title_change_hook");
  38 define_current_buffer_hook("current_buffer_description_change_hook", "buffer_description_change_hook");
  39 define_current_buffer_hook("current_buffer_icon_change_hook", "buffer_icon_change_hook");
  40 define_current_buffer_hook("current_buffer_scroll_hook", "buffer_scroll_hook");
  41 define_current_buffer_hook("current_buffer_dom_content_loaded_hook", "buffer_dom_content_loaded_hook");
  42 define_current_buffer_hook("current_buffer_zoom_hook", "zoom_hook");
  43
  44
  45 function buffer_position_before (container, b, i) {
  46     return i;
  47 }
  48
  49 function buffer_position_after (container, b, i) {
  50     return i + 1;
  51 }
  52
  53 function buffer_position_end (container, b, i) {
  54     return container.count;
  55 }
  56
  57 function buffer_position_end_by_type (container, b, i) {
  58     // after last buffer of same type
  59     var count = container.count;
  60     var p = count - 1;
  61     while (p >= 0 &&
  62            container.get_buffer(p).constructor != b.constructor)
  63     {
  64         p--;
  65     }
  66     if (p == -1)
  67         return count;
  68     else
  69         return p + 1;
  70 }
  71
  72 define_variable("new_buffer_position", buffer_position_end,
  73     "Used to compute the position in the buffer-list at which "+
  74     "to insert new buffers which do not have an opener.  These "+
  75     "include buffers created by typing an url or webjump, or "+
  76     "buffers created via command-line remoting.  The value "+
  77     "should be a number giving the index or a function of three "+
  78     "arguments that returns the index at which to insert the "+
  79     "new buffer.  The first argument is the buffer_container "+
  80     "into which the new buffer is being inserted.  The second "+
  81     "argument is the buffer to be inserted.  The third argument "+
  82     "is the position of the currently selected buffer.  Several "+
  83     "such functions are provided, including, buffer_position_before, "+
  84     "buffer_position_after, buffer_position_end, and "+
  85     "buffer_position_end_by_type.");
  86
  87 define_variable("new_buffer_with_opener_position", buffer_position_after,
  88     "Used to compute the position in the buffer-list at which "+
  89     "to insert new buffers which have an opener in the same "+
  90     "window.  These include buffers created by following a link "+
  91     "or frame, and contextual help buffers.  The allowed values "+
  92     "are the same as those for `new_buffer_position', except that "+
  93     "the second argument passed to the function is the index of "+
  94     "the opener instead of the index of the current buffer (often "+
  95     "one and the same).");
  96
  97 define_variable("bury_buffer_position", null,
  98     "Used to compute the position in the buffer-list to move a "+
  99     "buried buffer to.  A value of null prevents bury-buffer "+
 100     "from moving the buffer at all.  Other allowed values are "+
 101     "the same as those for `new_buffer_position', except that "+
 102     "the second argument passed to the function is the index of "+
 103     "the new buffer that will be selected after burying the "+
 104     "current buffer.");
 105
 106 define_variable("allow_browser_window_close", true,
 107     "If this is set to true, if a content buffer page calls " +
 108     "window.close() from JavaScript and is not prevented by the " +
 109     "normal Mozilla mechanism that restricts pages from closing " +
 110     "a window that was not opened by a script, the buffer will be " +
 111     "killed, deleting the window as well if it is the only buffer.");
 112
 113 define_keywords("$opener", "$position");
 114 function buffer_creator (type) {
 115     var args = forward_keywords(arguments);
 116     return function (window) {
 117         return new type(window, args);
 118     };
 119 }
 120
 121 function buffer_modality (buffer) {
 122     buffer.keymaps.push(default_global_keymap);
 123 }
 124
 125 function buffer (window) {
 126     this.constructor_begin();
 127     keywords(arguments, $position = this.default_position);
 128     this.opener = arguments.$opener;
 129     this.window = window;
 130     var element = create_XUL(window, "vbox");
 131     element.setAttribute("flex", "1");
 132     var browser = create_XUL(window, "browser");
 133     browser.setAttribute("type", "content");
 134     browser.setAttribute("flex", "1");
 135     browser.setAttribute("autocompletepopup", "popup_autocomplete");
 136     element.appendChild(browser);
 137     this.window.buffers.container.appendChild(element);
 138     this.window.buffers.insert(this, arguments.$position, this.opener);
 139     this.window.buffers.buffer_history.push(this);
 140     this.element = element;
 141     this.browser = element.firstChild;
 142     this.element.conkeror_buffer_object = this;
 143
 144     this.local = { __proto__: conkeror };
 145     this.page = null;
 146     this.enabled_modes = [];
 147     this.default_browser_object_classes = {};
 148
 149     var buffer = this;
 150
 151     this.browser.addEventListener("scroll", function (event) {
 152             buffer_scroll_hook.run(buffer);
 153         }, true /* capture */);
 154
 155     this.browser.addEventListener("DOMContentLoaded", function (event) {
 156             buffer_dom_content_loaded_hook.run(buffer);
 157         }, true /* capture */);
 158
 159     this.window.setTimeout(function () { create_buffer_late_hook.run(buffer); }, 0);
 160
 161     this.browser.addEventListener("load", function (event) {
 162             if (event.target == buffer.document)
 163                 buffer_loaded_hook.run(buffer);
 164         }, true /* capture */);
 165
 166     this.browser.addEventListener("DOMWindowClose", function (event) {
 167             /* This call to preventDefault is very important; without
 168              * it, somehow Mozilla does something bad and as a result
 169              * the window loses focus, causing keyboard commands to
 170              * stop working. */
 171             event.preventDefault();
 172
 173             if (allow_browser_window_close)
 174                 kill_buffer(buffer, true);
 175         }, true);
 176
 177     this.browser.addEventListener("focus", function (event) {
 178         if (buffer.focusblocker &&
 179             event.target instanceof Ci.nsIDOMHTMLElement &&
 180             buffer.focusblocker(buffer, event))
 181         {
 182             event.target.blur();
 183         } else
 184             buffer.set_input_mode();
 185     }, true);
 186
 187     this.browser.addEventListener("blur", function (event) {
 188         buffer.set_input_mode();
 189     }, true);
 190
 191     this.modalities = [buffer_modality];
 192
 193     // When create_buffer_early_hook runs, basic buffer properties
 194     // will be available, but not the properties subclasses.
 195     create_buffer_early_hook.run(this);
 196
 197     this.constructor_end();
 198 }
 199 buffer.prototype = {
 200     constructor: buffer,
 201     toString: function () "#<buffer>",
 202
 203     // default_position is the default value for the $position keyword to
 204     // the buffer constructor.  This property can be set on the prototype
 205     // of a subclass in order to override new_buffer_position and
 206     // new_buffer_with_opener_position for specific types of buffers.
 207     default_position: null,
 208
 209     /* Saved focus state */
 210     saved_focused_frame: null,
 211     saved_focused_element: null,
 212
 213     // get title ()   [must be defined by subclasses]
 214     // get name ()    [must be defined by subclasses]
 215     dead: false, /* This is set when the buffer is killed */
 216
 217     keymaps: null,
 218     mark_active: false,
 219
 220     // The property focusblocker is available for an external module to
 221     // put a function on which takes a buffer as its argument and returns
 222     // true to block a focus event, or false to let normal processing
 223     // occur.  Having this one property explicitly handled by the buffer
 224     // class allows for otherwise modular focus-blockers.
 225     focusblocker: null,
 226
 227     // icon is a string url of an icon to use for this buffer.  Setting it
 228     // causes buffer_icon_change_hook to be run.
 229     _icon: null,
 230     get icon () this._icon,
 231     set icon (x) {
 232         if (this._icon != x) {
 233             this._icon = x;
 234             buffer_icon_change_hook.run(this);
 235         }
 236     },
 237
 238     default_message: "",
 239
 240     set_default_message: function (str) {
 241         this.default_message = str;
 242         if (this == this.window.buffers.current)
 243             this.window.minibuffer.set_default_message(str);
 244     },
 245
 246     constructors_running: 0,
 247
 248     constructor_begin: function () {
 249         this.constructors_running++;
 250     },
 251
 252     constructor_end: function () {
 253         if (--this.constructors_running == 0) {
 254             create_buffer_hook.run(this);
 255             this.set_input_mode();
 256             delete this.opener;
 257         }
 258     },
 259
 260     destroy: function () {
 261         this.dead = true;
 262         this.browser = null;
 263         this.element = null;
 264         this.saved_focused_frame = null;
 265         this.saved_focused_element = null;
 266         // prevent modalities from accessing dead browser
 267         this.modalities = [];
 268     },
 269
 270     set_input_mode: function () {
 271         if (this != this.window.buffers.current)
 272             return;
 273         this.keymaps = [];
 274         this.modalities.map(function (m) m(this), this);
 275         set_input_mode_hook.run(this);
 276     },
 277
 278     override_keymaps: function (keymaps) {
 279         if (keymaps) {
 280             this.keymaps = keymaps;
 281             this.set_input_mode = function () {
 282                 set_input_mode_hook.run(this);
 283             };
 284         } else
 285             delete this.set_input_mode;
 286         this.set_input_mode();
 287     },
 288
 289     /* Browser accessors */
 290     get top_frame () { return this.browser.contentWindow; },
 291     get document () { return this.browser.contentDocument; },
 292     get web_navigation () { return this.browser.webNavigation; },
 293     get doc_shell () { return this.browser.docShell; },
 294     get markup_document_viewer () { return this.browser.markupDocumentViewer; },
 295     get current_uri () { return this.browser.currentURI; },
 296
 297     is_child_element: function (element) {
 298         return (element && this.is_child_frame(element.ownerDocument.defaultView));
 299     },
 300
 301     is_child_frame: function (frame) {
 302         return (frame && frame.top == this.top_frame);
 303     },
 304
 305     // This method is like focused_frame, except that if no content
 306     // frame actually has focus, this returns null.
 307     get focused_frame_or_null () {
 308         var frame = this.window.document.commandDispatcher.focusedWindow;
 309         if (this.is_child_frame(frame))
 310             return frame;
 311         return null;
 312     },
 313
 314     get focused_frame () {
 315         var frame = this.window.document.commandDispatcher.focusedWindow;
 316         if (this.is_child_frame(frame))
 317             return frame;
 318         return this.top_frame;
 319     },
 320
 321     get focused_element () {
 322         var element = this.window.document.commandDispatcher.focusedElement;
 323         if (this.is_child_element(element))
 324             return element;
 325         return null;
 326     },
 327
 328     get focused_selection_controller () {
 329         return this.focused_frame
 330             .QueryInterface(Ci.nsIInterfaceRequestor)
 331             .getInterface(Ci.nsIWebNavigation)
 332             .QueryInterface(Ci.nsIInterfaceRequestor)
 333             .getInterface(Ci.nsISelectionDisplay)
 334             .QueryInterface(Ci.nsISelectionController);
 335     },
 336
 337     do_command: function (command) {
 338         function attempt_command (element, command) {
 339             var controller;
 340             if (element.controllers
 341                 && (controller = element.controllers.getControllerForCommand(command)) != null
 342                 && controller.isCommandEnabled(command))
 343             {
 344                 controller.doCommand(command);
 345                 return true;
 346             }
 347             return false;
 348         }
 349
 350         var element = this.focused_element;
 351         if (element && attempt_command(element, command))
 352             return;
 353         var win = this.focused_frame;
 354         while (true) {
 355             if (attempt_command(win, command))
 356                 return;
 357             if (!win.parent || win == win.parent)
 358                 break;
 359             win = win.parent;
 360         }
 361     }
 362 };
 363
 364 function with_current_buffer (buffer, callback) {
 365     return callback(new interactive_context(buffer));
 366 }
 367
 368 function check_buffer (obj, type) {
 369     if (!(obj instanceof type))
 370         throw interactive_error("Buffer has invalid type.");
 371     if (obj.dead)
 372         throw interactive_error("Buffer has already been killed.");
 373     return obj;
 374 }
 375
 376 function caret_enabled (buffer) {
 377     return buffer.browser.getAttribute('showcaret');
 378 }
 379
 380 function clear_selection (buffer) {
 381     let sel_ctrl = buffer.focused_selection_controller;
 382     if (sel_ctrl) {
 383         let sel = sel_ctrl.getSelection(sel_ctrl.SELECTION_NORMAL);
 384         if (caret_enabled(buffer)) {
 385             if (sel.anchorNode)
 386                 sel.collapseToStart();
 387         } else {
 388             sel.removeAllRanges();
 389         }
 390     }
 391 }
 392
 393
 394 function buffer_container (window, create_initial_buffer) {
 395     this.window = window;
 396     this.container = window.document.getElementById("buffer-container");
 397     this.buffer_list = [];
 398     this.buffer_history = [];
 399     window.buffers = this;
 400     create_initial_buffer(window);
 401 }
 402 buffer_container.prototype = {
 403     constructor: buffer_container,
 404     toString: function () "#<buffer_container>",
 405
 406     insert: function (buffer, position, opener) {
 407         var i = this.index_of(opener);
 408         if (position == null) {
 409             if (i == null)
 410                 position = new_buffer_position;
 411             else
 412                 position = new_buffer_with_opener_position;
 413         }
 414         if (i == null)
 415             i = this.selected_index || 0;
 416         try {
 417             if (position instanceof Function)
 418                 var p = position(this, buffer, i);
 419             else
 420                 p = position;
 421             this.buffer_list.splice(p, 0, buffer);
 422         } catch (e) {
 423             this.buffer_list.splice(0, 0, buffer);
 424             dumpln("Error inserting buffer, inserted at 0.");
 425             dump_error(e);
 426         }
 427     },
 428
 429     get current () {
 430         return this.container.selectedPanel.conkeror_buffer_object;
 431     },
 432
 433     set current (buffer) {
 434         var old_value = this.current;
 435         if (old_value == buffer)
 436             return;
 437
 438         this.buffer_history.splice(this.buffer_history.indexOf(buffer), 1);
 439         this.buffer_history.unshift(buffer);
 440
 441         this._switch_away_from(this.current);
 442         this._switch_to(buffer);
 443
 444         // Run hooks
 445         select_buffer_hook.run(buffer);
 446     },
 447
 448     _switch_away_from: function (old_value) {
 449         // Save focus state
 450         old_value.saved_focused_frame = old_value.focused_frame;
 451         old_value.saved_focused_element = old_value.focused_element;
 452
 453         old_value.browser.setAttribute("type", "content");
 454     },
 455
 456     _switch_to: function (buffer) {
 457         // Select new buffer in the XUL deck
 458         this.container.selectedPanel = buffer.element;
 459
 460         buffer.browser.setAttribute("type", "content-primary");
 461
 462         /**
 463          * This next focus call seems to be needed to avoid focus
 464          * somehow getting lost (and the keypress handler therefore
 465          * not getting called at all) when killing buffers.
 466          */
 467         this.window.focus();
 468
 469         // Restore focus state
 470         buffer.browser.focus();
 471         if (buffer.saved_focused_element)
 472             set_focus_no_scroll(this.window, buffer.saved_focused_element);
 473         else if (buffer.saved_focused_frame)
 474             set_focus_no_scroll(this.window, buffer.saved_focused_frame);
 475
 476         buffer.saved_focused_element = null;
 477         buffer.saved_focused_frame = null;
 478
 479         buffer.set_input_mode();
 480
 481         this.window.minibuffer.set_default_message(buffer.default_message);
 482     },
 483
 484     get count () {
 485         return this.buffer_list.length;
 486     },
 487
 488     get_buffer: function (index) {
 489         if (index >= 0 && index < this.count)
 490             return this.buffer_list[index]
 491         return null;
 492     },
 493
 494     get selected_index () {
 495         var nodes = this.buffer_list;
 496         var count = nodes.length;
 497         for (var i = 0; i < count; ++i)
 498             if (nodes[i] == this.container.selectedPanel.conkeror_buffer_object)
 499                 return i;
 500         return null;
 501     },
 502
 503     index_of: function (b) {
 504         var nodes = this.buffer_list;
 505         var count = nodes.length;
 506         for (var i = 0; i < count; ++i)
 507             if (nodes[i] == b)
 508                 return i;
 509         return null;
 510     },
 511
 512     get unique_name_list () {
 513         var existing_names = {};
 514         var bufs = [];
 515         this.for_each(function(b) {
 516                 var base_name = b.name;
 517                 var name = base_name;
 518                 var index = 1;
 519                 while (existing_names[name]) {
 520                     ++index;
 521                     name = base_name + "<" + index + ">";
 522                 }
 523                 existing_names[name] = true;
 524                 bufs.push([name, b]);
 525             });
 526         return bufs;
 527     },
 528
 529     kill_buffer: function (b) {
 530         if (b.dead)
 531             return true;
 532         var count = this.count;
 533         if (count <= 1)
 534             return false;
 535         var new_buffer = this.buffer_history[0];
 536         var changed = false;
 537         if (b == new_buffer) {
 538             new_buffer = this.buffer_history[1];
 539             changed = true;
 540         }
 541         this._switch_away_from(this.current);
 542         // The removeChild call below may trigger events in progress
 543         // listeners.  This call to `destroy' gives buffer subclasses a
 544         // chance to remove such listeners, so that they cannot try to
 545         // perform UI actions based upon a xul:browser that no longer
 546         // exists.
 547         var element = b.element;
 548         b.destroy();
 549         this.container.removeChild(element);
 550         this.buffer_list.splice(this.buffer_list.indexOf(b), 1);
 551         this.buffer_history.splice(this.buffer_history.indexOf(b), 1);
 552         this._switch_to(new_buffer);
 553         if (changed) {
 554             select_buffer_hook.run(new_buffer);
 555             this.buffer_history.splice(this.buffer_history.indexOf(new_buffer), 1);
 556             this.buffer_history.unshift(new_buffer);
 557         }
 558         kill_buffer_hook.run(b);
 559         return true;
 560     },
 561
 562     bury_buffer: function (b) {
 563         var new_buffer = this.buffer_history[0];
 564         if (b == new_buffer)
 565             new_buffer = this.buffer_history[1];
 566         if (! new_buffer)
 567             throw interactive_error("No other buffer");
 568         if (bury_buffer_position != null) {
 569             this.buffer_list.splice(this.buffer_list.indexOf(b), 1);
 570             this.insert(b, bury_buffer_position, new_buffer);
 571         }
 572         this.buffer_history.splice(this.buffer_history.indexOf(b), 1);
 573         this.buffer_history.push(b);
 574         this.current = new_buffer;
 575         if (bury_buffer_position != null)
 576             move_buffer_hook.run(b);
 577         return true;
 578     },
 579
 580     unbury_buffer: function (b) {
 581         var c = this.current;
 582         if (bury_buffer_position != null) {
 583             this.buffer_list.splice(this.buffer_list.indexOf(b), 1);
 584             this.buffer_list.splice(this.buffer_list.indexOf(c), 0, b);
 585         }
 586         this.buffer_history.splice(this.buffer_history.indexOf(b), 1);
 587         this.buffer_history.unshift(b);
 588         this.current = b;
 589         if (bury_buffer_position != null)
 590             move_buffer_hook.run(b);
 591         return true;
 592     },
 593
 594     for_each: function (f) {
 595         var count = this.count;
 596         for (var i = 0; i < count; ++i)
 597             f(this.get_buffer(i));
 598     }
 599 };
 600
 601 function buffer_initialize_window_early (window) {
 602     /**
 603      * Use content_buffer by default to handle an unusual case where
 604      * browser.chromeURI is used perhaps.  In general this default
 605      * should not be needed.
 606      */
 607     var create_initial_buffer =
 608         window.args.initial_buffer_creator || buffer_creator(content_buffer);
 609     new buffer_container(window, create_initial_buffer);
 610 }
 611
 612 add_hook("window_initialize_early_hook", buffer_initialize_window_early);
 613
 614
 615 /**
 616  * initialize_first_buffer_type is a workaround for a XULRunner bug that
 617  * first appeared in version 2.0, manifested as missing scrollbars in the
 618  * first buffer of any window.  It only affects content-primary browsers,
 619  * and the workaround is to initialize the browser as type "content" then
 620  * change it to content-primary after a delay.
 621  */
 622 function initialize_first_buffer_type (window) {
 623     window.buffers.current.browser.setAttribute("type", "content-primary");
 624 }
 625
 626 add_hook("window_initialize_late_hook", initialize_first_buffer_type);
 627
 628
 629 define_buffer_local_hook("buffer_kill_before_hook", RUN_HOOK_UNTIL_FAILURE);
 630 function buffer_before_window_close (window) {
 631     var bs = window.buffers;
 632     var count = bs.count;
 633     for (let i = 0; i < count; ++i) {
 634         if (!buffer_kill_before_hook.run(bs.get_buffer(i)))
 635             return false;
 636     }
 637     return true;
 638 }
 639 add_hook("window_before_close_hook", buffer_before_window_close);
 640
 641 function buffer_window_close_handler (window) {
 642     var bs = window.buffers;
 643     var count = bs.count;
 644     for (let i = 0; i < count; ++i) {
 645         let b = bs.get_buffer(i);
 646         b.destroy();
 647     }
 648 }
 649 add_hook("window_close_hook", buffer_window_close_handler);
 650
 651 /* open/follow targets */
 652 const OPEN_CURRENT_BUFFER = 0; // only valid for open if the current
 653                                // buffer is a content_buffer.
 654 const OPEN_NEW_BUFFER = 1;
 655 const OPEN_NEW_BUFFER_BACKGROUND = 2;
 656 const OPEN_NEW_WINDOW = 3;
 657
 658 const FOLLOW_DEFAULT = 4; // for open, implies OPEN_CURRENT_BUFFER
 659 const FOLLOW_CURRENT_FRAME = 5; // for open, implies OPEN_CURRENT_BUFFER
 660
 661 var TARGET_PROMPTS = [" in current buffer",
 662                       " in new buffer",
 663                       " in new buffer (background)",
 664                       " in new window",
 665                       "",
 666                       " in current frame"];
 667
 668 var TARGET_NAMES = ["current buffer",
 669                     "new buffer",
 670                     "new buffer (background)",
 671                     "new window",
 672                     "default",
 673                     "current frame"];
 674
 675
 676 function create_buffer (window, creator, target) {
 677     switch (target) {
 678     case OPEN_NEW_BUFFER:
 679         window.buffers.current = creator(window, null);
 680         break;
 681     case OPEN_NEW_BUFFER_BACKGROUND:
 682         creator(window, null);
 683         break;
 684     case OPEN_NEW_WINDOW:
 685         make_window(creator);
 686         break;
 687     default:
 688         throw new Error("invalid target");
 689     }
 690 }
 691
 692 let (queued_buffer_creators = null) {
 693     function create_buffer_in_current_window (creator, target, focus_existing) {
 694         function process_queued_buffer_creators (window) {
 695             for (var i = 0; i < queued_buffer_creators.length; ++i) {
 696                 var x = queued_buffer_creators[i];
 697                 create_buffer(window, x[0], x[1]);
 698             }
 699             queued_buffer_creators = null;
 700         }
 701
 702         if (target == OPEN_NEW_WINDOW)
 703             throw new Error("invalid target");
 704         var window = get_recent_conkeror_window();
 705         if (window) {
 706             if (focus_existing)
 707                 window.focus();
 708             create_buffer(window, creator, target);
 709         } else if (queued_buffer_creators != null) {
 710             queued_buffer_creators.push([creator,target]);
 711         } else {
 712             queued_buffer_creators = [];
 713             window = make_window(creator);
 714             add_hook.call(window, "window_initialize_late_hook", process_queued_buffer_creators);
 715         }
 716     }
 717 };
 718
 719
 720 /*
 721  * Read Buffer
 722  */
 723 define_variable("read_buffer_show_icons", false,
 724     "Boolean which says whether read_buffer should show buffer "+
 725     "icons in the completions list.\nNote, setting this variable "+
 726     "alone does not cause favicons or other kinds of icons to be "+
 727     "fetched.  For that, load the `favicon' (or similar other) "+
 728     "library.");
 729
 730 minibuffer_auto_complete_preferences["buffer"] = true;
 731 define_keywords("$buffers", "$default");
 732 minibuffer.prototype.read_buffer = function () {
 733     var window = this.window;
 734     keywords(arguments, $prompt = "Buffer:",
 735              $buffers = function (visitor) window.buffers.for_each(visitor),
 736              $default = window.buffers.current,
 737              $history = "buffer");
 738     var completer = all_word_completer(
 739         $completions = arguments.$buffers,
 740         $get_string = function (x) x.description,
 741         $get_description = function (x) x.title,
 742         $get_icon = (read_buffer_show_icons ?
 743                      function (x) x.icon : null));
 744     var result = yield this.read(
 745         $keymap = read_buffer_keymap,
 746         $prompt = arguments.$prompt,
 747         $history = arguments.$history,
 748         $completer = completer,
 749         $enable_icons = read_buffer_show_icons,
 750         $match_required = true,
 751         $auto_complete = "buffer",
 752         $auto_complete_initial = true,
 753         $auto_complete_delay = 0,
 754         $default_completion = arguments.$default);
 755     yield co_return(result);
 756 };
 757
 758
 759 function buffer_move_forward (window, count) {
 760     var buffers = window.buffers;
 761     var index = buffers.selected_index;
 762     var buffer = buffers.current
 763     var total = buffers.count;
 764     if (total == 1)
 765         return;
 766     var new_index = (index + count) % total;
 767     if (new_index == index)
 768         return;
 769     if (new_index < 0)
 770         new_index += total;
 771     buffers.buffer_list.splice(index, 1);
 772     buffers.buffer_list.splice(new_index, 0, buffer);
 773     move_buffer_hook.run(buffer);
 774 }
 775 interactive("buffer-move-forward",
 776     "Move the current buffer forward in the buffer order.",
 777     function (I) { buffer_move_forward(I.window, I.p); });
 778
 779 interactive("buffer-move-backward",
 780     "Move the current buffer backward in the buffer order.",
 781     function (I) { buffer_move_forward(I.window, -I.p); });
 782
 783
 784 function buffer_next (window, count) {
 785     var index = window.buffers.selected_index;
 786     var total = window.buffers.count;
 787     if (total == 1)
 788         throw new interactive_error("No other buffer");
 789     index = (index + count) % total;
 790     if (index < 0)
 791         index += total;
 792     window.buffers.current = window.buffers.get_buffer(index);
 793 }
 794 interactive("buffer-next",
 795     "Switch to the next buffer.",
 796     function (I) { buffer_next(I.window, I.p); });
 797 interactive("buffer-previous",
 798     "Switch to the previous buffer.",
 799     function (I) { buffer_next(I.window, -I.p); });
 800
 801 function switch_to_buffer (window, buffer) {
 802     if (buffer && !buffer.dead)
 803         window.buffers.current = buffer;
 804 }
 805 interactive("switch-to-buffer",
 806     "Prompt for a buffer and switch to it.",
 807     function (I) {
 808         switch_to_buffer(
 809             I.window,
 810             (yield I.minibuffer.read_buffer(
 811                 $prompt = "Switch to buffer:",
 812                 $default = (I.window.buffers.count > 1 ?
 813                             I.window.buffers.buffer_history[1] :
 814                             I.buffer))));
 815     });
 816
 817 define_variable("can_kill_last_buffer", true,
 818     "When true, kill-buffer can kill the last  buffer in a window, "+
 819     "and close the window.");
 820
 821 function kill_other_buffers (buffer) {
 822     if (!buffer)
 823         return;
 824     var bs = buffer.window.buffers;
 825     var b;
 826     while ((b = bs.get_buffer(0)) != buffer)
 827         bs.kill_buffer(b);
 828     var count = bs.count;
 829     while (--count)
 830         bs.kill_buffer(bs.get_buffer(1));
 831 }
 832 interactive("kill-other-buffers",
 833     "Kill all buffers except current one.\n",
 834     function (I) { kill_other_buffers(I.buffer); });
 835
 836
 837 function kill_buffer (buffer, force) {
 838     if (!buffer)
 839         return;
 840     var buffers = buffer.window.buffers;
 841     if (buffers.count == 1 && buffer == buffers.current) {
 842         if (can_kill_last_buffer || force) {
 843             delete_window(buffer.window);
 844             return;
 845         } else
 846             throw interactive_error("Can't kill last buffer.");
 847     }
 848     buffers.kill_buffer(buffer);
 849 }
 850 interactive("kill-buffer",
 851     "Kill a buffer specified in the minibuffer.\n" +
 852     "If `can_kill_last_buffer' is set to true, an attempt to kill the "+
 853     "last remaining buffer in a window will cause the window to be closed.",
 854     function (I) {
 855         kill_buffer((yield I.minibuffer.read_buffer($prompt = "Kill buffer:")));
 856     });
 857
 858 interactive("kill-current-buffer",
 859     "Kill the current buffer.\n" +
 860     "If `can_kill_last_buffer' is set to true, an attempt to kill the "+
 861     "last remaining buffer in a window will cause the window to be closed.",
 862     function (I) { kill_buffer(I.buffer); });
 863
 864 interactive("read-buffer-kill-buffer",
 865     "Kill the current selected buffer in the completions list "+
 866     "in a read buffer minibuffer interaction.",
 867     function (I) {
 868         var s = I.window.minibuffer.current_state;
 869         var i = s.selected_completion_index;
 870         var c = s.completions;
 871         if (i == -1)
 872             return;
 873         kill_buffer(c.get_value(i));
 874         s.completer.refresh();
 875         s.handle_input(I.window.minibuffer);
 876     });
 877
 878 interactive("bury-buffer",
 879     "Bury the current buffer.\nPut the current buffer at the end of " +
 880     "the buffer list, so that it is the least likely buffer to be " +
 881     "selected by `switch-to-buffer'.",
 882     function (I) { I.window.buffers.bury_buffer(I.buffer); });
 883
 884 interactive("unbury-buffer",
 885     "Unbury a buffer.\nPrompt for a buffer in reverse access-order, "+
 886     "and switch to it.  When `bury_buffer_position` is non-null, move "+
 887     "the buffer to the current position in the buffer list.",
 888     function (I) {
 889         var buffers = I.window.buffers;
 890         buffers.unbury_buffer(
 891             (yield I.minibuffer.read_buffer(
 892                 $prompt = "Switch to buffer:",
 893                 $buffers = function (visitor) {
 894                     var count = buffers.count;
 895                     for (var i = count - 1; i >= 0; --i)
 896                         visitor(buffers.buffer_history[i]);
 897                 },
 898                 $default = buffers.buffer_history[buffers.count - 1])));
 899     });
 900
 901 function change_directory (buffer, dir) {
 902     if (buffer.page != null)
 903         delete buffer.page.local.cwd;
 904     buffer.local.cwd = make_file(dir);
 905 }
 906 interactive("change-directory",
 907     "Change the current directory of the selected buffer.",
 908     function (I) {
 909         change_directory(
 910             I.buffer,
 911             (yield I.minibuffer.read_existing_directory_path(
 912                 $prompt = "Change to directory:",
 913                 $initial_value = make_file(I.local.cwd).path)));
 914     });
 915
 916 interactive("shell-command", null,
 917     function (I) {
 918         var cwd = I.local.cwd;
 919         var cmd = (yield I.minibuffer.read_shell_command($cwd = cwd));
 920         yield shell_command(cmd, $cwd = cwd);
 921     });
 922
 923
 924 /**
 925  * selection_is_embed_p is used to test whether the unfocus command can
 926  * unfocus an element, even though there is a selection.  This happens
 927  * when the focused element is an html:embed.
 928  */
 929 function selection_is_embed_p (sel, focused_element) {
 930     if (sel.rangeCount == 1) {
 931         try {
 932             var r = sel.getRangeAt(0);
 933             var a = r.startContainer.childNodes[r.startOffset];
 934             if ((a instanceof Ci.nsIDOMHTMLEmbedElement ||
 935                  a instanceof Ci.nsIDOMHTMLObjectElement) &&
 936                 a == focused_element)
 937             {
 938                 return true;
 939             }
 940         } catch (e) {}
 941     }
 942     return false;
 943 }
 944
 945 /**
 946  * unfocus is a high-level command for unfocusing hyperlinks, inputs,
 947  * frames, iframes, plugins, and also clearing the selection.
 948  */
 949 define_buffer_local_hook("unfocus_hook");
 950 function unfocus (window, buffer) {
 951     // 1. if there is a selection, clear it.
 952     var selc = buffer.focused_selection_controller;
 953     if (selc) {
 954         var sel = selc.getSelection(selc.SELECTION_NORMAL);
 955         var active = ! sel.isCollapsed;
 956         var embed_p = selection_is_embed_p(sel, buffer.focused_element);
 957         clear_selection(buffer);
 958         if (active && !embed_p) {
 959             window.minibuffer.message("cleared selection");
 960             return;
 961         }
 962     }
 963     // 2. if there is a focused element, unfocus it.
 964     if (buffer.focused_element) {
 965         buffer.focused_element.blur();
 966         // if an element in a detached fragment has focus, blur() will
 967         // not work, and we need to take more drastic measures.  the
 968         // action taken was found through experiment, so it is possibly
 969         // not the most concise way to unfocus such an element.
 970         if (buffer.focused_element) {
 971             buffer.element.focus();
 972             buffer.top_frame.focus();
 973         }
 974         window.minibuffer.message("unfocused element");
 975         return;
 976     }
 977     // 3. if an iframe has focus, we must blur it.
 978     if (buffer.focused_frame_or_null &&
 979         buffer.focused_frame_or_null.frameElement)
 980     {
 981         buffer.focused_frame_or_null.frameElement.blur();
 982     }
 983     // 4. return focus to top-frame from subframes and plugins.
 984     buffer.top_frame.focus();
 985     buffer.top_frame.focus(); // needed to get focus back from plugins
 986     window.minibuffer.message("refocused top frame");
 987     // give page-modes an opportunity to set focus specially
 988     unfocus_hook.run(buffer);
 989 }
 990 interactive("unfocus",
 991     "Unfocus is a high-level command for unfocusing hyperlinks, inputs, "+
 992     "frames, iframes, plugins, and also for clearing the selection.\n"+
 993     "The action that it takes is based on precedence.  If there is a "+
 994     "focused hyperlink or input, it will unfocus that.  Otherwise, if "+
 995     "there is a selection, it will clear the selection.  Otherwise, it "+
 996     "will return focus to the top frame from a focused frame, iframe, "+
 997     "or plugin.  In the case of plugins, since they steal keyboard "+
 998     "control away from Conkeror, the normal way to unfocus them is "+
 999     "to use command-line remoting externally: conkeror -batch -f "+
1000     "unfocus.  Page-modes also have an opportunity to alter the default"+
1001     "focus via the hook, `focus_hook'.",
1002     function (I) {
1003         unfocus(I.window, I.buffer);
1004     });
1005
1006
1007 function for_each_buffer (f) {
1008     for_each_window(function (w) { w.buffers.for_each(f); });
1009 }
1010
1011
1012 /*
1013  * Buffer Modes
1014  */
1015
1016 define_buffer_local_hook("buffer_mode_change_hook");
1017 define_current_buffer_hook("current_buffer_mode_change_hook", "buffer_mode_change_hook");
1018
1019 define_keywords("$display_name", "$doc");
1020 function buffer_mode (name, enable, disable) {
1021     keywords(arguments);
1022     this.name = name.replace("-","_","g");
1023     this.hyphen_name = name.replace("_","-","g");
1024     if (enable)
1025         this._enable = enable;
1026     if (disable)
1027         this._disable = disable;
1028     this.display_name = arguments.$display_name;
1029     this.doc = arguments.$doc;
1030     this.enable_hook = this.name + "_enable_hook";
1031     this.disable_hook = this.name + "_disable_hook";
1032 }
1033 buffer_mode.prototype = {
1034     constructor: buffer_mode,
1035     name: null,
1036     display_name: null,
1037     doc: null,
1038     enable_hook: null,
1039     disable_hook: null,
1040     _enable: null,
1041     _disable: null,
1042     enable: function (buffer) {
1043         try {
1044             if (this._enable)
1045                 this._enable(buffer);
1046         } finally {
1047             buffer.enabled_modes.push(this.name);
1048             if (conkeror[this.enable_hook])
1049                 conkeror[this.enable_hook].run(buffer);
1050             buffer_mode_change_hook.run(buffer);
1051         }
1052     },
1053     disable: function (buffer) {
1054         try {
1055             if (this._disable)
1056                 this._disable(buffer);
1057         } finally {
1058             var i = buffer.enabled_modes.indexOf(this.name);
1059             if (i > -1)
1060                 buffer.enabled_modes.splice(i, 1);
1061             if (conkeror[this.disable_hook])
1062                 conkeror[this.disable_hook].run(buffer);
1063             buffer_mode_change_hook.run(buffer);
1064         }
1065     }
1066 };
1067 define_keywords("$constructor");
1068 function define_buffer_mode (name, enable, disable) {
1069     keywords(arguments, $constructor = buffer_mode, $doc = null);
1070     var constructor = arguments.$constructor;
1071     var m = new constructor(name, enable, disable, forward_keywords(arguments));
1072     name = m.name; // normalized
1073     conkeror[name] = m;
1074     define_buffer_local_hook(m.enable_hook);
1075     define_buffer_local_hook(m.disable_hook);
1076     interactive(m.hyphen_name,
1077         arguments.$doc,
1078         function (I) {
1079             var enabledp = (I.buffer.enabled_modes.indexOf(name) > -1);
1080             if (enabledp)
1081                 m.disable(I.buffer);
1082             else
1083                 m.enable(I.buffer);
1084             I.minibuffer.message(m.hyphen_name + (enabledp ? " disabled" : " enabled"));
1085         });
1086 }
1087 ignore_function_for_get_caller_source_code_reference("define_buffer_mode");
1088
1089
1090 /*
1091  * Mode Display in Minibuffer
1092  */
1093
1094 function minibuffer_mode_indicator (window) {
1095     this.window = window;
1096     var element = create_XUL(window, "label");
1097     element.setAttribute("id", "minibuffer-mode-indicator");
1098     element.setAttribute("class", "mode-text-widget");
1099     window.document.getElementById("minibuffer").appendChild(element);
1100     this.element = element;
1101     this.hook_function = method_caller(this, this.update);
1102     add_hook.call(window, "select_buffer_hook", this.hook_function);
1103     add_hook.call(window, "current_buffer_mode_change_hook", this.hook_function);
1104     this.update();
1105 }
1106 minibuffer_mode_indicator.prototype = {
1107     constructor: minibuffer_mode_indicator,
1108     window: null,
1109     element: null,
1110     hook_function: null,
1111     update: function () {
1112         var buffer = this.window.buffers.current;
1113         var str = buffer.enabled_modes.map(
1114             function (x) {
1115                 return (conkeror[x].display_name || null);
1116             }).filter(function (x) x != null).join(" ");
1117         this.element.value = str;
1118     },
1119     uninstall: function () {
1120         remove_hook.call(this.window, "select_buffer_hook", this.hook_function);
1121         remove_hook.call(this.window, "current_buffer_mode_change_hook", this.hook_function);
1122         this.element.parentNode.removeChild(this.element);
1123     }
1124 };
1125 define_global_window_mode("minibuffer_mode_indicator", "window_initialize_hook");
1126 minibuffer_mode_indicator_mode(true);
1127
1128
1129 /*
1130  * minibuffer-keymaps-display
1131  */
1132 function minibuffer_keymaps_display_update (buffer) {
1133     var element = buffer.window.document
1134         .getElementById("keymaps-display");
1135     if (element) {
1136         var str = buffer.keymaps.reduce(
1137             function (acc, kmap) {
1138                 if (kmap.display_name)
1139                     acc.push(kmap.display_name);
1140                 return acc;
1141             }, []).join("/");
1142         if (element.value != str)
1143             element.value = str;
1144     }
1145 }
1146
1147 function minibuffer_keymaps_display_initialize (window) {
1148     var element = create_XUL(window, "label");
1149     element.setAttribute("id", "keymaps-display");
1150     element.setAttribute("class", "mode-text-widget");
1151     element.setAttribute("value", "");
1152     var mb = window.document.getElementById("minibuffer");
1153     mb.appendChild(element);
1154 }
1155
1156 define_global_mode("minibuffer_keymaps_display_mode",
1157     function enable () {
1158         add_hook("window_initialize_hook", minibuffer_keymaps_display_initialize);
1159         add_hook("set_input_mode_hook", minibuffer_keymaps_display_update);
1160         for_each_window(minibuffer_keymaps_display_initialize);
1161     },
1162     function disable () {
1163         remove_hook("window_initialize_hook", minibuffer_keymaps_display_initialize);
1164         remove_hook("set_input_mode_hook", minibuffer_keymaps_display_update);
1165         for_each_window(function (w) {
1166             var element = w.document
1167                 .getElementById("keymaps-display");
1168             if (element)
1169                 element.parentNode.removeChild(element);
1170         });
1171     });
1172
1173 minibuffer_keymaps_display_mode(true);
1174
1175
1176 /*
1177  * minibuffer-keymaps-highlight
1178  */
1179 function minibuffer_keymaps_highlight_update (buffer) {
1180     var mb = buffer.window.document.getElementById("minibuffer");
1181     if (buffer.keymaps.some(function (k) k.notify))
1182         dom_add_class(mb, "highlight");
1183     else
1184         dom_remove_class(mb, "highlight");
1185 }
1186
1187 define_global_mode("minibuffer_keymaps_highlight_mode",
1188     function enable () {
1189         add_hook("set_input_mode_hook", minibuffer_keymaps_highlight_update);
1190     },
1191     function disable () {
1192         remove_hook("set_input_mode_hook", minibuffer_keymaps_highlight_update);
1193         for_each_window(function (w) {
1194             var mb = w.document.getElementById("minibuffer");
1195             if (mb)
1196                 dom_remove_class("highlight");
1197         });
1198     });
1199
1200 minibuffer_keymaps_highlight_mode(true);
1201
1202
1203 provide("buffer");