modules/mode-line.js

   1 /**
   2  * (C) Copyright 2005 Shawn Betts
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  * (C) Copyright 2010-2011 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 function current_buffer_name_widget (window) {
 137     this.class_name = "current-buffer-name-widget";
 138     text_widget.call(this, window);
 139     this.flex = "1";
 140     this.crop = "end";
 141     this.add_hook("current_content_buffer_location_change_hook");
 142     this.add_hook("select_buffer_hook");
 143 }
 144 current_buffer_name_widget.prototype.__proto__ = text_widget.prototype;
 145 current_buffer_name_widget.prototype.update = function () {
 146     this.view.text = this.window.buffers.current.description;
 147 };
 148
 149 function current_buffer_scroll_position_widget (window) {
 150     this.class_name = "current-buffer-scroll-position-widget";
 151     text_widget.call(this, window);
 152     this.add_hook("current_buffer_scroll_hook");
 153     this.add_hook("select_buffer_hook");
 154     this.add_hook("current_content_buffer_location_change_hook");
 155     this.add_hook("current_content_buffer_focus_change_hook");
 156     this.add_hook("current_special_buffer_generated_hook");
 157 }
 158 current_buffer_scroll_position_widget.prototype.__proto__ = text_widget.prototype;
 159 current_buffer_scroll_position_widget.prototype.update = function () {
 160     var b = this.window.buffers.current;
 161     var scrollX, scrollY, scrollMaxX, scrollMaxY;
 162     var w = b.focused_frame;
 163     scrollX = w.scrollX;
 164     scrollY = w.scrollY;
 165     scrollMaxX = w.scrollMaxX;
 166     scrollMaxY = w.scrollMaxY;
 167     var x = scrollMaxX == 0 ? 100 : Math.round(scrollX / scrollMaxX * 100);
 168     var y = scrollMaxY == 0 ? 100 : Math.round(scrollY / scrollMaxY * 100);
 169     this.view.text = "(" + x + ", " + y + ")";
 170 };
 171
 172
 173 define_variable("clock_time_format", "%R",
 174     "Format string for the mode-line clock widget.\n"+
 175     "It takes the same format as strftime() in C. "+
 176     "See http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html "+
 177     "for details.");
 178
 179 function clock_widget (window) {
 180     this.class_name = "clock-widget";
 181     text_widget.call(this, window);
 182     var obj = this;
 183     this.do_update = function () { obj.update(); };
 184     // todo: use one timer for multiple clock widgets
 185     this.timer_ID = window.setTimeout(this.do_update, 0);
 186     this.timer_timeout = true;
 187 }
 188 clock_widget.prototype.__proto__ = text_widget.prototype;
 189 clock_widget.prototype.update = function () {
 190     var time = new Date();
 191     this.view.text = time.toLocaleFormat(clock_time_format);
 192     if (time.getSeconds() > 0 || time.getMilliseconds() > 100) {
 193         this.window.clearTimeout(this.timer_ID);
 194         var time = time.getSeconds() * 1000 + time.getMilliseconds();
 195         time = 60000 - time;
 196         this.timer_ID = this.window.setTimeout(this.do_update, time);
 197         this.timer_timeout = true;
 198     } else if (this.timer_timeout) {
 199         this.window.clearTimeout(this.timer_ID);
 200         this.timer_ID = this.window.setInterval(this.do_update, 60000);
 201         this.timer_timeout = false;
 202     }
 203 };
 204 clock_widget.prototype.destroy = function () {
 205     this.window.clearTimeout(this.timer_ID);
 206 };
 207
 208 function buffer_count_widget (window) {
 209     this.class_name = "buffer-count-widget";
 210     text_widget.call(this, window);
 211     this.add_hook("select_buffer_hook");
 212     this.add_hook("create_buffer_hook");
 213     this.add_hook("kill_buffer_hook");
 214     this.add_hook("move_buffer_hook");
 215 }
 216 buffer_count_widget.prototype.__proto__ = text_widget.prototype;
 217 buffer_count_widget.prototype.update = function () {
 218     this.view.text = ("[" + (this.window.buffers.selected_index+1) + "/" +
 219                       this.window.buffers.count + "]");
 220 };
 221
 222 function loading_count_widget (window) {
 223     this.class_name = "loading-count-widget";
 224     text_widget.call(this, window);
 225     var obj = this;
 226     this.add_hook("content_buffer_started_loading_hook");
 227     this.add_hook("content_buffer_finished_loading_hook");
 228     this.add_hook("kill_buffer_hook");
 229 }
 230 loading_count_widget.prototype.__proto__ = text_widget.prototype;
 231 loading_count_widget.prototype.update = function () {
 232     var count = 0;
 233     for_each_buffer(function (b) { if (b.loading) count++; });
 234     if (count)
 235         this.view.text = "(" + count + " loading)";
 236     else
 237         this.view.text = "";
 238 };
 239
 240
 241 /**
 242  * buffer_icon_widget shows the icon for the current buffer, if any, in
 243  * the mode-line.
 244  */
 245 function buffer_icon_widget (window) {
 246     this.class_name = "buffer-icon-widget";
 247     text_widget.call(this, window);
 248     this.add_hook("current_buffer_icon_change_hook");
 249     this.add_hook("select_buffer_hook");
 250 }
 251 buffer_icon_widget.prototype.__proto__ = text_widget.prototype;
 252 buffer_icon_widget.prototype.update = function () {
 253     var buffer = this.window.buffers.current;
 254     if (buffer.icon)
 255         this.view.element.setAttribute("src", buffer.icon);
 256     else
 257         this.view.element.removeAttribute("src");
 258 };
 259 buffer_icon_widget.mode_line_adder = function (window) {
 260     var element = create_XUL(window, "image");
 261     element.setAttribute("class", "buffer-icon-widget");
 262     element.setAttribute("width", "16");
 263     element.setAttribute("height", "16");
 264     window.mode_line.add_widget(new buffer_icon_widget(window), element);
 265 };
 266
 267
 268 /**
 269  * downloads_status_widget shows the number of active downloads.
 270  */
 271 function downloads_status_widget (window) {
 272     text_widget.call(this, window);
 273     var obj = this;
 274     this.updater = function () { obj.update(); };
 275     add_hook("download_progress_change_hook", this.updater);
 276     add_hook("download_state_change_hook", this.updater);
 277 }
 278 downloads_status_widget.prototype = {
 279     constructor: downloads_status_widget,
 280     __proto__: text_widget.prototype,
 281     class_name: "downloads-status-widget",
 282     update: function (info) {
 283         this.view.text = download_manager_service.activeDownloadCount;
 284     },
 285     destroy: function () {
 286         remove_hook("download_progress_change_hook", this.updater);
 287         remove_hook("download_state_change_hook", this.updater);
 288     }
 289 };
 290
 291
 292 function mode_line_adder (widget_constructor) {
 293     if (!('mode_line_adder' in widget_constructor))
 294         widget_constructor.mode_line_adder = function (window) {
 295             window.mode_line.add_text_widget(new widget_constructor(window));
 296         };
 297     return widget_constructor.mode_line_adder;
 298 }
 299
 300 add_hook("mode_line_hook", mode_line_adder(current_buffer_name_widget));
 301 add_hook("mode_line_hook", mode_line_adder(clock_widget));
 302 add_hook("mode_line_hook", mode_line_adder(current_buffer_scroll_position_widget));
 303
 304 mode_line_mode(true);
 305
 306 provide("mode-line");