.vimperator/buftabs.js

   1 // PLUGIN_INFO {{{
   2 let PLUGIN_INFO =
   3 <VimperatorPlugin>
   4   <name>Buftabs</name>
   5   <description>Add buffer tabs to the statusline to save space.</description>
   6   <version>1.1</version>
   7   <author mail="lucas@tuple-typed.org" homepage="http://tuple-typed.org/">Lucas de Vries (GGLucas)</author>
   8   <license>WTFPL version 2 (http://sam.zoy.org/wtfpl/)</license>
   9   <minVersion>2.2</minVersion>
  10   <maxVersion>2.2</maxVersion>
  11   <detail><![CDATA[
  12
  13   == Usage ==
  14   When the script is loaded it hijacks the statusline to display a list of tabs,
  15   you can use the "buftabs" option to toggle it on or off.
  16
  17   == Styling ==
  18   Use the BufTab and BufTabSelected highlight groups to style the buftabs.
  19   Make sure you've called the "loadplugins" command before using the highlight
  20   groups in your vimperatorrc.
  21
  22   == Length ==
  23   You can set the max length of a title before it is cut off with the
  24   buftabs_maxlength option. It is set to 25 by default.
  25
  26   ]]></detail>
  27 </VimperatorPlugin>;
  28 // }}}
  29
  30 buftabs = {
  31     // Update the tabs
  32     updateUrl: function (url)
  33     {
  34         // Get buftabbar
  35         var btabs = document.getElementById("liberator-statusline-buftabs");
  36         var urlWidget = document.getElementById("liberator-statusline-field-url");
  37         var browsers = tabs.getBrowser().browsers;
  38         var position=0, selpos;
  39
  40         // Make sure we have an appropriate amount of labels
  41         while (btabs.childNodes.length > browsers.length)
  42         {
  43             btabs.removeChild(btabs.lastChild);
  44         }
  45
  46         while (btabs.childNodes.length < browsers.length)
  47         {
  48             var label = document.createElement("label");
  49             btabs.appendChild(label);
  50
  51             label.onclick = function (ev)
  52             {
  53                 if (ev.button == 0)
  54                     tabs.select(this.tabpos);
  55                 else if (ev.button == 1)
  56                     tabs.remove(tabs.getTab(this.tabpos), 1, false, 0);
  57             }
  58         }
  59
  60         // Create the new tabs
  61         for (let i=0; i < browsers.length; i++)
  62         {
  63             // Create label
  64             var browser = browsers[i];
  65             var label = btabs.childNodes[i];
  66
  67             // Hook on load
  68             if (browser.webProgress.isLoadingDocument)
  69             {
  70                 browser._buftabs_label = label;
  71                 browser.contentDocument.addEventListener("load", function ()
  72                 {
  73                     buftabs.fillLabel(this._buftabs_label, this);
  74                 }, false);
  75             }
  76
  77             // Fill label
  78             label.tabpos = i;
  79             buftabs.fillLabel(label, browser);
  80
  81             if (tabs.index() == label.tabpos)
  82             {
  83                 selpos = [position, label.clientWidth+position];
  84             }
  85
  86             position += label.clientWidth;
  87         }
  88
  89         // Scroll
  90         if (selpos[0] < btabs.scrollLeft || selpos[1] > btabs.scrollLeft+btabs.clientWidth)
  91             btabs.scrollLeft = selpos[0];
  92
  93         // Show the entire line if possible
  94         if (btabs.scrollWidth == btabs.clientWidth)
  95             btabs.scrollLeft = 0;
  96
  97         // Empty url label
  98         urlWidget.value = "";
  99     },
 100
 101     // Fill a label with browser content
 102     fillLabel: function(label, browser)
 103     {
 104         var maxlength = options.get("buftabs_maxlength").get();
 105         var tabvalue;
 106
 107         // Get title
 108         if (browser.webProgress.isLoadingDocument)
 109         {
 110             tabvalue = "Loading...";
 111         } else {
 112             tabvalue = browser.contentTitle || "Untitled";
 113         }
 114
 115         // Check length
 116         if (tabvalue.length > maxlength)
 117             tabvalue = tabvalue.substr(0, maxlength-3)+"...";
 118
 119         // Bookmark icon
 120         if (bookmarks.isBookmarked(browser.contentDocument.location.href))
 121             tabvalue += "\u2764";
 122
 123         // Brackets and index
 124         tabvalue = "["+(label.tabpos+1)+"-"+tabvalue+"]";
 125
 126         label.setAttribute("value", tabvalue);
 127
 128         // Set the correct highlight group
 129         if (tabs.index() == label.tabpos)
 130             label.setAttributeNS(NS.uri, "highlight", "BufTabSelected");
 131         else
 132             label.setAttributeNS(NS.uri, "highlight", "BufTab");
 133
 134
 135     },
 136
 137     // Create the horizontal box for adding the tabs to
 138     createBar: function()
 139     {
 140         var statusline = document.getElementById("liberator-statusline");
 141         var buftabs = document.getElementById("liberator-statusline-buftabs");
 142         var urlWidget = document.getElementById("liberator-statusline-field-url");
 143
 144         // Only create if it doesn't exist yet
 145         if (!buftabs)
 146         {
 147             buftabs = document.createElement("hbox");
 148             buftabs.setAttribute("id", "liberator-statusline-buftabs");
 149             buftabs.setAttribute("flex", "1");
 150             buftabs.style.overflow = "hidden"
 151
 152             statusline.insertBefore(buftabs, urlWidget);
 153         }
 154     },
 155
 156     destroyBar: function()
 157     {
 158         var statusline = document.getElementById("liberator-statusline");
 159         var buftabs = document.getElementById("liberator-statusline-buftabs");
 160
 161         if (buftabs)
 162             statusline.removeChild(buftabs);
 163     }
 164 }
 165
 166 /// Attach to events in order to update the tabline
 167 var tabContainer = tabs.getBrowser().mTabContainer;
 168 buftabs._statusline_updateUrl = statusline.updateUrl;
 169
 170 tabContainer.addEventListener("TabMove", function (event) {
 171     if (options.get("buftabs").get())
 172         statusline.updateUrl();
 173 }, false);
 174 tabContainer.addEventListener("TabOpen", function (event) {
 175     if (options.get("buftabs").get())
 176         statusline.updateUrl();
 177 }, false);
 178 tabContainer.addEventListener("TabClose", function (event) {
 179     if (options.get("buftabs").get())
 180         setTimeout(statusline.updateUrl, 0);
 181 }, false);
 182 tabContainer.addEventListener("TabSelect", function (event) {
 183     if (options.get("buftabs").get())
 184         statusline.updateUrl();
 185 }, false);
 186
 187 tabs.getBrowser().addEventListener("load", function (event) {
 188     if (options.get("buftabs").get())
 189         statusline.updateUrl();
 190 }, false);
 191
 192 /// Initialise highlight groups
 193 highlight.loadCSS(String(<![CDATA[
 194     BufTab
 195     BufTabSelected   font-weight: bold;
 196 ]]>));
 197
 198 /// Options
 199 options.add(["buftabs"],
 200         "Control whether to use buftabs in the statusline",
 201         "boolean", true,
 202         {
 203             setter: function (value)
 204             {
 205                 if (value)
 206                 {
 207                     buftabs.createBar();
 208                     buftabs.updateUrl(null);
 209
 210                     statusline.updateUrl = buftabs.updateUrl;
 211                 } else {
 212                     buftabs.destroyBar();
 213                     statusline.updateUrl = buftabs._statusline_updateUrl;
 214                     statusline.update();
 215                 }
 216
 217                 return value;
 218             },
 219
 220             completer: function (context)
 221             [
 222                 [false, "Don't show buftabs, show the url"],
 223                 [true, "Show buftabs"]
 224             ],
 225
 226             validator: Option.validateCompleter
 227         });
 228
 229 options.add(["buftabs_maxlength"],
 230         "Max length of an entry in the buftabs list",
 231         "number", "25",
 232         {
 233             setter: function (value)
 234             {
 235                 buftabs.updateUrl();
 236                 return value;
 237             }
 238         });