awful.widget.graph: import

Signed-off-by: Julien Danjou <julien@danjou.info>

lib/awful/widget/graph.lua.in

@@ -0,0 +1,200 @@
+---------------------------------------------------------------------------
+-- @author Julien Danjou <julien@danjou.info>
+-- @copyright 2009 Julien Danjou
+-- @release @AWESOME_VERSION@
+---------------------------------------------------------------------------
+
+local setmetatable = setmetatable
+local ipairs = ipairs
+local math = math
+local table = table
+local capi = { image = image,
+               widget = widget }
+
+--- A graph widget.
+module("awful.widget.graph")
+
+local data = setmetatable({}, { __mode = "k" })
+
+--- Set the graph border color.
+-- If the value is nil, no border will be drawn.
+-- @name set_border_color
+-- @class function
+-- @param graph The graph.
+-- @param color The border color to set.
+
+--- Set the graph foreground color as a gradient.
+-- @name set_gradient_colors
+-- @class function
+-- @param graph The graph.
+-- @param gradient_colors A table with gradients colors. The distance between each color
+-- can also be specified. Example: { "red", "blue" } or { "red", "green",
+-- "blue", blue = 10 } to specify blue distance from other colors.
+
+--- Set the graph foreground colors gradient angle. Default is 240 degrees
+-- (horizontal).
+-- @name set_gradient_angle
+-- @class function
+-- @param graph The graph.
+-- @param gradient_angle Angle of gradient in degrees.
+
+--- Set the graph foreground color.
+-- @name set_color
+-- @class function
+-- @param graph The graph.
+-- @param color The graph color.
+
+--- Set the graph background color.
+-- @name set_background_color
+-- @class function
+-- @param graph The graph.
+-- @param color The graph background color.
+
+local properties = { "width", "height", "border_color",
+                     "gradient_colors", "gradient_angle", "color",
+                     "background_color" }
+
+local function update(graph)
+    -- Create new empty image
+    local img = capi.image.argb32(data[graph].width, data[graph].height, nil)
+
+    local border_width = 0
+    if data[graph].border_color then
+        -- Draw border
+        img:draw_rectangle(0, 0, data[graph].width, data[graph].height,
+                           false, data[graph].border_color or "white")
+        border_width = 1
+    end
+
+    local values = data[graph].values
+
+    -- Draw background
+    -- Draw full gradient
+    if data[graph].gradient_colors then
+        img:draw_rectangle_gradient(border_width, border_width,
+                                    data[graph].width - (2 * border_width),
+                                    data[graph].height - (2 * border_width),
+                                    data[graph].gradient_colors,
+                                    data[graph].gradient_angle or 270)
+    else
+        img:draw_rectangle(border_width, border_width,
+                           data[graph].width - (2 * border_width),
+                           data[graph].height - (2 * border_width),
+                           true, data[graph].color or "red")
+    end
+
+    -- No value? Draw nothing.
+    if #values ~= 0 then
+        -- Draw reverse
+        for i = 0, #values - 1 do
+            if values[#values - i] > 0 then
+                -- Do not draw a pixel if the value is 1
+                if values[#values - i] ~= 1 then
+                    img:draw_line(data[graph].width - border_width - i - 1,
+                                  border_width + ((data[graph].height - 2 * border_width) * (1 - values[#values - i])),
+                                  data[graph].width - border_width - i - 1,
+                                  border_width,
+                                  data[graph].background_color or "#000000aa")
+                end
+            end
+        end
+    end
+
+    -- If we did not draw values everywhere, draw a square over the last left
+    -- part to set everything to 0 :-)
+    if #values < data[graph].width - (2 * border_width) then
+        img:draw_rectangle(border_width, border_width,
+                           data[graph].width - (2 * border_width) - #values,
+                           data[graph].height - (2 * border_width),
+                           true, data[graph].background_color or "#000000aa")
+    end
+
+
+    -- Update the image
+    graph.widget.image = img
+end
+
+--- Add a value to the graph
+-- @param graph The graph.
+-- @param value The value between 0 and 1.
+local function add_value(graph, value)
+    if not graph then return end
+
+    local value = value or 0
+    value = math.min(1, math.max(0, value))
+
+    table.insert(data[graph].values, value)
+
+    local border_width = 0
+    if data[graph].border then border_width = 2 end
+
+    -- Ensure we never have more data than we can draw
+    while #data[graph].values > data[graph].width - border_width do
+        table.remove(data[graph].values, 1)
+    end
+
+    update(graph)
+end
+
+
+--- Set the graph height.
+-- @param graph The graph.
+-- @param height The height to set.
+local function set_height(graph, height)
+    if height >= 5 then
+        data[graph].height = height
+        update(graph)
+    end
+end
+
+--- Set the graph width.
+-- @param graph The graph.
+-- @param width The width to set.
+local function set_width(graph, width)
+    if width >= 5 then
+        data[graph].width = width
+        update(graph)
+    end
+end
+
+-- Build properties function
+for _, prop in ipairs(properties) do
+    if not _M["set_" .. prop] then
+        _M["set_" .. prop] = function(graph, value)
+            data[graph][prop] = value
+            update(graph)
+        end
+    end
+end
+
+--- Create a graph widget.
+-- @param args Standard widget() arguments. You should add width and height
+-- key to set graph geometry.
+-- @return A graph widget.
+function new(args)
+    local args = args or {}
+    args.type = "imagebox"
+
+    local width = args.width or 100
+    local height = args.height or 20
+
+    if width < 5 or height < 5 then return end
+
+    local graph = {}
+    graph.widget = capi.widget(args)
+
+    data[graph] = { width = width, height = height, values = {} }
+
+    -- Set methods
+    graph.add_value = add_value
+
+    for _, prop in ipairs(properties) do
+        graph["set_" .. prop] = _M["set_" .. prop]
+    end
+
+    return graph
+end
+
+setmetatable(_M, { __call = function(_, ...) return new(...) end })
+
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80

lib/awful/widget/init.lua.in

@@ -10,6 +10,7 @@ require("awful.widget.button")
 require("awful.widget.launcher")
 require("awful.widget.prompt")
 require("awful.widget.progressbar")
+require("awful.widget.graph")
 
 --- Widget module for awful
 module("awful.widget")