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 wm = Cc['@mozilla.org/appshell/window-mediator;1']
 109        .getService(Ci.nsIWindowMediator);
 110     var window = wm.getMostRecentWindow("navigator:browser");
 111     if (window && ("conkeror" in window))
 112         return window;
 113     var en = window_watcher.getWindowEnumerator();
 114     while (en.hasMoreElements()) {
 115         window = en.getNext().QueryInterface(Ci.nsIDOMWindow);
 116         if ('conkeror' in window)
 117             return window;
 118     }
 119     return null;
 120 }
 121
 122 define_window_local_hook("window_initialize_early_hook");
 123 define_window_local_hook("window_initialize_hook");
 124 define_window_local_hook("window_initialize_late_hook");
 125
 126 var window_extra_argument_list = [];
 127
 128 define_variable("window_extra_argument_max_delay", 100);
 129
 130 function window_setup_args (window) {
 131     if (window.args != null)
 132         return;
 133
 134     var cur_time = Date.now();
 135     var i;
 136     var result = null;
 137     for (i = 0; i < window_extra_argument_list.length; ++i) {
 138         var a = window_extra_argument_list[i];
 139         if (a.time > cur_time - window_extra_argument_max_delay) {
 140             delete a.time;
 141             result = a;
 142             i++;
 143             break;
 144         }
 145     }
 146     window_extra_argument_list = window_extra_argument_list.slice(i);
 147
 148     if (result == null)
 149         window.args = {};
 150     else
 151         window.args = result;
 152 }
 153
 154 function window_set_extra_arguments (args) {
 155     args.time = Date.now();
 156     window_extra_argument_list.push(args);
 157 }
 158
 159 function window_get_this_browser () {
 160     return this.buffers.current.browser;
 161 }
 162
 163 function window_initialize (window) {
 164     window.conkeror = conkeror;
 165
 166     // Used by get_window_from_frame to get an unwrapped window reference
 167     window.escape_wrapper = function (x) { x(window); };
 168
 169     window_setup_args(window);
 170
 171     // Set tag
 172     var tag = null;
 173     if ('tag' in window.args)
 174         tag = window.args.tag;
 175     window.tag = generate_new_window_tag(tag);
 176
 177     // Add a getBrowser() function to help certain extensions designed
 178     // for Firefox work with conkeror
 179     window.getBrowser = window_get_this_browser;
 180
 181     window_initialize_early_hook.run(window);
 182     delete window.window_initialize_early_hook; // used only once
 183
 184     window_initialize_hook.run(window);
 185     delete window.window_initialize_hook; // used only once
 186
 187     window.setTimeout(function () {
 188             window_initialize_late_hook.run(window);
 189             delete window.window_initialize_late_hook; // used only once
 190             delete window.args; // get rid of args
 191         }, 0);
 192
 193     window.addEventListener("close",
 194                             function (event) {
 195                                 event.preventDefault();
 196                                 event.stopPropagation();
 197                                 this.close();
 198                             },
 199                             true /* capture */);
 200 }
 201
 202 define_window_local_coroutine_hook("window_before_close_hook",
 203                                    RUN_HOOK_UNTIL_FAILURE);
 204 define_window_local_hook("window_close_hook", RUN_HOOK);
 205
 206 /*
 207  * Window Modes
 208  */
 209
 210 function define_global_window_mode (name, hook_name) {
 211     function install (window) {
 212         if (name in window)
 213             throw new Error(name + " already initialized for window");
 214         window[name] = new conkeror[name](window);
 215     }
 216     function uninstall (window) {
 217         if (!window[name])
 218             throw new Error(name + " not initialized for window");
 219         window[name].uninstall();
 220         delete window[name];
 221     }
 222     define_global_mode(name + "_mode",
 223                        function () { // enable
 224                            add_hook(hook_name, install);
 225                            for_each_window(install);
 226                        },
 227                        function () { // disable
 228                            remove_hook(hook_name, install);
 229                            for_each_window(uninstall);
 230                        });
 231 }
 232 ignore_function_for_get_caller_source_code_reference("define_global_window_mode");
 233
 234
 235
 236 /*
 237  * Window Title
 238  */
 239
 240 /**
 241  * Default tile formatter.  The page url is ignored.  If there is a
 242  * page_title, returns: "Page title - Conkeror".  Otherwise, it
 243  * returns just: "Conkeror".
 244  */
 245 function default_title_formatter (window) {
 246     var page_title = window.buffers.current.title;
 247
 248     if (page_title && page_title.length > 0)
 249         return page_title + " - Conkeror";
 250     else
 251         return "Conkeror";
 252 }
 253
 254 var title_format_fn = null;
 255
 256 function set_window_title (window) {
 257     window.document.title = title_format_fn(window);
 258 }
 259
 260 function init_window_title () {
 261     title_format_fn = default_title_formatter;
 262
 263     add_hook("window_initialize_late_hook", set_window_title);
 264     add_hook("current_content_buffer_location_change_hook",
 265              function (buffer) {
 266                  set_window_title(buffer.window);
 267              });
 268     add_hook("select_buffer_hook",
 269              function (buffer) {
 270                  set_window_title(buffer.window);
 271              }, true);
 272     add_hook("current_buffer_title_change_hook",
 273              function (buffer) {
 274                  set_window_title(buffer.window);
 275              });
 276 }
 277
 278 init_window_title();
 279
 280
 281 function call_builtin_command (window, command, clear_mark) {
 282     var m = window.minibuffer;
 283     if (m.active && m._input_mode_enabled) {
 284         m._restore_normal_state();
 285         var e = m.input_element;
 286         var c = e.controllers.getControllerForCommand(command);
 287         try {
 288             if (c && c.isCommandEnabled(command))
 289                 c.doCommand(command);
 290         } catch (e) {
 291             // ignore errors
 292         }
 293         if (clear_mark)
 294             m.current_state.mark_active = false;
 295     } else {
 296         function attempt_command (element) {
 297             var c;
 298             if (element.controllers
 299                 && (c = element.controllers.getControllerForCommand(command)) != null
 300                 && c.isCommandEnabled(command))
 301             {
 302                 try {
 303                     c.doCommand(command);
 304                 } catch (e) {
 305                     // ignore errors
 306                 }
 307                 if (clear_mark)
 308                     window.buffers.current.mark_active = false;
 309                 return true;
 310             }
 311             return false;
 312         }
 313         var element = window.buffers.current.focused_element;
 314         if (element && attempt_command(element, command))
 315             return;
 316         var win = window.buffers.current.focused_frame;
 317         while (true) {
 318             if (attempt_command(win, command))
 319                 return;
 320             if (!win.parent || win == win.parent)
 321                 break;
 322             win = win.parent;
 323         }
 324     }
 325 }
 326
 327
 328 /**
 329  * window_set_full_screen sets or toggles the fullScreen and hideChrome
 330  * properties of the given window.  When fullscreen is a boolean, it sets
 331  * it to that value.  When it is null or not given, it toggles the current
 332  * value.
 333  */
 334 function window_set_full_screen (window, fullscreen) {
 335     if (fullscreen === true || fullscreen === false) {
 336         window.fullScreen = fullscreen;
 337         window.hideChrome = fullscreen;
 338     } else {
 339         window.fullScreen = ! window.fullScreen;
 340         window.hideChrome = window.fullScreen;
 341     }
 342 }
 343
 344
 345 provide("window");