blingbling/value_text_box.lua

-- @author cedlemo  

local setmetatable = setmetatable
local ipairs = ipairs
local math = math
local table = table
local type = type
local string = string
local color = require("gears.color")
local base = require("wibox.widget.base")
local helpers = require("blingbling.helpers")
local superproperties = require("blingbling.superproperties")
---A text box that can display value and text with colors. 
--@module blingbling.value_text_box

local value_text_box = { mt = {} }
local data = setmetatable({}, { __mode = "k" })

---Fill all the widget with this color (default is transparent).
--@usage myvt_box:set_background_color(string) -->"#rrggbbaa"
--@name set_background_color
--@class function
--@param color a string "#rrggbbaa" or "#rrggbb"

---Fill the text area (text height/width + padding) background with this color (default is none).
--@usage myvt_box:set_text_background_color(string) -->"#rrggbbaa"
--@name set_text_background_color
--@class function
--@param color a string "#rrggbbaa" or "#rrggbb"

---Set a border on the text area background (default is none ). 
--@usage myvt_box:set_text_background_border(string) -->"#rrggbbaa"
--@name set_text_background_border
--@class function
--@param color a string "#rrggbbaa" or "#rrggbb"

---Define the top and bottom margin for the text background. 
--@usage myvt_box:set_v_margin(integer)
--@name set_v_margin
--@class function
--@param margin an integer for top and bottom margin

---Define the left and right margin for the text background.
--@usage myvt_box:set_h_margin(integer) 
--@name set_h_margin
--@class function
--@param margin an integer for left and right margin

---Define the padding between the text and it's background.
--@usage myvt_box:set_padding(integer) 
--@name set_h_margin
--@class function
--@param padding an integer for the text padding

---Set rounded corners for background and text background.
--@usage myvt_box:set_rounded_size(a) -> a in [0,1]
--@name set_rounded_size
--@class function
--@param rounded_size float in [0,1]

---Define the color for all the text of the widget (white by default).
--@usage myvt_box:set_text_color(string) -->"#rrggbbaa"
--@name set_text_color
--@class function
--@param color a string "#rrggbbaa" or "#rrggbb

---Define the value text color depending on the limit given ( if value >= limit, we apply the color).
--@usage myvt_box:set_values_text_color(table) -->{ {"#rrggbbaa", limit 1}, {"#rrggbbaa", limit 2}}
--  By default the color is text_color(another example: {{"#88aa00ff",0},{"#d4aa00ff", 0.5},{"#d45500ff",0.75}})
--@name set_values_text_color
--@class function
--@param table table like { {"#rrggbbaa", limit 1}, {"#rrggbbaa", limit 2}}

---Define the text font size.
--@usage myvt_box:set_font_size(integer)
--@name set_font_size
--@class function
--@param size the font size

---Define displayed text value format string
--@usage mypgraph:set_value_format(string) --> "%2.f"
--@name set_value_format
--@class function
--@param printf format string for display text


---Define the template of the text to display.
--@usage myvt_box:set_label(string)
--By default the text is : (value_send_to_the_widget *100) 
--static string: example set_label("CPU usage:") will display "CUP usage:" on the vt_box
--dynamic string: use $percent in the string example set_label("Load $percent %") will display "Load 10%" 
--@name set_label
--@class function
--@param text the text to display

local properties = {    "width", "height", "h_margin", "v_margin", "padding",
                        "background_color", 
                        "background_text_border", "text_background_color",
                        "rounded_size", "text_color", "values_text_color", 
                        "font_size", "font", "label", "value_format"
                   }

function value_text_box.draw(vt_box, wibox, cr, width, height)
  --find the width of our image
  local props = helpers.load_properties(properties, data, vt_box, superproperties)
  local value = string.format(props.value_format,
                              data[vt_box].value * 100)
