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 in_module(null);
  10
  11 require("mode.js");
  12
  13 var define_window_local_hook = simple_local_hook_definer();
  14 var define_window_local_coroutine_hook = simple_local_coroutine_hook_definer();
  15
  16
  17 define_hook("make_window_hook");
  18
  19 var window_watcher = Cc["@mozilla.org/embedcomp/window-watcher;1"]
  20     .getService(Ci.nsIWindowWatcher);
  21
  22 function generate_new_window_tag (tag) {
  23     var existing = [];
  24     var exact_match = false;
  25     var en = window_watcher.getWindowEnumerator();
  26     if (tag == '')
  27         tag = null;
  28     var re;
  29     if (tag)
  30         re = new RegExp ("^" + tag + "<(\\d+)>$");
  31     else
  32         re = new RegExp ("^(\\d+)$");
  33     while (en.hasMoreElements()) {
  34         var w = en.getNext().QueryInterface(Ci.nsIDOMWindow);
  35         if ('tag' in w)  {
  36             if (tag && w.tag == tag) {
  37                 exact_match = true;
  38                 continue;
  39             }
  40             var re_result = re.exec(w.tag);
  41             if (re_result)
  42                 existing.push(re_result[1]);
  43         }
  44     }
  45     if (tag && ! exact_match)
  46         return tag;
  47
  48     existing.sort(function (a, b) { return a - b; });
  49
  50     var n = 1;
  51     for (var i = 0; i < existing.length; i++) {
  52         if (existing[i] < n) continue;
  53         if (existing[i] == n) { n++; continue; }
  54         break;
  55     }
  56     if (tag)
  57         return tag + "<" + n + ">";
  58     else
  59         return n;
  60 }
  61
  62 function make_chrome_window (chrome_uri, args) {
  63     return window_watcher.openWindow(null, chrome_uri, "_blank",
  64                                      "chrome,dialog=no,all,resizable", args);
  65 }
  66
  67 var conkeror_chrome_uri = "chrome://conkeror-gui/content/conkeror.xul";
  68
  69 function make_window (initial_buffer_creator, tag) {
  70     var args = { tag: tag,
  71                  initial_buffer_creator: initial_buffer_creator };
  72     var result = make_chrome_window(conkeror_chrome_uri, null);
  73     result.args = args;
  74     make_window_hook.run(result);
  75     var close = result.close;
  76     result.close = function () {
  77         function attempt_close () {
  78             var res = yield window_before_close_hook.run(result);
  79             if (res) {
  80                 window_close_hook.run(result);
  81                 close.call(result);
  82             }
  83         }
  84         co_call(attempt_close());
  85     };
  86     return result;
  87 }
  88
  89 function get_window_by_tag (tag) {
  90     var en = window_watcher.getWindowEnumerator();
  91     while (en.hasMoreElements()) {
  92         var w = en.getNext().QueryInterface(Ci.nsIDOMWindow);
  93         if ('tag' in w && w.tag == tag)
  94             return w;
  95     }
  96     return null;
  97 }
  98
  99 /* FIXME: decide if this should include not-fully-initialized windows  */
 100 function for_each_window (func) {
 101     var en = window_watcher.getWindowEnumerator();
 102     while (en.hasMoreElements()) {
 103         var w = en.getNext().QueryInterface(Ci.nsIDOMWindow);
 104         if ('conkeror' in w)
 105             func(w);
 106     }
 107 }
 108
 109 function get_recent_conkeror_window () {
 110     var wm = Cc['@mozilla.org/appshell/window-mediator;1']
 111        .getService(Ci.nsIWindowMediator);
 112     var window = wm.getMostRecentWindow("navigator:browser");
 113     if (window && ("conkeror" in window))
 114         return window;
 115     var en = window_watcher.getWindowEnumerator();
 116     while (en.hasMoreElements()) {
 117         window = en.getNext().QueryInterface(Ci.nsIDOMWindow);
 118         if ('conkeror' in window)
 119             return window;
 120     }
 121     return null;
 122 }
 123
 124 define_window_local_hook("window_initialize_early_hook");
 125 define_window_local_hook("window_initialize_hook");
 126 define_window_local_hook("window_initialize_late_hook");
 127
 128 var window_extra_argument_list = [];
 129
 130 define_variable("window_extra_argument_max_delay", 100);
 131
 132 function window_setup_args (window) {
 133     if (window.args != null)
 134         return;
 135
 136     var cur_time = Date.now();
 137     var i;
 138     var result = null;
 139     for (i = 0; i < window_extra_argument_list.length; ++i) {
 140         var a = window_extra_argument_list[i];
 141         if (a.time > cur_time - window_extra_argument_max_delay) {
 142             delete a.time;
 143             result = a;
 144             i++;
 145             break;
 146         }
 147     }
 148     window_extra_argument_list = window_extra_argument_list.slice(i);
 149
 150     if (result == null)
 151         window.args = {};
 152     else
 153         window.args = result;
 154 }
 155
 156 function window_set_extra_arguments (args) {
 157     args.time = Date.now();
 158     window_extra_argument_list.push(args);
 159 }
 160
 161 function window_get_this_browser () {
 162     return this.buffers.current.browser;
 163 }
 164
 165 function window_initialize (window) {
 166     window.conkeror = conkeror;
 167
 168     // Used by get_window_from_frame to get an unwrapped window reference
 169     window.escape_wrapper = function (x) { x(window); };
 170
 171     window_setup_args(window);
 172
 173     // Set tag
 174     var tag = null;
 175     if ('tag' in window.args)
 176         tag = window.args.tag;
 177     window.tag = generate_new_window_tag(tag);
 178
 179     // Add a getBrowser() function to help certain extensions designed
 180     // for Firefox work with conkeror
 181     window.getBrowser = window_get_this_browser;
 182
 183     window_initialize_early_hook.run(window);
 184     delete window.window_initialize_early_hook; // used only once
 185
 186     window_initialize_hook.run(window);
 187     delete window.window_initialize_hook; // used only once
 188
 189     window.setTimeout(function () {
 190             window_initialize_late_hook.run(window);
 191             delete window.window_initialize_late_hook; // used only once
 192             delete window.args; // get rid of args
 193         }, 0);
 194
 195     window.addEventListener("close",
 196                             function (event) {
 197                                 event.preventDefault();
 198                                 event.stopPropagation();
 199                                 this.close();
 200                             },
 201                             true /* capture */);
 202 }
 203
 204 define_window_local_coroutine_hook("window_before_close_hook",
 205                                    RUN_HOOK_UNTIL_FAILURE);
 206 define_window_local_hook("window_close_hook", RUN_HOOK);
 207
 208 /*
 209  * Window Modes
 210  */
 211
 212 function define_global_window_mode (name, hook_name) {
 213     function install (window) {
 214         if (name in window)
 215             throw new Error(name + " already initialized for window");
 216         window[name] = new conkeror[name](window);
 217     }
 218     function uninstall (window) {
 219         if (!window[name])
 220             throw new Error(name + " not initialized for window");
 221         window[name].uninstall();
 222         delete window[name];
 223     }
 224     define_global_mode(name + "_mode",
 225                        function () { // enable
 226                            add_hook(hook_name, install);
 227                            for_each_window(install);
 228                        },
 229                        function () { // disable
 230                            remove_hook(hook_name, install);
 231                            for_each_window(uninstall);
 232                        });
 233 }
 234 ignore_function_for_get_caller_source_code_reference("define_global_window_mode");
 235
 236
 237
 238 /*
 239  * Window Title
 240  */
 241
 242 /**
 243  * Default tile formatter.  The page url is ignored.  If there is a
 244  * page_title, returns: "Page title - Conkeror".  Otherwise, it
 245  * returns just: "Conkeror".
 246  */
 247 function default_title_formatter (window) {
 248     var page_title = window.buffers.current.title;
 249
 250     if (page_title && page_title.length > 0)
 251         return page_title + " - Conkeror";
 252     else
 253         return "Conkeror";
 254 }
 255
 256 var title_format_fn = null;
 257
 258 function set_window_title (window) {
 259     window.document.title = title_format_fn(window);
 260 }
 261
 262 function init_window_title () {
 263     title_format_fn = default_title_formatter;
 264
 265     add_hook("window_initialize_late_hook", set_window_title);
 266     add_hook("current_content_buffer_location_change_hook",
 267              function (buffer) {
 268                  set_window_title(buffer.window);
 269              });
 270     add_hook("select_buffer_hook",
 271              function (buffer) {
 272                  set_window_title(buffer.window);
 273              }, true);
 274     add_hook("current_buffer_title_change_hook",
 275              function (buffer) {
 276                  set_window_title(buffer.window);
 277              });
 278 }
 279
 280 init_window_title();
 281
 282
 283 function call_builtin_command (window, command, clear_mark) {
 284     var m = window.minibuffer;
 285     if (m.active && m._input_mode_enabled) {
 286         m._restore_normal_state();
 287         var e = m.input_element;
 288         var c = e.controllers.getControllerForCommand(command);
 289         try {
 290             if (c && c.isCommandEnabled(command))
 291                 c.doCommand(command);
 292         } catch (e) {
 293             // ignore errors
 294         }
 295         if (clear_mark)
 296             m.current_state.mark_active = false;
 297     } else {
 298         function attempt_command (element) {
 299             var c;
 300             if (element.controllers
 301                 && (c = element.controllers.getControllerForCommand(command)) != null
 302                 && c.isCommandEnabled(command))
 303             {
 304                 try {
 305                     c.doCommand(command);
 306                 } catch (e) {
 307                     // ignore errors
 308                 }
 309                 if (clear_mark)
 310                     window.buffers.current.mark_active = false;
 311                 return true;
 312             }
 313             return false;
 314         }
 315         var element = window.buffers.current.focused_element;
 316         if (element && attempt_command(element, command))
 317             return;
 318         var win = window.buffers.current.focused_frame;
 319         while (true) {
 320             if (attempt_command(win, command))
 321                 return;
 322             if (!win.parent || win == win.parent)
 323                 break;
 324             win = win.parent;
 325         }
 326     }
 327 }
 328
 329
 330 /**
 331  * window_set_full_screen sets or toggles the fullScreen and hideChrome
 332  * properties of the given window.  When fullscreen is a boolean, it sets
 333  * it to that value.  When it is null or not given, it toggles the current
 334  * value.
 335  */
 336 function window_set_full_screen (window, fullscreen) {
 337     if (fullscreen === true || fullscreen === false) {
 338         window.fullScreen = fullscreen;
 339         window.hideChrome = fullscreen;
 340     } else {
 341         window.fullScreen = ! window.fullScreen;
 342         window.hideChrome = window.fullScreen;
 343     }
 344 }
 345
 346
 347 provide("window");