From eddbbf7acac3270af89985a31751ab87bedf1ef7 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Thu, 26 May 2016 19:41:58 -0400 Subject: [PATCH] ratio: Enable the property system And add the missing documentation --- lib/wibox/layout/ratio.lua | 92 ++++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 44 deletions(-) diff --git a/lib/wibox/layout/ratio.lua b/lib/wibox/layout/ratio.lua index 98c5132f..072b64af 100644 --- a/lib/wibox/layout/ratio.lua +++ b/lib/wibox/layout/ratio.lua @@ -25,9 +25,9 @@ local ratio = {} local function gen_sum(self, i_s, i_e) local sum, new_w = 0,0 - for i = i_s or 1, i_e or #self.widgets do - if self._ratios[i] then - sum = sum + self._ratios[i] + for i = i_s or 1, i_e or #self._private.widgets do + if self._private.ratios[i] then + sum = sum + self._private.ratios[i] else new_w = new_w + 1 end @@ -42,24 +42,24 @@ end -- specific ratio must be enforced for a widget, it has to be done with the -- `ajust_ratio` method after each insertion or deletion local function normalize(self) - local count = #self.widgets + local count = #self._private.widgets if count == 0 then return end -- Instead of adding "if" everywhere, just handle this common case if count == 1 then - self._ratios = { 1 } + self._private.ratios = { 1 } return end local sum, new_w = gen_sum(self) - local old_count = #self.widgets - new_w + local old_count = #self._private.widgets - new_w local to_add = (sum == 0) and 1 or (sum / old_count) -- Make sure all widgets have a ratio - for i=1, #self.widgets do - if not self._ratios[i] then - self._ratios[i] = to_add + for i=1, #self._private.widgets do + if not self._private.ratios[i] then + self._private.ratios[i] = to_add end end @@ -68,9 +68,9 @@ local function normalize(self) local delta, new_sum = (1 - sum) / count,0 -- Increase or decrease each ratio so it the sum become 1 - for i=1, #self.widgets do - self._ratios[i] = self._ratios[i] + delta - new_sum = new_sum + self._ratios[i] + for i=1, #self._private.widgets do + self._private.ratios[i] = self._private.ratios[i] + delta + new_sum = new_sum + self._private.ratios[i] end -- Floating points is not an exact science, but it should still be close @@ -80,18 +80,18 @@ end function ratio:layout(_, width, height) local result = {} - local pos,spacing = 0, self._spacing + local pos,spacing = 0, self._private.spacing - for k, v in ipairs(self.widgets) do + for k, v in ipairs(self._private.widgets) do local space local x, y, w, h - if self.dir == "y" then - space = height * self._ratios[k] + if self._private.dir == "y" then + space = height * self._private.ratios[k] x, y = 0, util.round(pos) w, h = width, floor(space) else - space = width * self._ratios[k] + space = width * self._private.ratios[k] x, y = util.round(pos), 0 w, h = floor(space), height end @@ -102,8 +102,8 @@ function ratio:layout(_, width, height) -- Make sure all widgets fit in the layout, if they aren't, something -- went wrong - if (self.dir == "y" and util.round(pos) >= height) or - (self.dir ~= "y" and util.round(pos) >= width) then + if (self._private.dir == "y" and util.round(pos) >= height) or + (self._private.dir ~= "y" and util.round(pos) >= width) then break end end @@ -118,14 +118,14 @@ end -- @tparam number increment An floating point value between -1 and 1 where the -- end result is within 0 and 1 function ratio:inc_ratio(index, increment) - if #self.widgets == 1 or (not index) or (not self._ratios[index]) + if #self._private.widgets == 1 or (not index) or (not self._private.ratios[index]) or increment < -1 or increment > 1 then return end - assert(self._ratios[index]) + assert(self._private.ratios[index]) - self:set_ratio(index, self._ratios[index] + increment) + self:set_ratio(index, self._private.ratios[index] + increment) end --- Increment the ratio of the first instance of `widget` @@ -146,22 +146,22 @@ end -- @tparam number index The index of the widget to change -- @tparam number percent An floating point value between 0 and 1 function ratio:set_ratio(index, percent) - if not percent or #self.widgets == 1 or not index or not self.widgets[index] + if not percent or #self._private.widgets == 1 or not index or not self._private.widgets[index] or percent < 0 or percent > 1 then return end - local old = self._ratios[index] + local old = self._private.ratios[index] -- Remove what has to be cleared from all widget - local delta = ( (percent-old) / (#self.widgets-1) ) + local delta = ( (percent-old) / (#self._private.widgets-1) ) - for k in pairs(self.widgets) do - self._ratios[k] = self._ratios[k] - delta + for k in pairs(self._private.widgets) do + self._private.ratios[k] = self._private.ratios[k] - delta end -- Set the new ratio - self._ratios[index] = percent + self._private.ratios[index] = percent -- As some widgets may now have a slightly negative ratio, normalize again normalize(self) @@ -174,7 +174,7 @@ end -- @treturn number The index (between 0 and 1) function ratio:get_ratio(index) if not index then return end - return self._ratios[index] + return self._private.ratios[index] end --- Set the ratio of `widget` to `percent`. @@ -193,7 +193,7 @@ end -- @tparam number itself The ratio for "widget" -- @tparam number after The sum of the ratio after the widget function ratio:ajust_ratio(index, before, itself, after) - if not self.widgets[index] or not before or not itself or not after then + if not self._private.widgets[index] or not before or not itself or not after then return end @@ -204,21 +204,21 @@ function ratio:ajust_ratio(index, before, itself, after) if sum > 1.01 or sum < -0.99 then return end -- Compute the before and after offset to be applied to each widgets - local before_count, after_count = index-1, #self.widgets - index + local before_count, after_count = index-1, #self._private.widgets - index local b, a = gen_sum(self, 1, index-1), gen_sum(self, index+1) local db, da = (before - b)/before_count, (after - a)/after_count -- Apply the new ratio - self._ratios[index] = itself + self._private.ratios[index] = itself -- Equality split the delta among widgets before and after for i = 1, index -1 do - self._ratios[i] = self._ratios[i] + db + self._private.ratios[i] = self._private.ratios[i] + db end - for i = index+1, #self.widgets do - self._ratios[i] = self._ratios[i] + da + for i = index+1, #self._private.widgets do + self._private.ratios[i] = self._private.ratios[i] + da end -- Remove potential negative ratio @@ -245,7 +245,7 @@ function ratio:add(...) assert(args.n > 0, "need at least one widget to add") for i=1, args.n do base.check_widget(args[i]) - table.insert(self.widgets, args[i]) + table.insert(self._private.widgets, args[i]) end normalize(self) @@ -256,10 +256,10 @@ end -- @tparam number index The widget index to remove -- @treturn boolean index If the operation is successful function ratio:remove(index) - if not index or not self.widgets[index] then return false end + if not index or not self._private.widgets[index] then return false end - table.remove(self._ratios, index) - table.remove(self.widgets, index) + table.remove(self._private.ratios, index) + table.remove(self._private.widgets, index) normalize(self) @@ -272,11 +272,11 @@ end -- @tparam number index The position -- @param widget The widget function ratio:insert(index, widget) - if not index or index < 1 or index > #self.widgets + 1 then return false end + if not index or index < 1 or index > #self._private.widgets + 1 then return false end base.check_widget(widget) - table.insert(self.widgets, index, widget) + table.insert(self._private.widgets, index, widget) normalize(self) @@ -286,11 +286,11 @@ end local function get_layout(dir, widget1, ...) local ret = flex[dir](widget1, ...) - util.table.crush(ret, ratio) + util.table.crush(ret, ratio, true) - ret.fill_space = nil + ret._private.fill_space = nil - ret._ratios = {} + ret._private.ratios = {} return ret end @@ -309,6 +309,10 @@ function ratio.vertical(...) return get_layout("vertical", ...) end +--@DOC_widget_COMMON@ + +--@DOC_object_COMMON@ + return ratio -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80