Update users home folder, clean up some scripts and add comments

home/.config/awesome/vicious/contrib/pulse.lua

@@ -12,13 +12,13 @@ local setmetatable = setmetatable
 local os = { execute = os.execute }
 local table = { insert = table.insert }
 local string = {
-    find = string.find,
-    match = string.match,
-    format = string.format,
-    gmatch = string.gmatch
+  find = string.find,
+  match = string.match,
+  format = string.format,
+  gmatch = string.gmatch
 }
 local math = {
-    floor = math.floor
+  floor = math.floor
 }
 -- }}}
 
@@ -29,36 +29,36 @@ local pulse = {}
 
 -- {{{ Helper function
 local function pacmd(args)
-    local f = io.popen("pacmd "..args)
-    if f == nil then
-      return nil
-    else
-      local line = f:read("*all")
-      f:close()
-      return line
-    end
+  local f = io.popen("pacmd "..args)
+  if f == nil then
+    return nil
+  else
+    local line = f:read("*all")
+    f:close()
+    return line
+  end
 end
 
 local function escape(text)
-    local special_chars = { ["."] = "%.", ["-"] = "%-" }
-    return text:gsub("[%.%-]", special_chars)
+  local special_chars = { ["."] = "%.", ["-"] = "%-" }
+  return text:gsub("[%.%-]", special_chars)
 end
 
 local cached_sinks = {}
 local function get_sink_name(sink)
-    if type(sink) == "string" then return sink end
-    -- avoid nil keys
-    local key = sink or 1
-    -- Cache requests
-    if not cached_sinks[key] then
-      local line = pacmd("list-sinks")
-      if line == nil then return nil end
-      for s in string.gmatch(line, "name: <(.-)>") do
-          table.insert(cached_sinks, s)
-      end
+  if type(sink) == "string" then return sink end
+  -- avoid nil keys
+  local key = sink or 1
+  -- Cache requests
+  if not cached_sinks[key] then
+    local line = pacmd("list-sinks")
+    if line == nil then return nil end
+    for s in string.gmatch(line, "name: <(.-)>") do
+      table.insert(cached_sinks, s)
     end
+  end
 
-    return cached_sinks[key]
+  return cached_sinks[key]
 end
 
 
@@ -66,55 +66,55 @@ end
 
 -- {{{ Pulseaudio widget type
 local function worker(format, sink)
-    sink = get_sink_name(sink)
-    if sink == nil then return {0, "unknown"} end
+  sink = get_sink_name(sink)
+  if sink == nil then return {0, "unknown"} end
 
-    -- Get sink data
-    local data = pacmd("dump")
-    if sink == nil then return {0, "unknown"} end
+  -- Get sink data
+  local data = pacmd("dump")
+  if sink == nil then return {0, "unknown"} end
 
-    -- If mute return 0 (not "Mute") so we don't break progressbars
-    if string.find(data,"set%-sink%-mute "..escape(sink).." yes") then
-        return {0, "off"}
-    end
+  -- If mute return 0 (not "Mute") so we don't break progressbars
+  if string.find(data,"set%-sink%-mute "..escape(sink).." yes") then
+    return {0, "off"}
+  end
 
-    local vol = tonumber(string.match(data, "set%-sink%-volume "..escape(sink).." (0x[%x]+)"))
-    if vol == nil then vol = 0 end
+  local vol = tonumber(string.match(data, "set%-sink%-volume "..escape(sink).." (0x[%x]+)"))
+  if vol == nil then vol = 0 end
 
-    return { math.floor(vol/0x10000*100), "on"}
+  return { math.floor(vol/0x10000*100), "on"}
 end
 -- }}}
 
 -- {{{ Volume control helper
 function pulse.add(percent, sink)
-    sink = get_sink_name(sink)
-    if sink == nil then return end
+  sink = get_sink_name(sink)
+  if sink == nil then return end
 
-    local data = pacmd("dump")
+  local data = pacmd("dump")
 
-    local pattern = "set%-sink%-volume "..escape(sink).." (0x[%x]+)"
-    local initial_vol =  tonumber(string.match(data, pattern))
+  local pattern = "set%-sink%-volume "..escape(sink).." (0x[%x]+)"
+  local initial_vol =  tonumber(string.match(data, pattern))
 
-    local vol = initial_vol + percent/100*0x10000
-    if vol > 0x10000 then vol = 0x10000 end
-    if vol < 0 then vol = 0 end
+  local vol = initial_vol + percent/100*0x10000
+  if vol > 0x10000 then vol = 0x10000 end
+  if vol < 0 then vol = 0 end
 
-    local cmd = string.format("pacmd set-sink-volume %s 0x%x >/dev/null", sink, vol)
-    return os.execute(cmd)
+  local cmd = string.format("pacmd set-sink-volume %s 0x%x >/dev/null", sink, vol)
+  return os.execute(cmd)
 end
 
 function pulse.toggle(sink)
-    sink = get_sink_name(sink)
-    if sink == nil then return end
+  sink = get_sink_name(sink)
+  if sink == nil then return end
 
-    local data = pacmd("dump")
-    local pattern = "set%-sink%-mute "..escape(sink).." (%a%a%a?)"
-    local mute = string.match(data, pattern)
+  local data = pacmd("dump")
+  local pattern = "set%-sink%-mute "..escape(sink).." (%a%a%a?)"
+  local mute = string.match(data, pattern)
 
-    -- 0 to enable a sink or 1 to mute it.
-    local state = { yes = 0, no = 1}
-    local cmd = string.format("pacmd set-sink-mute %s %d", sink, state[mute])
-    return os.execute(cmd)
+  -- 0 to enable a sink or 1 to mute it.
+  local state = { yes = 0, no = 1}
+  local cmd = string.format("pacmd set-sink-mute %s %d", sink, state[mute])
+  return os.execute(cmd)
 end
 -- }}}