lain/layout/cascadetile.lua

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

local tag       = require("awful.tag")
local beautiful = require("beautiful")
local tonumber  = tonumber

local cascadetile =
{
    name          = "cascadetile",
    nmaster       = 0,
    ncol          = 0,
    mwfact        = 0,
    offset_x      = 5,
    offset_y      = 32,
    extra_padding = 0
}

function cascadetile.arrange(p)

    -- Layout with one fixed column meant for a master window. Its
    -- width is calculated according to mwfact. Other clients are
    -- cascaded or "tabbed" in a slave column on the right.

    -- It's a bit hard to demonstrate the behaviour with ASCII-images...
    --
    --         (1)                 (2)                 (3)                 (4)
    --   +----------+---+    +----------+---+    +----------+---+    +----------+---+
    --   |          |   |    |          | 3 |    |          | 4 |    |         +---+|
    --   |          |   | -> |          |   | -> |         +---++ -> |        +---+|+
    --   |  1       | 2 |    |  1      +---++    |  1      | 3 ||    |  1    +---+|+|
    --   |          |   |    |         | 2 ||    |        +---++|    |      +---+|+ |
    --   |          |   |    |         |   ||    |        | 2 | |    |      | 2 |+  |
    --   +----------+---+    +---------+---++    +--------+---+-+    +------+---+---+

    -- 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

    -- Themes border width requires an offset
    local bw = tonumber(beautiful.border_width) or 0

    -- 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)

    -- Width of main column?
    local t = tag.selected(p.screen)
    local mwfact
    if cascadetile.mwfact > 0
    then
        mwfact = cascadetile.mwfact
    else
        mwfact = tag.getmwfact(t)
    end

    -- Make slave windows overlap main window? Do this if ncol is 1.
    local overlap_main
    if cascadetile.ncol > 0
    then
        overlap_main = cascadetile.ncol
    else
        overlap_main = tag.getncol(t)
    end

    -- Minimum space for slave windows? See cascade.lua.
    local num_c
    if cascadetile.nmaster > 0
    then
        num_c = cascadetile.nmaster
    else
        num_c = tag.getnmaster(t)
    end

    local how_many = #cls - 1
    if how_many < num_c
    then
        how_many = num_c
    end
    local current_offset_x = cascadetile.offset_x * (how_many - 1)
    local current_offset_y = cascadetile.offset_y * (how_many - 1)

    if #cls > 0
    then
        -- Main column, fixed width and height.
        local c = cls[1]
        local g = {}
        -- Subtracting the useless_gap width from the work area width here
        -- makes this mwfact calculation work the same as in uselesstile.
        -- Explicitly rounding is necessary to prevent the rendered size of
        -- slavewid from changing depending on whether we round up or down.
        local mainwid = math.floor((wa.width - useless_gap) * mwfact)
        local slavewid = wa.width - mainwid

        if overlap_main == 1
        then
            g.width = wa.width - 2*bw

            -- The size of the main window may be reduced a little bit.
            -- This allows you to see if there are any windows below the
            -- main window.
            -- This only makes sense, though, if the main window is
            -- overlapping everything else.
            g.width = g.width - cascadetile.extra_padding
        else
            g.width = mainwid - 2*bw
        end

        g.height = wa.height - 2*bw
        g.x = wa.x + global_border
        g.y = wa.y + global_border
        if useless_gap > 0
        then
            -- Reduce width once and move window to the right. Reduce
            -- height twice, however.
            g.width = g.width - useless_gap
            g.height = g.height - 2 * useless_gap
            g.x = g.x + useless_gap
            g.y = g.y + useless_gap

            -- When there's no window to the right, add an additional
            -- gap.
            if overlap_main == 1
            then
                g.width = g.width - useless_gap
            end
        end
        c:geometry(g)

        -- Remaining clients stacked in slave column, new ones on top.
        if #cls > 1
        then
            for i = 2,#cls
            do
                c = cls[i]
                g = {}
                g.width = slavewid - current_offset_x - 2*bw
                g.height = wa.height - current_offset_y - 2*bw
                g.x = wa.x + mainwid + (how_many - (i - 1)) * cascadetile.offset_x + global_border
                g.y = wa.y + (i - 2) * cascadetile.offset_y + global_border
                if useless_gap > 0
                then
                    g.width = g.width - 2 * useless_gap
                    g.height = g.height - 2 * useless_gap
                    g.x = g.x + useless_gap
                    g.y = g.y + useless_gap
                end
                c:geometry(g)
            end
        end
    end
end

return cascadetile