awesome/tests/test-geometry.lua

--- Tests for drawing geometry

local runner    = require( "_runner"   )
local awful     = require( "awful"     )
local wibox     = require( "wibox"     )
local beautiful = require( "beautiful" )
local cruled = require("ruled.client")
local gdebug = require("gears.debug")
local test_client = require("_client")
local lgi = require("lgi")
local gears = require("gears")

local w = nil
local w1_draw, w2_draw
local windowid

-- Replacing the rules is not supported anymore.
local dep = gdebug.deprecate

local function set_rules(new_rules)
    gdebug.deprecate = function() end

    cruled.rules = {}

    cruled.append_rules(new_rules)

    gdebug.deprecate = dep
end

-- Disable automatic placement
set_rules {
    {
        rule       = { },
        properties = {
            border_width     = 0,
            size_hints_honor = false,
            x                = 0,
            y                = 0,
            width            = 100,
            height           = 100,
            border_color     = beautiful.border_color_normal
        }
    }
}

local steps = {
    function()
        if #client.get() == 0 then
            return true
        end
        for _,c in ipairs(client.get()) do
            c:kill()
        end
    end,
    -- border_color should get applied via focus signal for first client on tag.
    function(count)
        if count == 1 then
            awful.spawn("xterm")
        else
            local c = client.get()[1]
            if c then
                assert(c.size_hints_honor  == false )
                assert(c.border_width      == 0     )
                assert(c:geometry().x      == 0     )
                assert(c:geometry().y      == 0     )
                assert(c:geometry().height == 100   )
                assert(c:geometry().width  == 100   )

                c:kill()

                return true
            end
        end
    end,
    function()
        set_rules {
            -- All clients will match this rule.
            { rule = { },properties = {
                titlebars_enabled = true,
                border_width      = 10,
                border_color      = "#00ff00",
                size_hints_honor  = false,
                x                 = 0,
                y                 = 0,
                width             = 100,
                height            = 100
            }}
        }
        -- Wait for the previous c:kill() to be done
        if #client.get() == 0 then
            return true
        end
    end,
    function(count)
        if count == 1 then
            awful.spawn("xterm")
        else
            local c = client.get()[1]
            if c then
                assert(c.border_width      == 10  )
                assert(c:geometry().x      == 0   )
                assert(c:geometry().y      == 0   )
                assert(c:geometry().height == 100 )
                assert(c:geometry().width  == 100 )

                c.border_width = 20

                return true
            end
        end
    end,
    function()
        local c = client.get()[1]
        assert(c.border_width      == 20  )
        assert(c:geometry().x      == 0   )
        assert(c:geometry().y      == 0   )
        assert(c:geometry().height == 100 )
        assert(c:geometry().width  == 100 )

        c.border_width = 0

        return true
    end,
    function()
        local c = client.get()[1]

        assert(not pcall(function() c._border_width = -2000 end))
        assert(c.border_width==0)

        c.border_width = 125

        return true
    end,
    function()
        local c = client.get()[1]

        assert(c.border_width       == 125 )
        assert(c:geometry().x       == 0   )
        assert(c:geometry().y       == 0   )
        assert(c:geometry().height  == 100 )
        assert(c:geometry().width   == 100 )

        -- So it doesn't hide the other tests
        c:kill()

        return true
    end,
    function()
        w = wibox {
            ontop        = true,
            border_width = 20,
            x            = 100,
            y            = 100,
            width        = 100,
            height       = 100,
            visible      = true,
        }

        assert(w)
        assert(w.border_width == 20  )
        assert(w.width        == 100 )
        assert(w.height       == 100 )
        assert(w.x            == 100 )
        assert(w.y            == 100 )

        w:setup {
            fit    = function(_, _, _, height)
                return height, height -- A square taking the full height
            end,
            draw   = function(_, _, cr, width, height)

                assert(width  == 100)
                assert(height == 100)

                w1_draw = true
                cr:set_source_rgb(1, 0, 0) -- Red
                cr:arc(height/2, height/2, height/2, 0, math.pi*2)
                cr:fill()
            end,
            layout = wibox.widget.base.make_widget,
        }

        return true
    end,
    function()
        w.border_width = 0
        assert(w1_draw)

        return true
    end,
    function()
        assert(w.border_width == 0   )
        assert(w.width        == 100 )
        assert(w.height       == 100 )
        assert(w.x            == 100 )
        assert(w.y            == 100 )

        w:setup {
            fit    = function(_, _, _, height)
                return height, height -- A square taking the full height
            end,
            draw   = function(_, _, cr, width, height)

                assert(width  == 100)
                assert(height == 100)

                w2_draw = true
                cr:set_source_rgb(1, 0, 0) -- Red
                cr:arc(height/2, height/2, height/2, 0, math.pi*2)
                cr:fill()
            end,
            layout = wibox.widget.base.make_widget,
        }

        w.visible = false

        return true
    end,
    function()
        -- Remove the widget before the size change to avoid the asserts
        w:setup {
            fit    = function(_, _, _, height)
                return height, height -- A square taking the full height
            end,
            draw   = function(_, _, cr, _, height)
                cr:set_source_rgb(1, 0, 1) -- Purple
                cr:arc(height/2, height/2, height/2, 0, math.pi*2)
                cr:fill()
            end,
            layout = wibox.widget.base.make_widget,
        }

        w.visible = true
        assert(w2_draw)

        assert(w.border_width == 0   )
        assert(w.width        == 100 )
        assert(w.height       == 100 )
        assert(w.x            == 100 )
        assert(w.y            == 100 )

        w.border_width = 5

        w:geometry {
            x      = 200,
            y      = 200,
            width  = 200,
            height = 200,
        }

        return true
    end,
    function()
        assert(w.border_width == 5   )
        assert(w.width        == 200 )
        assert(w.height       == 200 )
        assert(w.x            == 200 )
        assert(w.y            == 200 )

        return true
    end
}

