layouts: geometry computation aligned to v4.0 API; fixes #267

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index a8c4cd7297bc01c830c06c4df98e0d5e05b1780a..0305722bf99fb0cd170c25ff58873c74fb9b3108 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -1,15 +1,22 @@
 
 --[[
 
 --[[

-                                                      
-     Licensed under GNU General Public License v2     
-      * (c) 2013,      Luke Bonham                    
-      * (c) 2010-2012, Peter Hofmann                  
-                                                      
+                                                  
+     Licensed under GNU General Public License v2 
+      * (c) 2013, Luke Bonham                     
+                                                  

 --]]
 
 --]]
 

-local debug  = require("debug")
-local rawget = rawget
-local io     = { open = io.open }
+
+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


@@ -28,33 +35,100 @@ end
 
 -- }}}
 
 
 -- }}}
 

--- {{{ Read the first line of a file or return nil.
+-- {{{ File operations
+
+-- see if the file exists and is readable
+function helpers.file_exists(file)
+  local f = io.open(file)
+  if f then
+      local s = f:read()
+      f:close()
+      f = s
+  end
+  return f ~= nil
+end

 
 

-function helpers.first_line(f)
-    local fp = io.open(f)
-    if not fp
-    then
-        return nil
-    end
+-- get all lines from a file, returns an empty
+-- list/table if the file does not exist
+function helpers.lines_from(file)
+  if not helpers.file_exists(file) then return {} end
+  local lines = {}
+  for line in io.lines(file) do
+    lines[#lines + 1] = line
+  end
+  return lines
+end
+
+-- match all lines from a file, returns an empty
+-- list/table if the file or match does not exist
+function helpers.lines_match(regexp, file)
+       local lines = {}
+       for index,line in pairs(helpers.lines_from(file)) do
+               if string.match(line, regexp) then
+                       lines[index] = line
+               end
+       end
+       return lines
+end

 
 

-    local content = fp:read("*l")
-    fp:close()
-    return content
+-- get first line of a file, return nil if
+-- the file does not exist
+function helpers.first_line(file)
+    return helpers.lines_from(file)[1]
+end
+
+-- get first non empty line from a file,
+-- returns nil otherwise
+function helpers.first_nonempty_line(file)
+  for k,v in pairs(helpers.lines_from(file)) do
+    if #v then return v end
+  end
+  return nil

 end
 
 -- }}}
 
 end
 
 -- }}}
 

--- {{{ Timer maker 
+-- {{{ Timer maker

 
 helpers.timer_table = {}
 
 
 helpers.timer_table = {}
 

-function helpers.newtimer(name, timeout, fun, nostart)
-    helpers.timer_table[name] = timer({ timeout = 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
+        helpers.timer_table[name] = timer({ timeout = timeout })
+        helpers.timer_table[name]:start()
+    end

     helpers.timer_table[name]:connect_signal("timeout", fun)
     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
     if not nostart then
         helpers.timer_table[name]:emit_signal("timeout")
     end

+    return stoppable and helpers.timer_table[name]
+end
+
+-- }}}
+
+-- {{{ Pipe operations
+
+-- return the full output of an input command (synchronous pipe)
+-- @param cmd the input command
+-- @return command output (string)
+function helpers.read_pipe(cmd)
+   local f = io.popen(cmd)
+   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
 
 -- }}}
 end
 
 -- }}}


@@ -73,4 +147,42 @@ end
 
 -- }}}
 
 
 -- }}}
 

+-- {{{ 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 = {}
+    for k in pairs(t) do keys[#keys+1] = k end
+
+    table.sort(keys)
+
+    -- return the iterator function
+    local i = 0
+    return function()
+        i = i + 1
+        if keys[i] then
+            return keys[i], t[keys[i]]
+        end
+    end
+end
+
+-- create a lain textbox
+function helpers.make_widget_textbox()
+    local w = { widget = wibox.widget.textbox() }
+    return setmetatable(w, { __index = w.widget })
+end
+
+-- }}}
+

 return helpers
 return helpers