wiki updated

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index 8fb794c1f0e1cb790d02f65e27fb80825ff85b53..8eed10fa81ffa6be90788fc230ecbb4696918d60 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -8,13 +8,16 @@
 
 local debug  = require("debug")
 
-local capi   = { timer = (type(timer) == 'table' and timer or require ("gears.timer")) }
+local assert = assert
+local capi   = { timer = require ("gears.timer") }
 local io     = { open  = io.open,
                  lines = io.lines,
                  popen = io.popen }
 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
@@ -93,9 +96,9 @@ function helpers.newtimer(_name, timeout, fun, nostart)
     local name = timeout
     if not helpers.timer_table[name] then
         helpers.timer_table[name] = capi.timer({ timeout = timeout })
+        helpers.timer_table[name]:start()
     end
     helpers.timer_table[name]:connect_signal("timeout", fun)
-    helpers.timer_table[name]:start()
     if not nostart then
         helpers.timer_table[name]:emit_signal("timeout")
     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,19 @@ end
 
 -- }}}
 
---{{{ Iterate over table of records sorted by keys
+-- {{{ Misc
+
+-- check if an element exist on a table
+function helpers.element_in_table(element, tbl)
+    for _, i in pairs(tbl) do
+        if i == element then
+            return true
+        end
+    end
+    return false
+end
+
+-- iterate over table of records sorted by keys
 function helpers.spairs(t)
     -- collect the keys
     local keys = {}
@@ -146,6 +171,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