lain/layout/centerfair.lua

--[[
                                                 
     Licensed under GNU General Public License v2
      * (c) 2014,      projektile                
      * (c) 2013,      Luke Bonham               
      * (c) 2010,      Nicolas Estibals          
      * (c) 2010-2012, Peter Hofmann             
                                                 
--]]

local tag       = require("awful.tag")
local beautiful = require("beautiful")
local math      = { ceil  = math.ceil,
                    floor = math.floor,
                    max   = math.max }
local tonumber  = tonumber

local centerfair  = { name = "centerfair" }

function centerfair.arrange(p)
    -- Layout with fixed number of vertical columns (read from nmaster).
    -- Cols are centerded until there is nmaster columns, then windows
    -- are stacked in the slave columns, with at most ncol clients per
    -- column if possible.

    -- with nmaster=3 and ncol=1 you'll have
    --        (1)                (2)                (3)
    --   +---+---+---+      +-+---+---+-+      +---+---+---+
    --   |   |   |   |      | |   |   | |      |   |   |   |
    --   |   | 1 |   |  ->  | | 1 | 2 | | ->   | 1 | 2 | 3 |  ->
    --   |   |   |   |      | |   |   | |      |   |   |   |
    --   +---+---+---+      +-+---+---+-+      +---+---+---+

    --        (4)                (5)
    --   +---+---+---+      +---+---+---+
    --   |   |   | 3 |      |   | 2 | 4 |
    --   + 1 + 2 +---+  ->  + 1 +---+---+
    --   |   |   | 4 |      |   | 3 | 5 |
    --   +---+---+---+      +---+---+---+

    -- A useless gap (like the dwm patch) can be defined with
    -- beautiful.useless_gap_width .
    local useless_gap = tonumber(beautiful.useless_gap_width) or 0
    if useless_gap < 0 then useless_gap = 0 end

    -- A global border can be defined with
    -- beautiful.global_border_width
    local global_border = tonumber(beautiful.global_border_width) or 0
    if global_border < 0 then global_border = 0 end

    -- Screen.
    local wa = p.workarea
    local cls = p.clients

    -- Borders are factored in.
    wa.height = wa.height - (global_border * 2)
    wa.width = wa.width - (global_border * 2)
    wa.x = wa.x + global_border
    wa.y = wa.y + global_border

    -- How many vertical columns? Read from nmaster on the tag.
    local t = tag.selected(p.screen)
    local num_x = centerfair.nmaster or tag.getnmaster(t)
    local ncol = centerfair.ncol or tag.getncol(t)
    if num_x <= 2 then num_x = 2 end

    local width = math.floor((wa.width - (num_x + 1)*useless_gap) / num_x)

    if #cls < num_x
    then
        -- Less clients than the number of columns, let's center it!
        local offset_x = wa.x + (wa.width - #cls*width - (#cls - 1)*useless_gap) / 2
        local g = {}
        g.y = wa.y + useless_gap
        for i = 1, #cls do
            local c = cls[i]
            g.width = width - 2*c.border_width
            g.height = wa.height - 2*useless_gap - 2*c.border_width
            if g.width < 1 then g.width = 1 end
            if g.height < 1 then g.height = 1 end
            g.x = offset_x + (i - 1) * (width + useless_gap)
            c:geometry(g)
        end
    else
        -- More clients than the number of columns, let's arrange it!
        -- Master client deserves a special treatement
        local c = cls[1]
        local g = {}
        g.width = wa.width - (num_x - 1)*width - (num_x + 1)*useless_gap - 2*c.border_width
        g.height = wa.height - 2*useless_gap - 2*c.border_width
        if g.width < 1 then g.width = 1 end
        if g.height < 1 then g.height = 1 end
        g.x = wa.x + useless_gap
        g.y = wa.y + useless_gap

        c:geometry(g)

        -- Treat the other clients

        -- Compute distribution of clients among columns
        local num_y ={}
        do
            local remaining_clients = #cls-1
            local ncol_min = math.ceil(remaining_clients/(num_x-1))
            if ncol >= ncol_min
            then
                for i = (num_x-1), 1, -1 do
                    if (remaining_clients-i+1) < ncol
                    then
                        num_y[i] = remaining_clients-i + 1
                    else
                        num_y[i] = ncol
                    end
                    remaining_clients = remaining_clients - num_y[i]
                end
            else
                local rem = remaining_clients % (num_x-1)
                if rem ==0
                then
                    for i = 1, num_x-1 do
                        num_y[i] = ncol_min
                    end
                else
                    for i = 1, num_x-1 do
                        num_y[i] = ncol_min - 1
                    end
                    for i = 0, rem-1 do
                        num_y[num_x-1-i] = num_y[num_x-1-i] + 1
                    end
                end
            end
        end

        -- Compute geometry of the other clients
        local nclient = 2 -- we start with the 2nd client
        g.x = g.x + g.width + useless_gap + 2*c.border_width

        for i = 1, (num_x-1) do
            local height = math.floor((wa.height - (num_y[i] + 1)*useless_gap) / num_y[i])
            g.y = wa.y + useless_gap
            for j = 0, (num_y[i]-2) do
                local c = cls[nclient]
                g.height = height - 2*c.border_width
                g.width = width - 2*c.border_width
                if g.width < 1 then g.width = 1 end
                if g.height < 1 then g.height = 1 end
                c:geometry(g)
                nclient = nclient + 1
                g.y = g.y + height + useless_gap
            end
            local c = cls[nclient]
            g.height = wa.height - (num_y[i] + 1)*useless_gap - (num_y[i] - 1)*height - 2*c.border_width
            g.width = width - 2*c.border_width
            if g.width < 1 then g.width = 1 end
            if g.height < 1 then g.height = 1 end
            c:geometry(g)
            nclient = nclient + 1
            g.x = g.x + width + useless_gap
        end
    end
end

return centerfair