modules/mode-line.js

   1 /**
   2  * (C) Copyright 2005 Shawn Betts
   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 define_window_local_hook("mode_line_hook");
  12
  13 function generic_element_widget_container(window, container)
  14 {
  15     this.window = window;
  16     this.container = container;
  17 }
  18 define_keywords("$flex", "$align", "$class", "$crop");
  19 generic_element_widget_container.prototype = {
  20     add_text_widget : function (widget) {
  21         keywords(arguments, $flex = widget.flex,
  22                  $class = widget.class_name, $crop = widget.crop);
  23         var flex = arguments.$flex;
  24         var class_name = arguments.$class;
  25         var align = arguments.$align;
  26         var crop = arguments.$crop;
  27         var element = create_XUL(this.window, "label");
  28         if (flex)
  29             element.setAttribute("flex", flex);
  30         if (align)
  31             element.setAttribute("align", align);
  32         if (class_name)
  33             element.setAttribute("class", class_name);
  34         if (crop)
  35             element.setAttribute("crop", crop);
  36         element.conkeror_widget = new generic_widget_element(element, widget);
  37         this.container.appendChild(element);
  38         return element.conkeror_widget;
  39     },
  40     destroy : function() {
  41         var children = this.container.childNodes;
  42         for (var i = 0, nchildren = children.length; i < nchildren; ++i)
  43             children.item(i).conkeror_widget.destroy();
  44     }
  45 };
  46
  47 function mode_line(window)
  48 {
  49     var element = create_XUL(window, "hbox");
  50     element.setAttribute("class", "mode-line");
  51     /* FIXME: this will need to changed to be buffer-local */
  52     var insert_before = window.document.getElementById("minibuffer");
  53     insert_before.parentNode.insertBefore(element, insert_before);
  54     window.mode_line = this;
  55     generic_element_widget_container.call(this, window, element);
  56     mode_line_hook.run(window, this);
  57 }
  58 mode_line.prototype = {
  59     __proto__: generic_element_widget_container.prototype,
  60
  61     uninstall: function () {
  62         this.container.parentNode.removeChild(this.window.mode_line.container);
  63         generic_element_widget_container.prototype.destroy.call(this);
  64     }
  65 };
  66
  67
  68 function generic_widget_element(element, widget)
  69 {
  70     this.element = element;
  71     this.widget = widget;
  72     widget.attach(this);
  73 }
  74
  75 generic_widget_element.prototype = {
  76     get text () {
  77         return this.element.getAttribute("value");
  78     },
  79
  80     set text (v) {
  81         this.element.setAttribute("value", v);
  82     },
  83
  84     destroy : function () {
  85         this.widget.destroy();
  86     },
  87
  88     remove : function () {
  89         this.element.parentNode.removeChild(this.element);
  90         this.destroy();
  91     }
  92 };
  93
  94
  95 function text_widget(window)
  96 {
  97     this.window_hooks = [];
  98     this.window = window;
  99 }
 100 text_widget.prototype = {
 101     add_hook : function (hook_name, handler)
 102     {
 103         var obj = this;
 104         if (handler == null) handler = function () { obj.update(); }
 105         add_hook.call(this.window, hook_name, handler);
 106         this.window_hooks.push([hook_name, handler]);
 107     },
 108
 109     view : null,
 110
 111     attach : function (view) {
 112         this.view = view;
 113         this.update();
 114     },
 115
 116     update : function () {
 117     },
 118
 119     destroy : function ()
 120     {
 121         for each (let i in this.window_hooks) {
 122             remove_hook.call(this.window, i[0], i[1]);
 123         }
 124     },
 125
 126     remove : function ()
 127     {
 128         this.view.remove();
 129     }
 130 };
 131
 132 define_global_window_mode("mode_line", "window_initialize_early_hook");
 133
 134 function current_buffer_name_widget(window) {
 135     this.class_name = "current-buffer-name-widget";
 136     text_widget.call(this, window);
 137     this.flex = "1";
 138     this.crop = "end";
 139     this.add_hook("current_content_buffer_location_change_hook");
 140     this.add_hook("select_buffer_hook");
 141 }
 142 current_buffer_name_widget.prototype.__proto__ = text_widget.prototype;
 143 current_buffer_name_widget.prototype.update = function () {
 144     this.view.text = this.window.buffers.current.description;
 145 };
 146
 147 function current_buffer_scroll_position_widget(window) {
 148     this.class_name = "current-buffer-scroll-position-widget";
 149     text_widget.call(this, window);
 150     this.add_hook("current_buffer_scroll_hook");
 151     this.add_hook("select_buffer_hook");
 152     this.add_hook("current_content_buffer_location_change_hook");
 153     this.add_hook("current_content_buffer_focus_change_hook");
 154 }
 155 current_buffer_scroll_position_widget.prototype.__proto__ = text_widget.prototype;
 156 current_buffer_scroll_position_widget.prototype.update = function () {
 157     var b = this.window.buffers.current;
 158     var scrollX, scrollY, scrollMaxX, scrollMaxY;
 159     if (b instanceof content_buffer)
 160     {
 161         var w = b.focused_frame;
 162         scrollX = w.scrollX;
 163         scrollY = w.scrollY;
 164         scrollMaxX = w.scrollMaxX;
 165         scrollMaxY = w.scrollMaxY;
 166     } else
 167     {
 168         scrollX = b.scrollX;
 169         scrollY = b.scrollY;
 170         scrollMaxX = b.scrollMaxX;
 171         scrollMaxY = b.scrollMaxY;
 172     }
 173     var x = scrollMaxX == 0 ? 100 : Math.round(scrollX / scrollMaxX * 100);
 174     var y = scrollMaxY == 0 ? 100 : Math.round(scrollY / scrollMaxY * 100);
 175     this.view.text = "(" + x + ", " + y + ")";
 176 };
 177
 178 function clock_widget(window)
 179 {
 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     var hours = time.getHours();
 192     var mins = time.getMinutes();
 193     this.view.text = (hours<10 ? "0" + hours:hours) + ":" + (mins<10 ?"0" +mins:mins);
 194     if (time.getSeconds() > 0 || time.getMilliseconds() > 100) {
 195         this.window.clearTimeout(this.timer_ID);
 196         var time = time.getSeconds() * 1000 + time.getMilliseconds();
 197         time = 60000 - time;
 198         this.timer_ID = this.window.setTimeout(this.do_update, time);
 199         this.timer_timeout = true;
 200     } else if (this.timer_timeout) {
 201         this.window.clearTimeout(this.timer_ID);
 202         this.timer_ID = this.window.setInterval(this.do_update, 60000);
 203         this.timer_timeout = false;
 204     }
 205 };
 206 clock_widget.prototype.destroy = function () {
 207     this.window.clearTimeout(this.timer_ID);
 208 };
 209
 210 function buffer_count_widget(window) {
 211     this.class_name = "buffer-count-widget";
 212     text_widget.call(this, window);
 213     this.add_hook("select_buffer_hook");
 214     this.add_hook("create_buffer_hook");
 215     this.add_hook("kill_buffer_hook");
 216 }
 217 buffer_count_widget.prototype.__proto__ = text_widget.prototype;
 218 buffer_count_widget.prototype.update = function () {
 219     this.view.text = ("[" + (this.window.buffers.selected_index+1) + "/" +
 220                       this.window.buffers.count + "]");
 221 };
 222
 223 function loading_count_widget(window) {
 224     this.class_name = "loading-count-widget";
 225     text_widget.call(this, window);
 226     var obj = this;
 227     this.add_hook("content_buffer_started_loading_hook");
 228     this.add_hook("content_buffer_finished_loading_hook");
 229     this.add_hook("kill_buffer_hook");
 230 }
 231 loading_count_widget.prototype.__proto__ = text_widget.prototype;
 232 loading_count_widget.prototype.update = function () {
 233     var count = 0;
 234     for_each_buffer(function(b) {if (b.loading) count++;});
 235     if (count)
 236         this.view.text = "(" + count + " loading)";
 237     else
 238         this.view.text = "";
 239 };
 240
 241 function mode_line_adder(widget_constructor) {
 242     if (!('mode_line_adder' in widget_constructor))
 243         widget_constructor.mode_line_adder = function (window) {
 244             window.mode_line.add_text_widget(new widget_constructor(window));
 245         };
 246     return widget_constructor.mode_line_adder;
 247 }
 248
 249 add_hook("mode_line_hook", mode_line_adder(current_buffer_name_widget));
 250 add_hook("mode_line_hook", mode_line_adder(clock_widget));
 251 add_hook("mode_line_hook", mode_line_adder(current_buffer_scroll_position_widget));
 252
 253 mode_line_mode(true);