-- Tests for unmanaged client geometries with different gravity settings.
local test_data = {
    -- gravity => expectation of unmanaged x, y, w, h.
    ["NORTH_WEST"] = {0,  0,  100, 80},
    ["NORTH"] =      {10, 0,  100, 80},
    ["NORTH_EAST"] = {20, 0,  100, 80},
    ["WEST"] =       {0,  20, 100, 80},
    ["CENTER"] =     {10, 20, 100, 80},
    ["EAST"] =       {20, 20, 100, 80},
    ["SOUTH_WEST"] = {0,  40, 100, 80},
    ["SOUTH"] =      {10, 40, 100, 80},
    ["SOUTH_EAST"] = {20, 40, 100, 80},
    ["STATIC"] =     {10, 30, 100, 80}
}
for gravity, expectation in pairs(test_data) do
    gears.table.merge(steps, {
        function()
            set_rules { }
            -- Wait for the previous cleanup to be done
            if #client.get() == 0 then
                return true
            end
        end,
        function(count)
            if count == 1 then
                print("testing gravity " .. gravity)
                test_client(nil,nil,nil,nil,nil,{gravity=lgi.Gdk.Gravity[gravity]})
            else
                local c = client.get()[1]
                if c then
                    assert(c.size_hints.win_gravity == gravity:lower())
                    c.border_width = 10
                    c:titlebar_top(20)
                    c:geometry({
                            x = 0,
                            y = 0,
                            width = 100,
                            height = 100
                    })
                    windowid = c.window
                    return true
                end
            end
        end,
        -- For some reason unmanage needs to happen in a separate step to pass the tests..
        function()
            local c = client.get()[1]
            c:unmanage()
            awesome.sync()
            return true
        end,
        function()
            local display = lgi.Gdk.Display.open(os.getenv("DISPLAY"))
            local window = lgi.GdkX11.X11Window.foreign_new_for_display(display, windowid)
            local x, y, width, height = window:get_geometry()
            print(gravity, x, y, width, height)
            assert(x == expectation[1])
            assert(y == expectation[2])
            assert(width == expectation[3])
            assert(height == expectation[4])
            window:destroy()
            return true
        end,
        function()
            local display = lgi.Gdk.Display.open(os.getenv("DISPLAY"))
            local window = lgi.GdkX11.X11Window.foreign_new_for_display(display, windowid)
            if window then return end
            return true
        end,
        -- Additionally, checks our expectations are correct by adding decoration back.
        function(count)
            if count == 1 then
                test_client(nil,nil,nil,nil,nil,{gravity=lgi.Gdk.Gravity[gravity]})
            else
                local c = client.get()[1]
                if c then
                    assert(c.size_hints.win_gravity == gravity:lower())
                    c.border_width = 0
                    c:titlebar_top(0)
                    c:geometry({
                            x      = expectation[1],
                            y      = expectation[2],
                            width  = expectation[3],
                            height = expectation[4]
                    })
                    return true
                end
            end
        end,
        function()
            local c = client.get()[1]
            c:titlebar_top(20)
            c.border_width = 10
            return true
        end,
        function()
            local c = client.get()[1]
            assert(c.border_width      == 10  )
            assert(c:geometry().x      == 0   )
            assert(c:geometry().y      == 0   )
            assert(c:geometry().height == 100 )
            assert(c:geometry().width  == 100 )
            c:kill()
            return true
        end,
    })
end

runner.run_steps(steps)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80