modules/window.js

   1 /**
   2  * (C) Copyright 2007 John J. Foerch
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  *
   5  * Use, modification, and distribution are subject to the terms specified in the
   6  * COPYING file.
   7 **/
   8
   9 require("mode.js");
  10
  11 var define_window_local_hook = simple_local_hook_definer();
  12 var define_window_local_coroutine_hook = simple_local_coroutine_hook_definer();
  13
  14
  15 define_hook("make_window_hook");
  16
  17 var window_watcher = Cc["@mozilla.org/embedcomp/window-watcher;1"]
  18     .getService(Ci.nsIWindowWatcher);
  19
  20 function generate_new_window_tag (tag) {
  21     var existing = [];
  22     var exact_match = false;
  23     var en = window_watcher.getWindowEnumerator();
  24     if (tag == '')
  25         tag = null;
  26     var re;
  27     if (tag)
  28         re = new RegExp ("^" + tag + "<(\\d+)>$");
  29     else
  30         re = new RegExp ("^(\\d+)$");
  31     while (en.hasMoreElements()) {
  32         var w = en.getNext().QueryInterface(Ci.nsIDOMWindow);
  33         if ('tag' in w)  {
  34             if (tag && w.tag == tag) {
  35                 exact_match = true;
  36                 continue;
  37             }
  38             var re_result = re.exec(w.tag);
  39             if (re_result)
  40                 existing.push(re_result[1]);
  41         }
  42     }
  43     if (tag && ! exact_match)
  44         return tag;
  45
  46     existing.sort(function (a, b) { return a - b; });
  47
  48     var n = 1;
  49     for (var i = 0; i < existing.length; i++) {
  50         if (existing[i] < n) continue;
  51         if (existing[i] == n) { n++; continue; }
  52         break;
  53     }
  54     if (tag)
  55         return tag + "<" + n + ">";
  56     else
  57         return n;
  58 }
  59
  60 function make_chrome_window (chrome_uri, args) {
  61     return window_watcher.openWindow(null, chrome_uri, "_blank",
  62                                      "chrome,dialog=no,all,resizable", args);
  63 }
  64
  65 var conkeror_chrome_uri = "chrome://conkeror-gui/content/conkeror.xul";
  66
  67 function make_window (initial_buffer_creator, tag) {
  68     var args = { tag: tag,
  69                  initial_buffer_creator: initial_buffer_creator };
  70     var result = make_chrome_window(conkeror_chrome_uri, null);
  71     result.args = args;
  72     make_window_hook.run(result);
  73     var close = result.close;
  74     result.close = function () {
  75         function attempt_close () {
  76             var res = yield window_before_close_hook.run(result);
  77             if (res) {
  78                 window_close_hook.run(result);
  79                 close.call(result);
  80             }
  81         }
  82         co_call(attempt_close());
  83     };
  84     return result;
  85 }
  86
  87 function get_window_by_tag (tag) {
  88     var en = window_watcher.getWindowEnumerator();
  89     while (en.hasMoreElements()) {
  90         var w = en.getNext().QueryInterface(Ci.nsIDOMWindow);
  91         if ('tag' in w && w.tag == tag)
  92             return w;
  93     }
  94     return null;
  95 }
  96
  97 /* FIXME: decide if this should include not-fully-initialized windows  */
  98 function for_each_window (func) {
  99     var en = window_watcher.getWindowEnumerator();
 100     while (en.hasMoreElements()) {
 101         var w = en.getNext().QueryInterface(Ci.nsIDOMWindow);
 102         if ('conkeror' in w)
 103             func(w);
 104     }
 105 }
 106
 107 function get_recent_conkeror_window () {
 108     var window = window_watcher.activeWindow;
 109     if (window && ("conkeror" in window))
 110         return window;
 111     var en = window_watcher.getWindowEnumerator();
 112     while (en.hasMoreElements()) {
 113         window = en.getNext().QueryInterface(Ci.nsIDOMWindow);
 114         if ('conkeror' in window)
 115             return window;
 116     }
 117     return null;
 118 }
 119
 120 define_window_local_hook("window_initialize_early_hook");
 121 define_window_local_hook("window_initialize_hook");
 122 define_window_local_hook("window_initialize_late_hook");
 123
 124 var window_extra_argument_list = [];
 125
 126 define_variable("window_extra_argument_max_delay", 100);
 127
 128 function window_setup_args (window) {
 129     if (window.args != null)
 130         return;
 131
 132     var cur_time = Date.now();
 133     var i;
 134     var result = null;
 135     for (i = 0; i < window_extra_argument_list.length; ++i) {
 136         var a = window_extra_argument_list[i];
 137         if (a.time > cur_time - window_extra_argument_max_delay) {
 138             delete a.time;
 139             result = a;
 140             i++;
 141             break;
 142         }
 143     }
 144     window_extra_argument_list = window_extra_argument_list.slice(i);
 145
 146     if (result == null)
 147         window.args = {};
 148     else
 149         window.args = result;
 150 }
 151
 152 function window_set_extra_arguments (args) {
 153     args.time = Date.now();
 154     window_extra_argument_list.push(args);
 155 }
 156
 157 function window_get_this_browser () {
 158     return this.buffers.current.browser;
 159 }
 160
 161 function window_initialize (window) {
 162     window.conkeror = conkeror;
 163
 164     // Used by get_window_from_frame to get an unwrapped window reference
 165     window.escape_wrapper = function (x) { x(window); };
 166
 167     window_setup_args(window);
 168
 169     // Set tag
 170     var tag = null;
 171     if ('tag' in window.args)
 172         tag = window.args.tag;
 173     window.tag = generate_new_window_tag(tag);
 174
 175     // Add a getBrowser() function to help certain extensions designed
 176     // for Firefox work with conkeror
 177     window.getBrowser = window_get_this_browser;
 178
 179     window_initialize_early_hook.run(window);
 180     delete window.window_initialize_early_hook; // used only once
 181
 182     window_initialize_hook.run(window);
 183     delete window.window_initialize_hook; // used only once
 184
 185     window.setTimeout(function () {
 186             window_initialize_late_hook.run(window);
 187             delete window.window_initialize_late_hook; // used only once
 188             delete window.args; // get rid of args
 189         }, 0);
 190
 191     window.addEventListener("close",
 192                             function (event) {
 193                                 event.preventDefault();
 194                                 event.stopPropagation();
 195                                 this.close();
 196                             },
 197                             true /* capture */);
 198 }
 199
 200 define_window_local_coroutine_hook("window_before_close_hook",
 201                                    RUN_HOOK_UNTIL_FAILURE);
 202 define_window_local_hook("window_close_hook", RUN_HOOK);
 203
 204
 205 function define_global_window_mode (name, hook_name) {
 206     function install (window) {
 207         if (name in window)
 208             throw new Error(name + " already initialized for window");
 209         window[name] = new conkeror[name](window);
 210     }
 211     function uninstall (window) {
 212         if (!window[name])
 213             throw new Error(name + " not initialized for window");
 214         window[name].uninstall();
 215         delete window[name];
 216     }
 217     define_global_mode(name + "_mode",
 218                        function () { // enable
 219                            add_hook(hook_name, install);
 220                            for_each_window(install);
 221                        },
 222                        function () { // disable
 223                            remove_hook(hook_name, install);
 224                            for_each_window(uninstall);
 225                        });
 226 }
 227 ignore_function_for_get_caller_source_code_reference("define_global_window_mode");
 228
 229
 230
 231 /// Window title formatting
 232
 233 /**
 234  * Default tile formatter.  The page url is ignored.  If there is a
 235  * page_title, returns: "Page title - Conkeror".  Otherwise, it
 236  * returns just: "Conkeror".
 237  */
 238 function default_title_formatter (window) {
 239     var page_title = window.buffers.current.title;
 240
 241     if (page_title && page_title.length > 0)
 242         return page_title + " - Conkeror";
 243     else
 244         return "Conkeror";
 245 }
 246
 247 var title_format_fn = null;
 248
 249 function set_window_title (window) {
 250     window.document.title = title_format_fn(window);
 251 }
 252
 253 function init_window_title () {
 254     title_format_fn = default_title_formatter;
 255
 256     add_hook("window_initialize_late_hook", set_window_title);
 257     add_hook("current_content_buffer_location_change_hook",
 258              function (buffer) {
 259                  set_window_title(buffer.window);
 260              });
 261     add_hook("select_buffer_hook",
 262              function (buffer) {
 263                  set_window_title(buffer.window);
 264              }, true);
 265     add_hook("current_buffer_title_change_hook",
 266              function (buffer) {
 267                  set_window_title(buffer.window);
 268              });
 269 }
 270
 271 init_window_title();