readme updated

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index 309162e7a3d8e098043a395417f9ad296c439fee..6a47738e56ded7fb130a5f2bf33a8692dbc6b271 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -8,6 +8,7 @@
 
 local debug  = require("debug")
 
+local assert = assert
 local capi   = { timer = (type(timer) == 'table' and timer or require ("gears.timer")) }
 local io     = { open  = io.open,
                  lines = io.lines,
@@ -15,6 +16,8 @@ local io     = { open  = io.open,
 local rawget = rawget
 local table  = { sort   = table.sort }
 
+local wibox  = require("wibox")
+
 -- Lain helper functions for internal use
 -- lain.helpers
 local helpers = {}
@@ -61,9 +64,9 @@ end
 function helpers.lines_match(regexp, file)
        local lines = {}
        for index,line in pairs(helpers.lines_from(file)) do
-               if string.match(line, regexp) then 
+               if string.match(line, regexp) then
                        lines[index] = line
-               end  
+               end
        end
        return lines
 end
@@ -105,7 +108,7 @@ end
 
 -- {{{ Pipe operations
 
--- read the full output of a pipe (command)
+-- read the full output of a command output
 function helpers.read_pipe(cmd)
    local f = assert(io.popen(cmd))
    local output = f:read("*all")
@@ -113,6 +116,16 @@ function helpers.read_pipe(cmd)
    return output
 end
 
+-- return line iterator of a command output
+function helpers.pipelines(...)
+    local f = assert(io.popen(...))
+    return function () -- iterator
+        local data = f:read()
+        if data == nil then f:close() end
+        return data
+    end
+end
+
 -- }}}
 
 -- {{{ A map utility
@@ -129,7 +142,9 @@ end
 
 -- }}}
 
---{{{ Iterate over table of records sorted by keys
+-- {{{ Misc
+
+-- iterate over table of records sorted by keys
 function helpers.spairs(t)
     -- collect the keys
     local keys = {}
@@ -146,6 +161,15 @@ function helpers.spairs(t)
         end
     end
 end
---}}}
+
+-- create a lain textbox widget
+function helpers.make_widget_textbox()
+    local w = wibox.widget.textbox('')
+    local t = wibox.widget.base.make_widget(w)
+    t.widget = w
+    return t
+end
+
+-- }}}
 
 return helpers