fix and complete pull #286

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index 309162e7a3d8e098043a395417f9ad296c439fee..7c446480c0cf6955698f8b5fd5835cd44ac8db3c 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -6,14 +6,17 @@
                                                   
 --]]
 
                                                   
 --]]
 

-local debug  = require("debug")

 
 

-local capi   = { timer = (type(timer) == 'table' and timer or require ("gears.timer")) }
-local io     = { open  = io.open,
-                 lines = io.lines,
-                 popen = io.popen }
-local rawget = rawget
-local table  = { sort   = table.sort }
+local debug      = require("debug")
+local io         = { lines = io.lines,
+                     open  = io.open,
+                     popen = io.popen }
+local rawget     = rawget
+local table      = { sort  = table.sort }
+
+local easy_async = require("awful.spawn").easy_async
+local timer      = require("gears.timer")
+local wibox      = require("wibox")

 
 -- Lain helper functions for internal use
 -- lain.helpers
 
 -- Lain helper functions for internal use
 -- lain.helpers


@@ -61,9 +64,9 @@ end
 function helpers.lines_match(regexp, file)
        local lines = {}
        for index,line in pairs(helpers.lines_from(file)) do
 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
                        lines[index] = line

-               end  
+               end

        end
        return lines
 end
        end
        return lines
 end


@@ -89,30 +92,45 @@ end
 
 helpers.timer_table = {}
 
 
 helpers.timer_table = {}
 

-function helpers.newtimer(_name, timeout, fun, nostart)
-    local name = timeout
+function helpers.newtimer(name, timeout, fun, nostart, stoppable)
+    if not name or #name == 0 then return end
+    name = (stoppable and name) or timeout

     if not helpers.timer_table[name] then
     if not helpers.timer_table[name] then

-        helpers.timer_table[name] = capi.timer({ timeout = timeout })
+        helpers.timer_table[name] = timer({ timeout = timeout })

         helpers.timer_table[name]:start()
     end
     helpers.timer_table[name]:connect_signal("timeout", fun)
     if not nostart then
         helpers.timer_table[name]:emit_signal("timeout")
     end
         helpers.timer_table[name]:start()
     end
     helpers.timer_table[name]:connect_signal("timeout", fun)
     if not nostart then
         helpers.timer_table[name]:emit_signal("timeout")
     end

+    return stoppable and helpers.timer_table[name]

 end
 
 -- }}}
 
 -- {{{ Pipe operations
 
 end
 
 -- }}}
 
 -- {{{ Pipe operations
 

--- read the full output of a pipe (command)
+-- return the full output of an input command (synchronous pipe)
+-- @param cmd the input command
+-- @return command output (string)

 function helpers.read_pipe(cmd)
 function helpers.read_pipe(cmd)

-   local f = assert(io.popen(cmd))
+   local f = io.popen(cmd)

    local output = f:read("*all")
    f:close()
    return output
 end
 
    local output = f:read("*all")
    f:close()
    return output
 end
 

+-- run a command and execute a function on its output (asynchronous pipe)
+-- @param cmd the input command
+-- @param callback function to execute on cmd output
+-- @return cmd PID
+function helpers.async(cmd, callback)
+    return easy_async(cmd,
+    function (stdout, stderr, reason, exit_code)
+        callback(stdout)
+    end)
+end
+

 -- }}}
 
 -- {{{ A map utility
 -- }}}
 
 -- {{{ A map utility


@@ -129,7 +147,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 = {}
 function helpers.spairs(t)
     -- collect the keys
     local keys = {}


@@ -146,6 +176,15 @@ function helpers.spairs(t)
         end
     end
 end
         end
     end
 end

---}}}
+
+-- create a textbox with no spacing issues
+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
 
 return helpers