modules/buffer.js

   1 /**
   2  * (C) Copyright 2004-2007 Shawn Betts
   3  * (C) Copyright 2007-2008 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 {
  14     define_buffer_local_hook(hook_name);
  15     add_hook(existing_hook, function (buffer) {
  16             if (!buffer.window.buffers || buffer != buffer.window.buffers.current)
  17                 return;
  18             var hook = conkeror[hook_name];
  19             hook.run.apply(hook, Array.prototype.slice.call(arguments));
  20         });
  21 }
  22
  23 define_buffer_local_hook("buffer_title_change_hook");
  24 define_buffer_local_hook("buffer_description_change_hook");
  25 define_buffer_local_hook("select_buffer_hook");
  26 define_buffer_local_hook("create_buffer_hook");
  27 define_buffer_local_hook("kill_buffer_hook");
  28 define_buffer_local_hook("buffer_scroll_hook");
  29 define_buffer_local_hook("buffer_dom_content_loaded_hook");
  30 define_buffer_local_hook("buffer_loaded_hook");
  31
  32 define_current_buffer_hook("current_buffer_title_change_hook", "buffer_title_change_hook");
  33 define_current_buffer_hook("current_buffer_description_change_hook", "buffer_description_change_hook");
  34 define_current_buffer_hook("current_buffer_scroll_hook", "buffer_scroll_hook");
  35 define_current_buffer_hook("current_buffer_dom_content_loaded_hook", "buffer_dom_content_loaded_hook");
  36
  37 function buffer_configuration(existing_configuration) {
  38     if (existing_configuration != null) {
  39         this.cwd = existing_configuration.cwd;
  40     }
  41     else {
  42         this.cwd = default_directory.path;
  43     }
  44 }
  45
  46 define_keywords("$configuration", "$element");
  47 function buffer_creator(type) {
  48     var args = forward_keywords(arguments);
  49     return function (window, element) {
  50         return new type(window, element, args);
  51     }
  52 }
  53
  54 define_variable("allow_browser_window_close", true,
  55                      "If this is set to true, if a content buffer page calls " +
  56                      "window.close() from JavaScript and is not prevented by the " +
  57                      "normal Mozilla mechanism that restricts pages from closing " +
  58                      "a window that was not opened by a script, the buffer will be " +
  59                      "killed, deleting the window as well if it is the only buffer.");
  60
  61 function buffer(window, element)
  62 {
  63     this.constructor_begin();
  64     keywords(arguments, $configuration = null);
  65     this.window = window;
  66     this.configuration = new buffer_configuration(arguments.$configuration);
  67     if (element == null)
  68     {
  69         element = create_XUL(window, "vbox");
  70         element.setAttribute("flex", "1");
  71         var browser = create_XUL(window, "browser");
  72         browser.setAttribute("type", "content");
  73         browser.setAttribute("flex", "1");
  74         browser.setAttribute("autocompletepopup", "popup_autocomplete");
  75         element.appendChild(browser);
  76         this.window.buffers.container.appendChild(element);
  77     } else {
  78         /* Manually set up session history.
  79          *
  80          * This is needed because when constructor for the XBL binding
  81          * (mozilla/toolkit/content/widgets/browser.xml#browser) for
  82          * the initial browser element of the window is called, the
  83          * docShell is not yet initialized and setting up the session
  84          * history will fail.  To work around this problem, we do as
  85          * tabbrowser.xml (Firefox) does and set the initial browser
  86          * to have the disablehistory=true attribute, and then repeat
  87          * the work that would normally be done in the XBL
  88          * constructor.
  89          */
  90
  91         // This code is taken from mozilla/browser/base/content/browser.js
  92         let browser = element.firstChild;
  93         browser.webNavigation.sessionHistory =
  94             Cc["@mozilla.org/browser/shistory;1"].createInstance(Ci.nsISHistory);
  95         observer_service.addObserver(browser, "browser:purge-session-history", false);
  96
  97         // remove the disablehistory attribute so the browser cleans up, as
  98         // though it had done this work itself
  99         browser.removeAttribute("disablehistory");
 100
 101         // enable global history
 102         browser.docShell.QueryInterface(Ci.nsIDocShellHistory).useGlobalHistory = true;
 103     }
 104     this.window.buffers.buffer_list.push(this);
 105     this.element = element;
 106     this.browser = element.firstChild;
 107     this.element.conkeror_buffer_object = this;
 108
 109     this.enabled_modes = [];
 110     this.local_variables = {};
 111
 112     var buffer = this;
 113
 114     this.browser.addEventListener("scroll", function (event) {
 115             buffer_scroll_hook.run(buffer);
 116         }, true /* capture */, false /* ignore untrusted events */);
 117
 118     this.browser.addEventListener("DOMContentLoaded", function (event) {
 119             buffer_dom_content_loaded_hook.run(buffer);
 120         }, true /* capture */, false /*ignore untrusted events */);
 121
 122     this.browser.addEventListener("load", function (event) {
 123             buffer_loaded_hook.run(buffer);
 124         }, true /* capture */, false /*ignore untrusted events */);
 125
 126     this.browser.addEventListener("DOMWindowClose", function (event) {
 127             /* This call to preventDefault is very important; without
 128              * it, somehow Mozilla does something bad and as a result
 129              * the window loses focus, causing keyboard commands to
 130              * stop working. */
 131             event.preventDefault();
 132
 133             if (allow_browser_window_close)
 134                 kill_buffer(buffer, true);
 135         }, true);
 136
 137     this.constructor_end();
 138 }
 139
 140 buffer.prototype = {
 141     /* Saved focus state */
 142     saved_focused_frame : null,
 143     saved_focused_element : null,
 144     on_switch_to : null,
 145     on_switch_away : null,
 146     // get title ()   [must be defined by subclasses]
 147     // get name ()    [must be defined by subclasses]
 148     dead : false, /* This is set when the buffer is killed */
 149
 150     default_message : "",
 151
 152     get : function (x) {
 153         if (x in this.local_variables)
 154             return this.local_variables[x];
 155         return conkeror[x];
 156     },
 157
 158     set_default_message : function (str) {
 159         this.default_message = str;
 160         if (this == this.window.buffers.current)
 161             this.window.minibuffer.set_default_message(str);
 162     },
 163
 164     constructors_running : 0,
 165
 166     constructor_begin : function () {
 167         this.constructors_running++;
 168     },
 169
 170     constructor_end : function () {
 171         if (--this.constructors_running == 0)
 172             create_buffer_hook.run(this);
 173     },
 174
 175     /* General accessors */
 176     get cwd () { return this.configuration.cwd; },
 177
 178     /* Browser accessors */
 179     get top_frame () { return this.browser.contentWindow; },
 180     get document () { return this.browser.contentDocument; },
 181     get web_navigation () { return this.browser.webNavigation; },
 182     get doc_shell () { return this.browser.docShell; },
 183     get markup_document_viewer () { return this.browser.markupDocumentViewer; },
 184     get current_URI () { return this.browser.currentURI; },
 185
 186     is_child_element : function (element)
 187     {
 188         return (element && this.is_child_frame(element.ownerDocument.defaultView));
 189     },
 190
 191     is_child_frame : function (frame)
 192     {
 193         return (frame && frame.top == this.top_frame);
 194     },
 195
 196     // This method is like focused_frame, except that if no content
 197     // frame actually has focus, this returns null.
 198     get focused_frame_or_null () {
 199         var frame = this.window.document.commandDispatcher.focusedWindow;
 200         var top = this.top_frame;
 201         if (this.is_child_frame(frame))
 202             return frame;
 203         return null;
 204     },
 205
 206     get focused_frame () {
 207         var frame = this.window.document.commandDispatcher.focusedWindow;
 208         var top = this.top_frame;
 209         if (this.is_child_frame(frame))
 210             return frame;
 211         return this.top_frame;
 212     },
 213
 214     get focused_element () {
 215         var element = this.window.document.commandDispatcher.focusedElement;
 216         if (this.is_child_element(element))
 217             return element;
 218         return null;
 219     },
 220
 221     do_command : function (command)
 222     {
 223         function attempt_command(element, command)
 224         {
 225             var controller;
 226             if (element.controllers
 227                 && (controller = element.controllers.getControllerForCommand(command)) != null
 228                 && controller.isCommandEnabled(command))
 229             {
 230                 controller.doCommand(command);
 231                 return true;
 232             }
 233             return false;
 234         }
 235
 236         var element = this.focused_element;
 237         if (element && attempt_command(element, command))
 238             return;
 239         var win = this.focused_frame;
 240         do  {
 241             if (attempt_command(win, command))
 242                 return;
 243             if (!win.parent || win == win.parent)
 244                 break;
 245             win = win.parent;
 246         } while (true);
 247     },
 248
 249     handle_kill : function () {
 250         this.dead = true;
 251         this.browser = null;
 252         this.element = null;
 253         this.saved_focused_frame = null;
 254         this.saved_focused_element = null;
 255         kill_buffer_hook.run(this);
 256     }
 257 };
 258
 259 function check_buffer(obj, type) {
 260     if (!(obj instanceof type))
 261         throw interactive_error("Buffer has invalid type.");
 262     if (obj.dead)
 263         throw interactive_error("Buffer has already been killed.");
 264     return obj;
 265 }
 266
 267 function buffer_container(window, create_initial_buffer)
 268 {
 269     this.window = window;
 270     this.container = window.document.getElementById("buffer-container");
 271     this.buffer_list = [];
 272     window.buffers = this;
 273
 274     create_initial_buffer(window, this.container.firstChild);
 275 }
 276
 277 buffer_container.prototype = {
 278     constructor : buffer_container,
 279
 280     get current () {
 281         return this.container.selectedPanel.conkeror_buffer_object;
 282     },
 283
 284     set current (buffer) {
 285         var old_value = this.current;
 286         if (old_value == buffer)
 287             return;
 288
 289         this.buffer_list.splice(this.buffer_list.indexOf(buffer), 1);
 290         this.buffer_list.unshift(buffer);
 291
 292         this._switch_away_from(this.current);
 293         this._switch_to(buffer);
 294
 295         // Run hooks
 296         select_buffer_hook.run(buffer);
 297     },
 298
 299     _switch_away_from : function (old_value) {
 300         // Save focus state
 301         old_value.saved_focused_frame = old_value.focused_frame;
 302         old_value.saved_focused_element = old_value.focused_element;
 303
 304         old_value.browser.setAttribute("type", "content");
 305     },
 306
 307     _switch_to : function (buffer) {
 308         // Select new buffer in the XUL deck
 309         this.container.selectedPanel = buffer.element;
 310
 311         buffer.browser.setAttribute("type", "content-primary");
 312
 313         /**
 314          * This next focus call seems to be needed to avoid focus
 315          * somehow getting lost (and the keypress handler therefore
 316          * not getting called at all) when killing buffers.
 317          */
 318         this.window.focus();
 319
 320         // Restore focus state
 321         if (buffer.saved_focused_element)
 322             set_focus_no_scroll(this.window, buffer.saved_focused_element);
 323         else if (buffer.saved_focused_frame)
 324             set_focus_no_scroll(this.window, buffer.saved_focused_frame);
 325
 326         buffer.saved_focused_element = null;
 327         buffer.saved_focused_frame = null;
 328
 329         this.window.minibuffer.set_default_message(buffer.default_message);
 330     },
 331
 332     get count () {
 333         return this.container.childNodes.length;
 334     },
 335
 336     get_buffer : function (index) {
 337         if (index >= 0 && index < this.count)
 338             return this.container.childNodes.item(index).conkeror_buffer_object;
 339         return null;
 340     },
 341
 342     get selected_index () {
 343         var nodes = this.container.childNodes;
 344         var count = nodes.length;
 345         for (var i = 0; i < count; ++i)
 346             if (nodes.item(i) == this.container.selectedPanel)
 347                 return i;
 348         return null;
 349     },
 350
 351     index_of : function (b) {
 352         var nodes = this.container.childNodes;
 353         var count = nodes.length;
 354         for (var i = 0; i < count; ++i)
 355             if (nodes.item(i) == b.element)
 356                 return i;
 357         return null;
 358     },
 359
 360     get unique_name_list () {
 361         var existing_names = new string_hashset();
 362         var bufs = [];
 363         this.for_each(function(b) {
 364                 var base_name = b.name;
 365                 var name = base_name;
 366                 var index = 1;
 367                 while (existing_names.contains(name))
 368                 {
 369                     ++index;
 370                     name = base_name + "<" + index + ">";
 371                 }
 372                 existing_names.add(name);
 373                 bufs.push([name, b]);
 374             });
 375         return bufs;
 376     },
 377
 378     kill_buffer : function (b) {
 379         if (b.dead)
 380             return true;
 381         var count = this.count;
 382         if (count <= 1)
 383             return false;
 384         var new_buffer = this.buffer_list[0];
 385         var changed = false;
 386         if (b == new_buffer) {
 387             new_buffer = this.buffer_list[1];
 388             changed = true;
 389         }
 390         this._switch_away_from(this.current);
 391         this.container.removeChild(b.element);
 392         this.buffer_list.splice(this.buffer_list.indexOf(b), 1);
 393         this._switch_to(new_buffer);
 394         if (changed) {
 395             select_buffer_hook.run(new_buffer);
 396             this.buffer_list.splice(this.buffer_list.indexOf(new_buffer), 1);
 397             this.buffer_list.unshift(new_buffer);
 398         }
 399         b.handle_kill();
 400         return true;
 401     },
 402
 403     for_each : function (f) {
 404         var count = this.count;
 405         for (var i = 0; i < count; ++i)
 406             f(this.get_buffer(i));
 407     }
 408 };
 409
 410 function buffer_initialize_window_early(window)
 411 {
 412     /**
 413      * Use content_buffer by default to handle an unusual case where
 414      * browser.chromeURI is used perhaps.  In general this default
 415      * should not be needed.
 416      */
 417
 418     var create_initial_buffer
 419         = window.args.initial_buffer_creator || buffer_creator(content_buffer);
 420     new buffer_container(window, create_initial_buffer);
 421 }
 422
 423 add_hook("window_initialize_early_hook", buffer_initialize_window_early);
 424
 425
 426 define_buffer_local_hook("buffer_kill_before_hook", RUN_HOOK_UNTIL_FAILURE);
 427 function buffer_before_window_close(window)
 428 {
 429     var bs = window.buffers;
 430     var count = bs.count;
 431     for (let i = 0; i < count; ++i) {
 432         if (!buffer_kill_before_hook.run(bs.get_buffer(i)))
 433             return false;
 434     }
 435     return true;
 436 }
 437 add_hook("window_before_close_hook", buffer_before_window_close);
 438
 439 function buffer_window_close_handler(window)
 440 {
 441     var bs = window.buffers;
 442     var count = bs.count;
 443     for (let i = 0; i < count; ++i) {
 444         let b = bs.get_buffer(i);
 445         b.handle_kill();
 446     }
 447 }
 448 add_hook("window_close_hook", buffer_window_close_handler);
 449
 450 /* open/follow targets */
 451 const OPEN_CURRENT_BUFFER = 0; // only valid for open if the current
 452                                // buffer is a content_buffer; for
 453                                // follow, equivalent to
 454                                // FOLLOW_TOP_FRAME.
 455 const OPEN_NEW_BUFFER = 1;
 456 const OPEN_NEW_BUFFER_BACKGROUND = 2;
 457 const OPEN_NEW_WINDOW = 3;
 458
 459 const FOLLOW_DEFAULT = 4; // for open, implies OPEN_CURRENT_BUFFER
 460 const FOLLOW_CURRENT_FRAME = 5; // for open, implies OPEN_CURRENT_BUFFER
 461 const FOLLOW_TOP_FRAME = 6; // for open, implies OPEN_CURRENT_BUFFER
 462
 463 var TARGET_PROMPTS = [" in current buffer",
 464                       " in new buffer",
 465                       " in new buffer (background)",
 466                       " in new window",
 467                       "",
 468                       " in current frame",
 469                       " in top frame"];
 470
 471 var TARGET_NAMES = ["current buffer",
 472                     "new buffer",
 473                     "new buffer (background)",
 474                     "new window",
 475                     "default",
 476                     "current frame",
 477                     "top frame"];
 478
 479
 480 function browse_target_prompt(target, prefix) {
 481     if (prefix == null)
 482         prefix = "Open URL";
 483     return prefix + TARGET_PROMPTS[target] + ":";
 484 }
 485
 486
 487 var default_browse_targets = {};
 488 default_browse_targets["open"] = [OPEN_CURRENT_BUFFER, OPEN_NEW_BUFFER, OPEN_NEW_WINDOW];
 489 default_browse_targets["follow"] = [FOLLOW_DEFAULT, OPEN_NEW_BUFFER, OPEN_NEW_WINDOW];
 490 default_browse_targets["follow-top"] = [FOLLOW_TOP_FRAME, FOLLOW_CURRENT_FRAME];
 491
 492 interactive_context.prototype.browse_target = function (action) {
 493     var prefix = this.prefix_argument;
 494     var targets = action;
 495     while (typeof(targets) == "string")
 496         targets = default_browse_targets[targets];
 497     if (prefix == null || typeof(prefix) != "object")
 498         return targets[0];
 499     var num = prefix[0];
 500     var index = 0;
 501     while (num >= 4 && index + 1 < targets.length) {
 502         num = num / 4;
 503         index++;
 504     }
 505     return targets[index];
 506 };
 507
 508 function create_buffer(window, creator, target) {
 509     switch (target) {
 510     case OPEN_NEW_BUFFER:
 511         window.buffers.current = creator(window, null);
 512         break;
 513     case OPEN_NEW_BUFFER_BACKGROUND:
 514         creator(window, null);
 515         break;
 516     case OPEN_NEW_WINDOW:
 517         make_window(creator);
 518         break;
 519     default:
 520         throw new Error("invalid target");
 521     }
 522 }
 523
 524 var queued_buffer_creators = null;
 525 function _process_queued_buffer_creators(window) {
 526     for (var i = 0; i < queued_buffer_creators.length; ++i) {
 527         var x = queued_buffer_creators[i];
 528         create_buffer(window, x[0], x[1]);
 529     }
 530     queued_buffer_creators = null;
 531 }
 532 function create_buffer_in_current_window(creator, target, focus_existing) {
 533     if (target == OPEN_NEW_WINDOW)
 534         throw new Error("invalid target");
 535     var window = get_recent_conkeror_window();
 536     if (window) {
 537         if (focus_existing)
 538             window.focus();
 539         create_buffer(window, creator, target);
 540     } else if (queued_buffer_creators != null) {
 541         queued_buffer_creators.push([creator,target]);
 542     } else {
 543         queued_buffer_creators = [];
 544         window = make_window(creator);
 545         add_hook.call(window, "window_initialize_late_hook", _process_queued_buffer_creators);
 546     }
 547 }
 548
 549 minibuffer_auto_complete_preferences["buffer"] = true;
 550 define_keywords("$default");
 551 minibuffer.prototype.read_buffer = function () {
 552     var window = this.window;
 553     var buffer = this.window.buffers.current;
 554     keywords(arguments, $prompt = "Buffer:",
 555              $default = buffer,
 556              $history = "buffer");
 557     var completer = all_word_completer(
 558         $completions = function (visitor) window.buffers.for_each(visitor),
 559         $get_string = function (x) x.description,
 560         $get_description = function (x) x.title);
 561     var result = yield this.read(
 562         $prompt = arguments.$prompt,
 563         $history = arguments.$history,
 564         $completer = completer,
 565         $match_required = true,
 566         $auto_complete = "buffer",
 567         $auto_complete_initial = true,
 568         $auto_complete_delay = 0,
 569         $default_completion = arguments.$default);
 570     yield co_return(result);
 571 };
 572
 573 interactive_context.prototype.__defineGetter__("cwd", function () this.buffer.cwd);
 574
 575 function buffer_next (window, count)
 576 {
 577     var index = window.buffers.selected_index;
 578     var total = window.buffers.count;
 579     index = (index + count) % total;
 580     if (index < 0)
 581         index += total;
 582     window.buffers.current = window.buffers.get_buffer(index);
 583 }
 584 interactive("buffer-next",
 585             "Switch to the next buffer.",
 586             function (I) {buffer_next(I.window, I.p);});
 587 interactive("buffer-previous",
 588             "Switch to the previous buffer.",
 589             function (I) {buffer_next(I.window, -I.p);});
 590
 591 function switch_to_buffer (window, buffer)
 592 {
 593     if (buffer && !buffer.dead)
 594         window.buffers.current = buffer;
 595 }
 596 interactive("switch-to-buffer",
 597             "Switch to a buffer specified in the minibuffer.",
 598             function (I) {
 599                 switch_to_buffer(
 600                     I.window,
 601                     (yield I.minibuffer.read_buffer(
 602                         $prompt = "Switch to buffer:",
 603                         $default = (I.window.buffers.count > 1 ?
 604                                     I.window.buffers.buffer_list[1] :
 605                                     I.buffer)))
 606                 )
 607             });
 608
 609 define_variable("can_kill_last_buffer", true,
 610                      "If this is set to true, kill-buffer can kill the last remaining buffer, and close the window.");
 611
 612 function kill_buffer(buffer, force)
 613 {
 614     if (!buffer)
 615         return;
 616     var buffers = buffer.window.buffers;
 617     if (buffers.count == 1 && buffer == buffers.current) {
 618         if (can_kill_last_buffer || force) {
 619             delete_window(buffer.window);
 620             return;
 621         }
 622         else
 623             throw interactive_error("Can't kill last buffer.");
 624     }
 625     buffers.kill_buffer(buffer);
 626 }
 627 interactive("kill-buffer",
 628             "Kill a buffer specified in the minibuffer.\n" +
 629             "If `can_kill_last_buffer' is set to true, an attempt to kill the last remaining " +
 630             "buffer in a window will cause the window to be closed.",
 631             function (I) {kill_buffer((yield I.minibuffer.read_buffer($prompt = "Kill buffer:")))});
 632
 633 interactive("kill-current-buffer",
 634             "Kill the current buffer.\n" +
 635             "If `can_kill_last_buffer' is set to true, an attempt to kill the last remaining " +
 636             "buffer in a window will cause the window to be closed.",
 637             function (I) {kill_buffer(I.buffer)});
 638
 639 function change_directory(buffer, dir) {
 640     buffer.configuration.cwd = dir;
 641 }
 642 interactive("change-current-directory",
 643             "Change the current directory of the selected buffer.",
 644             function (I) {
 645                 change_directory(
 646                     I.buffer,
 647                     (yield I.minibuffer.read_existing_directory_path(
 648                         $prompt = "New current directory:",
 649                         $initial_value = I.cwd)));
 650             });
 651
 652 interactive("shell-command", function (I) {
 653     var cwd = I.cwd;
 654     var cmd = (yield I.minibuffer.read_shell_command($cwd = cwd));
 655     yield shell_command(cmd, $cwd = cwd);
 656 });
 657
 658 function unfocus(buffer)
 659 {
 660     var elem = buffer.focused_element;
 661     if (elem) {
 662         elem.blur();
 663         return;
 664     }
 665     var win = buffer.focused_frame;
 666     if (win != buffer.top_frame)
 667         return;
 668     buffer.top_frame.focus();
 669 }
 670 interactive("unfocus", function (I) {unfocus(I.buffer)});
 671
 672 require_later("content-buffer.js");
 673
 674 var mode_functions = {};
 675
 676 var mode_display_names = {};
 677
 678 define_buffer_local_hook("buffer_mode_change_hook");
 679 define_current_buffer_hook("current_buffer_mode_change_hook", "buffer_mode_change_hook");
 680
 681 define_keywords("$class", "$enable", "$disable", "$doc");
 682 function define_buffer_mode(name, display_name) {
 683     keywords(arguments);
 684
 685     var hyphen_name = name.replace("_","-","g");
 686     var mode_class = arguments.$class;
 687     var enable = arguments.$enable;
 688     var disable = arguments.$disable;
 689
 690     mode_display_names[name] = display_name;
 691
 692     var can_disable;
 693
 694     if (disable == false) {
 695         can_disable = false;
 696         disable = null;
 697     } else
 698         can_disable = true;
 699
 700     var state = (mode_class != null) ? mode_class : (name + "_enabled");
 701     var enable_hook_name = name + "_enable_hook";
 702     var disable_hook_name = name + "_disable_hook";
 703     define_buffer_local_hook(enable_hook_name);
 704     define_buffer_local_hook(disable_hook_name);
 705
 706     var change_hook_name = null;
 707
 708     if (mode_class) {
 709         mode_functions[name] = {enable: enable,
 710                                 disable: disable,
 711                                 mode_class: mode_class,
 712                                 disable_hook_name: disable_hook_name};
 713         change_hook_name = mode_class + "_change_hook";
 714         define_buffer_local_hook(change_hook_name);
 715     }
 716
 717     function func(buffer, arg) {
 718         var old_state = buffer[state];
 719         var cur_state = (old_state == name);
 720         var new_state = (arg == null) ? !cur_state : (arg > 0);
 721         if ((new_state == cur_state) || (!can_disable && !new_state))
 722             return null;
 723         if (new_state) {
 724             if (mode_class && old_state != null)  {
 725                 buffer.enabled_modes.splice(buffer.enabled_modes.indexOf(old_state), 1);
 726                 let x = mode_functions[old_state];
 727                 let y = x.disable;
 728                 if (y) y(buffer);
 729                 conkeror[x.disable_hook_name].run(buffer);
 730             }
 731             buffer[state] = name;
 732             if (enable)
 733                 enable(buffer);
 734             conkeror[enable_hook_name].run(buffer);
 735             buffer.enabled_modes.push(name);
 736         } else {
 737             buffer.enabled_modes.splice(buffer.enabled_modes.indexOf(name), 1);
 738             disable(buffer);
 739             conkeror[disable_hook_name].run(buffer);
 740             buffer[state] = null;
 741         }
 742         if (change_hook_name)
 743             conkeror[change_hook_name].run(buffer, buffer[state]);
 744         buffer_mode_change_hook.run(buffer);
 745         return new_state;
 746     };
 747     conkeror[name] = func;
 748     interactive(hyphen_name, arguments.$doc, function (I) {
 749         var arg = I.P;
 750         var new_state = func(I.buffer, arg && univ_arg_to_number(arg));
 751         I.minibuffer.message(hyphen_name + (new_state ? " enabled" : " disabled"));
 752     });
 753 }
 754 ignore_function_for_get_caller_source_code_reference("define_buffer_mode");
 755
 756
 757 function minibuffer_mode_indicator(window) {
 758     this.window = window;
 759     var element = create_XUL(window, "label");
 760     element.setAttribute("id", "minibuffer-mode-indicator");
 761     element.collapsed = true;
 762     element.setAttribute("class", "minibuffer");
 763     window.document.getElementById("minibuffer").appendChild(element);
 764     this.element = element;
 765     this.hook_func = method_caller(this, this.update);
 766     add_hook.call(window, "select_buffer_hook", this.hook_func);
 767     add_hook.call(window, "current_buffer_mode_change_hook", this.hook_func);
 768     this.update();
 769 }
 770 minibuffer_mode_indicator.prototype = {
 771     update : function () {
 772         var buf = this.window.buffers.current;
 773         var modes = buf.enabled_modes;
 774         var str = modes.map( function (x) {
 775             let y = mode_display_names[x];
 776             if (y)
 777                 return "[" + y + "]";
 778             else
 779                 return null;
 780         } ).filter( function (x) x != null ).join(" ");
 781         this.element.collapsed = (str.length == 0);
 782         this.element.value = str;
 783     },
 784     uninstall : function () {
 785         remove_hook.call(window, "select_buffer_hook", this.hook_fun);
 786         remove_hook.call(window, "current_buffer_mode_change_hook", this.hook_fun);
 787         this.element.parentNode.removeChild(this.element);
 788     }
 789 };
 790 define_global_window_mode("minibuffer_mode_indicator", "window_initialize_hook");
 791 minibuffer_mode_indicator_mode(true);