#288 trying metatables

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index 08aba0d7d454d6d7b3ba78cdc9568dd737a0614a..106978fd41823bb11ab0f466406c8d268ed0b901 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -2,17 +2,21 @@
 --[[
                                                   
      Licensed under GNU General Public License v2 
-      * (c) 2013,      Luke Bonham                
-      * (c) 2010-2012, Peter Hofmann              
+      * (c) 2013, Luke Bonham                     
                                                   
 --]]
 
-local debug  = require("debug")
 
-local capi   = { timer = timer }
-local io     = { open = io.open,
-                 lines = io.lines }
-local rawget = rawget
+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
@@ -33,25 +37,40 @@ end
 
 -- {{{ File operations
 
--- see if the file exists
+-- see if the file exists and is readable
 function helpers.file_exists(file)
-  local f = io.open(file, "rb")
-  if f then f:close() end
+  local f = io.open(file)
+  if f then
+      local s = f:read()
+      f:close()
+      f = s
+  end
   return f ~= nil
 end
 
-
--- get all lines from a file, returns an empty 
+-- 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
-  lines = {}
-  for line in io.lines(file) do 
+  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
+
 -- get first line of a file, return nil if
 -- the file does not exist
 function helpers.first_line(file)
@@ -61,8 +80,8 @@ end
 -- get first non empty line from a file,
 -- returns nil otherwise
 function helpers.first_nonempty_line(file)
-  for k,v in pairs(lines_from(file)) do
-    if #v then return v end 
+  for k,v in pairs(helpers.lines_from(file)) do
+    if #v then return v end
   end
   return nil
 end
@@ -73,13 +92,43 @@ end
 
 helpers.timer_table = {}
 
-function helpers.newtimer(name, timeout, fun, nostart)
-    helpers.timer_table[name] = capi.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]:start()
     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
 
 -- }}}
@@ -98,4 +147,45 @@ 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 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
+    return setmetatable({ widget = w }, { __index = w })
+end
+
+-- }}}
+
 return helpers