gecko/browser/base/content/AllTabs.js

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is TabView AllTabs.
 *
 * The Initial Developer of the Original Code is
 * Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2010
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * Edward Lee <edilee@mozilla.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

const Cc = Components.classes;
const Ci = Components.interfaces;
const Cu = Components.utils;
const Cr = Components.results;

Cu.import("resource://gre/modules/Services.jsm");

let EXPORTED_SYMBOLS = ["AllTabs"];

let AllTabs = {
  //////////////////////////////////////////////////////////////////////////////
  //// Public
  //////////////////////////////////////////////////////////////////////////////

  /**
   * Get an array of all tabs from all tabbrowser windows.
   *
   * @usage let numAllTabs = AllTabs.tabs.length;
   *        AllTabs.tabs.forEach(handleAllTabs);
   */
  get tabs() {
    // Get tabs from each browser window and flatten them into one array
    let browserWindows = AllTabs.allBrowserWindows;
    return Array.concat.apply({}, browserWindows.map(function(browserWindow) {
      return Array.slice(browserWindow.gBrowser.tabs);
    }));
  },

  /**
   * Attach a callback for when a tab's attributes change such as title, busy
   * state, icon, etc.
   *
   * There is also an unbind method off of this method to remove the callback.
   *
   * @param callback
   *        Callback that gets called with the tab being changed as "this" and
   *        the event as the first argument.
   * @usage AllTabs.onChange(handleChange);
   *        AllTabs.onChange.unbind(handleChange);
   */
  get onChange() AllTabs.makeBind("onChange"),

  /**
   * Attach a callback for when a tab is closed.
   *
   * There is also an unbind method off of this method to remove the callback.
   *
   * @param callback
   *        Callback that gets called with the tab being closed as "this" and
   *        the event as the first argument.
   * @usage AllTabs.onClose(handleClose);
   *        AllTabs.onClose.unbind(handleClose);
   */
  get onClose() AllTabs.makeBind("onClose"),

  /**
   * Attach a callback for when a tab is moved.
   *
   * There is also an unbind method off of this method to remove the callback.
   *
   * @param callback
   *        Callback that gets called with the tab being moved as "this" and
   *        the event as the first argument.
   * @usage AllTabs.onMove(handleMove);
   *        AllTabs.onMove.unbind(handleMove);
   */
  get onMove() AllTabs.makeBind("onMove"),

  /**
   * Attach a callback for when a tab is opened.
   *
   * There is also an unbind method off of this method to remove the callback.
   *
   * @param callback
   *        Callback that gets called with the tab being opened as "this" and
   *        the event as the first argument.
   * @usage AllTabs.onOpen(handleOpen);
   *        AllTabs.onOpen.unbind(handleOpen);
   */
  get onOpen() AllTabs.makeBind("onOpen"),

  /**
   * Attach a callback for when a tab is selected.
   *
   * There is also an unbind method off of this method to remove the callback.
   *
   * @param callback
   *        Callback that gets called with the tab being selected as "this" and
   *        the event as the first argument.
   * @usage AllTabs.onSelect(handleSelect);
   *        AllTabs.onSelect.unbind(handleSelect);
   */
  get onSelect() AllTabs.makeBind("onSelect"),

  //////////////////////////////////////////////////////////////////////////////
  //// Private
  //////////////////////////////////////////////////////////////////////////////

  get allBrowserWindows() {
    let browserWindows = [];
    let windows = Services.wm.getEnumerator("navigator:browser");
    while (windows.hasMoreElements())
      browserWindows.push(windows.getNext());
    return browserWindows;
  },

  eventMap: {
    TabAttrModified: "onChange",
    TabClose: "onClose",
    TabMove: "onMove",
    TabOpen: "onOpen",
    TabSelect: "onSelect",
  },

  registerBrowserWindow: function registerBrowserWindow(browserWindow) {
    // Add a listener for each tab even to trigger the matching topic
    [i for (i in Iterator(AllTabs.eventMap))].forEach(function([tabEvent, topic]) {
      browserWindow.addEventListener(tabEvent, function(event) {
        AllTabs.trigger(topic, event.originalTarget, event);
      }, true);
    });
  },

  listeners: {},

  makeBind: function makeBind(topic) {
    delete AllTabs[topic];
    AllTabs.listeners[topic] = [];

    // Allow adding listeners to this topic
    AllTabs[topic] = function bind(callback) {
      AllTabs.listeners[topic].push(callback);
    };

    // Allow removing listeners from this topic
    AllTabs[topic].unbind = function unbind(callback) {
      let index = AllTabs.listeners[topic].indexOf(callback);
      if (index != -1)
        AllTabs.listeners[topic].splice(index, 1);
    };

    return AllTabs[topic];
  },

  trigger: function trigger(topic, tab, event) {
    // Make sure we've gotten listeners before trying to call
    let listeners = AllTabs.listeners[topic];
    if (listeners == null)
      return;

    // Make a copy of the listeners, so it can't change as we call back
    listeners.slice().forEach(function(callback) {
      try {
        callback.call(tab, event);
      }
      // Ignore failures from the callback
      catch(ex) {}
    });
  },

  //////////////////////////////////////////////////////////////////////////////
  //// nsIObserver
  //////////////////////////////////////////////////////////////////////////////

  observe: function observe(subject, topic, data) {
    switch (topic) {
      case "domwindowopened":
        subject.addEventListener("load", function() {
          subject.removeEventListener("load", arguments.callee, false);

          // Now that the window has loaded, only register on browser windows
          let doc = subject.document.documentElement;
          if (doc.getAttribute("windowtype") == "navigator:browser")
            AllTabs.registerBrowserWindow(subject);
        }, false);
        break;
    }
  },
};

// Register listeners on all browser windows and future ones
AllTabs.allBrowserWindows.forEach(AllTabs.registerBrowserWindow);
Services.obs.addObserver(AllTabs, "domwindowopened", false);