--  local label = data[vt_box].label or "$percent"
  local text = string.gsub(props.label,"$percent", value)

  cr:set_font_size(props.font_size)

  if type(props.font) == "string" then
    cr:select_font_face(props.font,nil,nil)
  elseif type(props.font) == "table" then
    cr:select_font_face(props.font.family or "Sans",
                        props.font.slang or "normal",
                        props.font.weight or "normal")
  end
      
  
  local ext = cr:text_extents(text)
  local height = ( (props.font_size + 2* props.padding + 2* props.v_margin) > data[vt_box].height ) and props.font_size + 2* props.padding + 2* props.v_margin or data[vt_box].height
  local width = ( math.ceil(ext.width +2*ext.x_bearing+ 2*props.padding + 2* props.h_margin) > data[vt_box].width ) and  math.ceil(ext.width +2*ext.x_bearing+ 2*props.padding + 2* props.h_margin) or data[vt_box].width

  if data[vt_box].width == nil or data[vt_box].width < width then
    data[vt_box].width = width
  end
  if data[vt_box].height == nil or data[vt_box].height < height then
    data[vt_box].height = height
  end
  
  --Generate Background (background widget)
  if data[vt_box].background_color then
    helpers.draw_rounded_corners_rectangle( cr,
                                            0,
                                            0,
                                            data[vt_box].width, 
                                            data[vt_box].height,
                                            props.background_color, 
                                            props.rounded_size)
  
  end
  
  --Draw nothing, or filled ( value background)
  if data[vt_box].text_background_color then
    --draw rounded corner rectangle
    local x=props.h_margin
    local y=props.v_margin
    
    helpers.draw_rounded_corners_rectangle( cr,
                                            x,
                                            y,
                                            data[vt_box].width - props.h_margin, 
                                            data[vt_box].height - props.v_margin, 
                                            props.text_background_color, 
                                            props.rounded_size,
                                            props.background_text_border
                                            )
  end  
    --draw the value

    --analyse the label :
    label_parts={}
    label_length = string.len(props.label)
    value_start, value_finish = string.find(props.label, "$percent")
    table.insert(label_parts,{1, value_start -1})
    table.insert(label_parts,{value_start, value_finish,is_value = true})
    local new_start = value_finish + 1
    if value_finish < label_length then
      while value_start ~= nil do
        value_start, value_finish = string.find(props.label, "$percent", new_start)
        if value_start ~=nil and value_start ~= new_start then
          table.insert(label_parts,{new_start, value_start -1})
          table.insert(label_parts,{value_start, value_finish, is_value = true})
          new_start = value_finish + 1
        elseif value_start == new_start then
          table.insert(label_parts,{value_start, value_finish, is_value = true})
          new_start = value_finish + 1
        end
      end
      --if rest char:
      if label_parts[#label_parts][2] < label_length then
        table.insert(label_parts,{label_parts[#label_parts][2] + 1, label_length})
      end
    end
   
    --Position the  x start of the text. If rounded_corner, then we move the text on the right
    local move_because_of_rounded_corners=0
    if width> height then
      move_because_of_rounded_corners=((height/2) * props.rounded_size)/2
    else
      move_because_of_rounded_corners=((width/2) * props.rounded_size)/2
    end
    x= props.h_margin + props.padding + move_because_of_rounded_corners
    y= 0 
    --Draw the text:
    -- TODO necessity for this variable (default_text_color ??)
    local default_text_color =props.text_color 
		local value_text_color = default_text_color 
    for i,table in ipairs(props.values_text_color) do
      if i == 1 then 
        if value/100 >= table[2] then
          value_text_color = table[1]
        end
      elseif i ~= 1 then
        if value/100 >= table[2]  then
          value_text_color = table[1]
        end
      end
    end
    for i,range in ipairs(label_parts) do
      if range.is_value then 
        text = value
        --dirty trick : if there are spaces at the end of cairo text, they aren't represented so I put them at the begining of the value:
        for j=range[1],label_parts[i-1][1], -1 do
          if string.sub(props.label, j,j) == " " then
            text = " " .. text
          end
        end
        r,g,b,a = helpers.hexadecimal_to_rgba_percent(value_text_color)
        cr:set_source_rgba(r,g,b,a)
        ext = cr:text_extents(text)
        y=math.floor(data[vt_box].height/2 + props.font_size/2 - props.padding/2) 
        cr:set_font_size(props.font_size)
        cr:move_to(x,y)
        cr:show_text(text)
        x=x+ext.width + ext.x_bearing
      else
        text=string.sub(props.label, range[1],range[2])
        text=string.gsub(text, "(.*[^%s]*)(%s*)","%1")
        r,g,b,a = helpers.hexadecimal_to_rgba_percent(props.text_color)
        cr:set_source_rgba(r,g,b,a)
        ext = cr:text_extents(text)
       
        y=math.floor(data[vt_box].height/2 + props.font_size/2 - props.padding/2) 
 
        cr:set_font_size(props.font_size)
        cr:move_to(x,y)
        cr:show_text(text)
        x=x+ext.width --+ext.x_bearing
      end
    end

end

function value_text_box.fit(vt_box, width, height)
    return data[vt_box].width, data[vt_box].height
end

--- Add a value to the vt_box.
-- For compatibility between old and new awesome widget, add_value can be replaced by set_value
-- @usage myvt_box:add_value(a) or myvt_box:set_value(a)
-- @param vt_box The vt_box.
-- @param value The value between 0 and 1.
local function add_value(vt_box, value)
    if not vt_box then return end

    local value = value or 0
   
    if string.find(value, "nan") then
       value=0
    end
   
    data[vt_box].value = value
    vt_box:emit_signal("widget::updated")
    return vt_box
end


--- Set the vt_box height.
-- @param height The height to set.
function value_text_box:set_height( height)
    if height >= 5 then
        data[self].height = height
        self:emit_signal("widget::updated")
    end
    return self
end

--- Set the vt_box width.
-- @param width The width to set.
function value_text_box:set_width( width)
    if width >= 5 then
        data[self].width = width
        self:emit_signal("widget::updated")
    end
    return self
end

-- Build properties function
for _, prop in ipairs(properties) do
    if not value_text_box["set_" .. prop] then
        value_text_box["set_" .. prop] = function(vt_box, value)
            data[vt_box][prop] = value
            vt_box:emit_signal("widget::updated")
            return vt_box
        end
    end
end

--- Create a vt_box widget.
-- @param args Standard widget() arguments. You can add width and height keys to set vt_box geometry.
-- @return A vt_box widget.
function value_text_box.new(args)
    local args = args or {}

    args.width = args.width or 100
    args.height = args.height or 20

    if args.width < 5 or args.height < 5 then return end


    local vt_box = base.make_widget()
    data[vt_box] = {}
    
    for _, v in ipairs(properties) do
      data[vt_box][v] = args[v] 
    end
    
    -- Set methods
    vt_box.set_value = set_value
    vt_box.add_value = add_value
    vt_box.draw = value_text_box.draw
    vt_box.fit = value_text_box.fit

    for _, prop in ipairs(properties) do
        vt_box["set_" .. prop] = value_text_box["set_" .. prop]
    end

    return vt_box
end
function value_text_box.mt:__call(...)
    return value_text_box.new(...)
end

return setmetatable(value_text_box, value_text_box.mt)