--[[
-
- 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 pairs = pairs
-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
-- }}}
--- {{{
--- 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
+
+-- 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
end
-- }}}
--- {{{ Format units to one decimal point
+-- {{{ Timer maker
+
+helpers.timer_table = {}
-function helpers.uformat(array, key, value, unit)
- for u, v in pairs(unit) do
- array["{"..key.."_"..u.."}"] = string.format("%.1f", value/v)
+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
- return array
+ 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
-- }}}
--- {{{ Read the first line of a file or return nil.
+-- {{{ Pipe operations
-function helpers.first_line(f)
- local fp = io.open(f)
- if not fp
- then
- return nil
- end
+-- 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
- local content = fp:read("*l")
- fp:close()
- return content
+-- 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
-- }}}
-- }}}
+-- {{{ 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
+end
+
+-- shallow copy a table
+function helpers.table_shallowcopy(orig)
+ local orig_type = type(orig)
+ local copy
+ if orig_type == 'table' then
+ copy = {}
+ for orig_key, orig_value in pairs(orig) do
+ copy[orig_key] = orig_value
+ end
+ else -- number, string, boolean, etc
+ copy = orig
+ end
+ return copy
+end
+
+-- }}}
+
return helpers
projects / etc / awesome.git / blobdiff