wiki updated

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index 7677768686d4358efc30fcb1cb384d6393e3bb8b..4e90e169c15a570bb31aa4c6fa3f1ac9e70c5336 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -1,16 +1,17 @@
 
 --[[
 
 --[[

-                                                      
-     Licensed under GNU General Public License v2     
-      * (c) 2013,      Luke Bonham                    
-      * (c) 2010-2012, Peter Hofmann                  
-      * (c) 2010,      Adrian C. <anrxc@sysphere.org> 
-                                                      
+                                                  
+     Licensed under GNU General Public License v2 
+      * (c) 2013, Luke Bonham                     
+                                                  

 --]]
 
 --]]
 

-local awful  = require("awful")

 local debug  = require("debug")
 local debug  = require("debug")

-local pairs  = pairs
+
+local capi   = { timer = timer }
+local io     = { open  = io.open,
+                 lines = io.lines,
+                 popen = io.popen }

 local rawget = rawget
 
 -- Lain helper functions for internal use
 local rawget = rawget
 
 -- Lain helper functions for internal use


@@ -30,45 +31,70 @@ end
 
 -- }}}
 
 
 -- }}}
 

--- {{{
--- If lain.terminal is a string, e.g. "xterm", then "xterm -e " .. cmd is
--- run. But if lain.terminal is a function, then terminal(cmd) is run.
-
-function helpers.run_in_terminal(cmd)
-    if type(terminal) == "function"
-    then
-        terminal(cmd)
-    elseif type(terminal) == "string"
-    then
-        awful.util.spawn(terminal .. ' -e ' .. cmd)
-    end
+-- {{{ 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
 
 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
+  lines = {}
+  for line in io.lines(file) do
+    lines[#lines + 1] = line
+  end
+  return lines
+end

 
 

--- {{{ Format units to one decimal point
+-- 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

 
 

-function helpers.uformat(array, key, value, unit)
-    for u, v in pairs(unit) do
-        array["{"..key.."_"..u.."}"] = string.format("%.1f", value/v)
-    end
-    return array
+-- 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
 
 -- }}}
 

--- {{{ Read the first line of a file or return nil.
+-- {{{ Timer maker

 
 

-function helpers.first_line(f)
-    local fp = io.open(f)
-    if not fp
-    then
-        return nil
+helpers.timer_table = {}
+
+function helpers.newtimer(name, timeout, fun, nostart)
+    helpers.timer_table[name] = capi.timer({ timeout = timeout })
+    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
     end

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

 
 

-    local content = fp:read("*l")
-    fp:close()
-    return content
+-- read the full output of a pipe (command)
+function helpers.read_pipe(cmd)
+   local f = assert(io.popen(cmd))
+   local output = f:read("*all")
+   f:close()
+   return output

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