modules/mode-line.js

   1 /**
   2  * (C) Copyright 2005 Shawn Betts
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  * (C) Copyright 2010-2012 John J. Foerch
   5  *
   6  * Use, modification, and distribution are subject to the terms specified in the
   7  * COPYING file.
   8 **/
   9
  10 require("mode.js");
  11
  12 define_window_local_hook("mode_line_hook");
  13
  14 define_keywords("$flex", "$align", "$class", "$crop");
  15 function generic_element_widget_container (window, container) {
  16     this.window = window;
  17     this.container = container;
  18 }
  19 generic_element_widget_container.prototype = {
  20     constructor: generic_element_widget_container,
  21     add_text_widget: function (widget) {
  22         keywords(arguments, $flex = widget.flex,
  23                  $class = widget.class_name, $crop = widget.crop);
  24         var flex = arguments.$flex;
  25         var class_name = arguments.$class;
  26         var align = arguments.$align;
  27         var crop = arguments.$crop;
  28         var element = create_XUL(this.window, "label");
  29         if (flex)
  30             element.setAttribute("flex", flex);
  31         if (align)
  32             element.setAttribute("align", align);
  33         if (class_name)
  34             element.setAttribute("class", class_name);
  35         if (crop)
  36             element.setAttribute("crop", crop);
  37         return this.add_widget(widget, element);
  38     },
  39     add_widget: function (widget, element) {
  40         element.conkeror_widget = new generic_widget_element(element, widget);
  41         this.container.appendChild(element);
  42         return element.conkeror_widget;
  43     },
  44     destroy: function () {
  45         var children = this.container.childNodes;
  46         for (var i = 0, nchildren = children.length; i < nchildren; ++i)
  47             children.item(i).conkeror_widget.destroy();
  48     }
  49 };
  50
  51 function mode_line (window) {
  52     var element = create_XUL(window, "hbox");
  53     element.setAttribute("class", "mode-line");
  54     /* FIXME: this will need to changed to be buffer-local */
  55     var insert_before = window.document.getElementById("minibuffer");
  56     insert_before.parentNode.insertBefore(element, insert_before);
  57     window.mode_line = this;
  58     generic_element_widget_container.call(this, window, element);
  59     mode_line_hook.run(window, this);
  60 }
  61 mode_line.prototype = {
  62     constructor: mode_line,
  63     __proto__: generic_element_widget_container.prototype,
  64     toString: function () "#<mode_line>",
  65
  66     uninstall: function () {
  67         this.container.parentNode.removeChild(this.window.mode_line.container);
  68         generic_element_widget_container.prototype.destroy.call(this);
  69     }
  70 };
  71
  72
  73 function generic_widget_element (element, widget) {
  74     this.element = element;
  75     this.widget = widget;
  76     widget.attach(this);
  77 }
  78 generic_widget_element.prototype = {
  79     constructor: generic_widget_element,
  80     get text () {
  81         return this.element.getAttribute("value");
  82     },
  83
  84     set text (v) {
  85         this.element.setAttribute("value", v);
  86     },
  87
  88     destroy: function () {
  89         this.widget.destroy();
  90     },
  91
  92     remove: function () {
  93         this.element.parentNode.removeChild(this.element);
  94         this.destroy();
  95     }
  96 };
  97
  98
  99 function text_widget (window) {
 100     this.window_hooks = [];
 101     this.window = window;
 102 }
 103 text_widget.prototype = {
 104     constructor: text_widget,
 105     add_hook: function (hook_name, handler) {
 106         var obj = this;
 107         if (handler == null)
 108             handler = function () { obj.update(); };
 109         add_hook.call(this.window, hook_name, handler);
 110         this.window_hooks.push([hook_name, handler]);
 111     },
 112
 113     view: null,
 114
 115     attach: function (view) {
 116         this.view = view;
 117         this.update();
 118     },
 119
 120     update: function () {},
 121
 122     destroy: function () {
 123         for each (let i in this.window_hooks) {
 124             remove_hook.call(this.window, i[0], i[1]);
 125         }
 126     },
 127
 128     remove: function () {
 129         this.view.remove();
 130     }
 131 };
 132
 133
 134 define_global_window_mode("mode_line", "window_initialize_early_hook");
 135
 136
 137 /**
 138  * current_buffer_name_widget shows the name of the current buffer.
 139  */
 140 function current_buffer_name_widget (window) {
 141     this.class_name = "current-buffer-name-widget";
 142     text_widget.call(this, window);
 143     this.flex = "1";
 144     this.crop = "end";
 145     this.add_hook("current_content_buffer_location_change_hook");
 146     this.add_hook("select_buffer_hook");
 147 }
 148 current_buffer_name_widget.prototype = {
 149     constructor: current_buffer_name_widget,
 150     __proto__: text_widget.prototype,
 151     update: function () {
 152         this.view.text = this.window.buffers.current.description;
 153     }
 154 };
 155
 156
 157 /**
 158  * current_buffer_scroll_position_widget shows the vertical and horizontal
 159  * scroll position of the current buffer.
 160  */
 161 function current_buffer_scroll_position_widget (window) {
 162     this.class_name = "current-buffer-scroll-position-widget";
 163     text_widget.call(this, window);
 164     this.add_hook("current_buffer_scroll_hook");
 165     this.add_hook("select_buffer_hook");
 166     this.add_hook("current_content_buffer_location_change_hook");
 167     this.add_hook("current_content_buffer_focus_change_hook");
 168     this.add_hook("current_special_buffer_generated_hook");
 169 }
 170 current_buffer_scroll_position_widget.prototype = {
 171     constructor: current_buffer_scroll_position_widget,
 172     __proto__: text_widget.prototype,
 173     update: function () {
 174         var b = this.window.buffers.current;
 175         var scrollX, scrollY, scrollMaxX, scrollMaxY;
 176         var w = b.focused_frame;
 177         scrollX = w.scrollX;
 178         scrollY = w.scrollY;
 179         scrollMaxX = w.scrollMaxX;
 180         scrollMaxY = w.scrollMaxY;
 181         var x = scrollMaxX == 0 ? 100 : Math.round(scrollX / scrollMaxX * 100);
 182         var y = scrollMaxY == 0 ? 100 : Math.round(scrollY / scrollMaxY * 100);
 183         this.view.text = "(" + x + ", " + y + ")";
 184     }
 185 };
 186
 187
 188 /**
 189  * clock_widget shows a clock.
 190  */
 191 define_variable("clock_time_format", "%R",
 192     "Format string for the mode-line clock widget.\n"+
 193     "It takes the same format as strftime() in C. "+
 194     "See http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html "+
 195     "for details.");
 196
 197 function clock_widget (window) {
 198     this.class_name = "clock-widget";
 199     text_widget.call(this, window);
 200     var obj = this;
 201     this.do_update = function () { obj.update(); };
 202     // todo: use one timer for multiple clock widgets
 203     this.timer_ID = window.setTimeout(this.do_update, 0);
 204     this.timer_timeout = true;
 205 }
 206 clock_widget.prototype = {
 207     constructor: clock_widget,
 208     __proto__: text_widget.prototype,
 209     update: function () {
 210         var time = new Date();
 211         this.view.text = time.toLocaleFormat(clock_time_format);
 212         if (time.getSeconds() > 0 || time.getMilliseconds() > 100) {
 213             this.window.clearTimeout(this.timer_ID);
 214             var time = time.getSeconds() * 1000 + time.getMilliseconds();
 215             time = 60000 - time;
 216             this.timer_ID = this.window.setTimeout(this.do_update, time);
 217             this.timer_timeout = true;
 218         } else if (this.timer_timeout) {
 219             this.window.clearTimeout(this.timer_ID);
 220             this.timer_ID = this.window.setInterval(this.do_update, 60000);
 221             this.timer_timeout = false;
 222         }
 223     },
 224     destroy: function () {
 225         this.window.clearTimeout(this.timer_ID);
 226     }
 227 };
 228
 229
 230 /**
 231  * buffer_count_widget shows the number of buffers in the window.
 232  */
 233 function buffer_count_widget (window) {
 234     this.class_name = "buffer-count-widget";
 235     text_widget.call(this, window);
 236     this.add_hook("select_buffer_hook");
 237     this.add_hook("create_buffer_hook");
 238     this.add_hook("kill_buffer_hook");
 239     this.add_hook("move_buffer_hook");
 240 }
 241 buffer_count_widget.prototype = {
 242     constructor: buffer_count_widget,
 243     __proto__: text_widget.prototype,
 244     update: function () {
 245         this.view.text = ("[" + (this.window.buffers.selected_index+1) + "/" +
 246                           this.window.buffers.count + "]");
 247     }
 248 };
 249
 250
 251 /**
 252  * loading_count_widget shows how many buffers in the current window are
 253  * loading.
 254  */
 255 function loading_count_widget (window) {
 256     this.class_name = "loading-count-widget";
 257     text_widget.call(this, window);
 258     var obj = this;
 259     this.add_hook("content_buffer_started_loading_hook");
 260     this.add_hook("content_buffer_finished_loading_hook");
 261     this.add_hook("kill_buffer_hook");
 262 }
 263 loading_count_widget.prototype = {
 264     constructor: loading_count_widget,
 265     __proto__: text_widget.prototype,
 266     update: function () {
 267         var count = 0;
 268         for_each_buffer(function (b) { if (b.loading) count++; });
 269         if (count)
 270             this.view.text = "(" + count + " loading)";
 271         else
 272             this.view.text = "";
 273     }
 274 };
 275
 276
 277 /**
 278  * buffer_icon_widget shows the icon for the current buffer, if any, in
 279  * the mode-line.
 280  */
 281 function buffer_icon_widget (window) {
 282     this.class_name = "buffer-icon-widget";
 283     text_widget.call(this, window);
 284     this.add_hook("current_buffer_icon_change_hook");
 285     this.add_hook("select_buffer_hook");
 286 }
 287 buffer_icon_widget.prototype.__proto__ = text_widget.prototype;
 288 buffer_icon_widget.prototype.update = function () {
 289     var buffer = this.window.buffers.current;
 290     if (buffer.icon)
 291         this.view.element.setAttribute("src", buffer.icon);
 292     else
 293         this.view.element.removeAttribute("src");
 294 };
 295 buffer_icon_widget.mode_line_adder = function (window) {
 296     var element = create_XUL(window, "image");
 297     element.setAttribute("class", "buffer-icon-widget");
 298     element.setAttribute("width", "16");
 299     element.setAttribute("height", "16");
 300     window.mode_line.add_widget(new buffer_icon_widget(window), element);
 301 };
 302
 303
 304 /**
 305  * downloads_status_widget shows the number of active downloads.
 306  */
 307 function downloads_status_widget (window) {
 308     text_widget.call(this, window);
 309     var obj = this;
 310     this.updater = function () { obj.update(); };
 311     add_hook("download_progress_change_hook", this.updater);
 312     add_hook("download_state_change_hook", this.updater);
 313 }
 314 downloads_status_widget.prototype = {
 315     constructor: downloads_status_widget,
 316     __proto__: text_widget.prototype,
 317     class_name: "downloads-status-widget",
 318     update: function (info) {
 319         this.view.text = download_manager_service.activeDownloadCount;
 320     },
 321     destroy: function () {
 322         remove_hook("download_progress_change_hook", this.updater);
 323         remove_hook("download_state_change_hook", this.updater);
 324     }
 325 };
 326
 327
 328 /**
 329  * zoom_widget
 330  */
 331 function zoom_widget (window) {
 332     text_widget.call(this, window);
 333     this.add_hook("select_buffer_hook");
 334     this.add_hook("current_buffer_zoom_hook");
 335     this.add_hook("current_content_buffer_location_change_hook");
 336     this.add_hook("current_content_buffer_finished_loading_hook");
 337 }
 338 zoom_widget.prototype = {
 339     constructor: zoom_widget,
 340     __proto__: text_widget.prototype,
 341     class_name: "zoom-widget",
 342     update: function () {
 343         var buffer = this.window.buffers.current;
 344         var t = Math.round(buffer.markup_document_viewer.textZoom * 100);
 345         var f = Math.round(buffer.markup_document_viewer.fullZoom * 100);
 346         var str = t + "%/" + f + "%";
 347         try {
 348             var doc = buffer.document.QueryInterface(Ci.nsIImageDocument);
 349             if (doc.imageIsResized) {
 350                 if (t == 100 && f == 100)
 351                     str = "zoom-to-fit";
 352                 else
 353                     str += "/zoom-to-fit";
 354             }
 355         } catch (e) {}
 356         this.view.text = str;
 357     }
 358 };
 359
 360
 361 function mode_line_adder (widget_constructor) {
 362     if (!('mode_line_adder' in widget_constructor))
 363         widget_constructor.mode_line_adder = function (window) {
 364             window.mode_line.add_text_widget(new widget_constructor(window));
 365         };
 366     return widget_constructor.mode_line_adder;
 367 }
 368
 369 add_hook("mode_line_hook", mode_line_adder(current_buffer_name_widget));
 370 add_hook("mode_line_hook", mode_line_adder(clock_widget));
 371 add_hook("mode_line_hook", mode_line_adder(current_buffer_scroll_position_widget));
 372
 373 mode_line_mode(true);
 374
 375 provide("mode-line");