widget.fs: notification: right-justify columns 2-4 for better readability

[etc/awesome.git] / helpers.lua

diff --git a/helpers.lua b/helpers.lua
index ce655761405b9a972b58cda4e0e8552052b1daee..d3fa2597c22e8659c4674925c19d128ccec5fd23 100644 (file)
--- a/helpers.lua
+++ b/helpers.lua
@@ -1,17 +1,19 @@
 --[[
 
      Licensed under GNU General Public License v2
-      * (c) 2013, Luke Bonham
+      * (c) 2013, Luca CPZ
 
 --]]
 
-local spawn = require("awful.spawn")
+local spawn      = require("awful.spawn")
 local timer      = require("gears.timer")
 local debug      = require("debug")
 local io         = { lines = io.lines,
                      open  = io.open }
+local pairs      = pairs
 local rawget     = rawget
-local table      = { sort  = table.sort }
+local table      = { sort  = table.sort, unpack = table.unpack }
+local unpack     = unpack or table.unpack -- lua 5.1 retro-compatibility
 
 -- Lain helper functions for internal use
 -- lain.helpers
@@ -32,53 +34,49 @@ 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
-
--- 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
-
--- 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
+-- check if the file exists and is readable
+function helpers.file_exists(path)
+    local file = io.open(path, "rb")
+    if file then file:close() end
+    return file ~= nil
+end
+
+-- get a table with all lines from a file
+function helpers.lines_from(path)
+    local lines = {}
+    for line in io.lines(path) do
+        lines[#lines + 1] = line
+    end
+    return lines
+end
+
+-- get a table with all lines from a file matching regexp
+function helpers.lines_match(regexp, path)
+    local lines = {}
+    for line in io.lines(path) do
+        if string.match(line, regexp) then
+            lines[#lines + 1] = line
+        end
+    end
+    return lines
+end
+
+-- get first line of a file
+function helpers.first_line(path)
+    local file, first = io.open(path, "rb"), nil
+    if file then
+        first = file:read("*l")
+        file:close()
+    end
+    return first
+end
+
+-- get first non empty line from a file
+function helpers.first_nonempty_line(path)
+    for line in io.lines(path) do
+        if #line then return line end
+    end
+    return nil
 end
 
 -- }}}
@@ -112,7 +110,7 @@ end
 function helpers.async(cmd, callback)
     return spawn.easy_async(cmd,
     function (stdout, stderr, reason, exit_code)
-        callback(stdout)
+        callback(stdout, exit_code)
     end)
 end
 
@@ -120,10 +118,19 @@ end
 function helpers.async_with_shell(cmd, callback)
     return spawn.easy_async_with_shell(cmd,
     function (stdout, stderr, reason, exit_code)
-        callback(stdout)
+        callback(stdout, exit_code)
     end)
 end
 
+-- run a command and execute a function on its output line by line
+function helpers.line_callback(cmd, callback)
+    return spawn.with_line_callback(cmd, {
+        stdout = function (line)
+            callback(line)
+        end,
+    })
+end
+
 -- }}}
 
 -- {{{ A map utility
@@ -170,9 +177,8 @@ function helpers.spairs(t)
     end
 end
 
--- create trivial partition of a set. The trivial partition set is the simplest
--- partition of a set. For e.g., the trivial partition set of {a, b, c}, is
--- simply {{a}, {b}, {c}}.
+-- create the partition of singletons of a given set
+-- example: the trivial partition set of {a, b, c}, is {{a}, {b}, {c}}
 function helpers.trivial_partition_set(set)
     local ss = {}
     for _,e in pairs(set) do