awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #2790 from Elv13/screen_init 

Allow the screens to be fully managed by Lua
This commit is contained in:
Emmanuel Lepage Vallée 2019-09-30 01:28:30 -04:00 committed by GitHub
parent f63bc97c76 7ab5019c52
commit a02ea4450b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 1503 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

470
lib/awful/screen.lua
View File

@ -13,6 +13,7 @@ local capi =
screen = screen,
client = client,
awesome = awesome,
root = root,
}
local gdebug = require("gears.debug")
local gmath = require("gears.math")
@ -260,6 +261,58 @@ function screen.object.set_padding(self, padding)
end
end
--- A list of outputs for this screen with their size in mm.
--
-- Please note that the table content may vary. In some case, it might also be
-- empty.
--
-- An easy way to check if a screen is the laptop screen is usually:
--
-- if s.outputs["LVDS-1"] then
-- -- do something
-- end
--
-- **Signal:**
--
-- * *property::outputs*
--
-- **Immutable:** true
-- @property outputs
-- @param table
-- @tfield table table.name A table with the screen name as key (like `eDP1` on a laptop)
-- @tfield integer table.mm_width The screen physical width.
-- @tfield integer table.mm_height The screen physical height.
-- @tfield integer table.name The output name.
-- @tfield integer table.viewport_id The identifier of the viewport this output
-- corresponds to.
function screen.object.get_outputs(s)
local ret = {}
local outputs = s._custom_outputs
or (s.data.viewport and s.data.viewport.outputs or s._outputs)
-- The reason this exists is because output with name as keys is very
-- convenient for quick name lookup by the users, but inconvenient in
-- the lower layers since knowing the output count (using #) is better.
for k, v in ipairs(outputs) do
ret[v.name or k] = v
end
return ret
end
function screen.object.set_outputs(self, outputs)
self._custom_outputs = outputs
self:emit_signal("property::outputs", screen.object.get_outputs(self))
end
capi.screen.connect_signal("property::_outputs", function(s)
if not s._custom_outputs then
s:emit_signal("property::outputs", screen.object.get_outputs(s))
end
end)
--- Get the preferred screen in the context of a client.
--
-- This is exactly the same as `awful.screen.focused` except that it avoids
@ -486,7 +539,7 @@ end
function screen.object.get_tags(s, unordered)
local tags = {}
for _, t in ipairs(root.tags()) do
for _, t in ipairs(capi.root.tags()) do
if get_screen(t.screen) == s then
table.insert(tags, t)
end
@ -531,6 +584,106 @@ function screen.object.get_selected_tag(s)
return screen.object.get_selected_tags(s)[1]
end
local function normalize(ratios, size)
local sum = 0
for _, r in ipairs(ratios) do
sum = sum + r
end
-- Avoid to mutate the input.
local ret = {}
local sum2 = 0
for k, r in ipairs(ratios) do
ret[k] = (r*100)/sum
ret[k] = math.floor(size*ret[k]*0.01)
sum2 = sum2 + ret[k]
end
-- Ratios are random float number. Pixels cannot be divided. This adds the
-- remaining pixels to the end. A better approach would be to redistribute
-- them based on the ratios. However, nobody will notice.
ret[#ret] = ret[#ret] + (size - sum2)
return ret
end
--- Split the screen into multiple screens.
--
-- This is useful to turn ultrawide monitors into something more useful without
-- fancy client layouts:
--
-- @DOC_awful_screen_split1_EXAMPLE@
--
-- It can also be used to turn a vertical "side" screen into 2 smaller screens:
--
-- @DOC_awful_screen_split2_EXAMPLE@
--
-- @tparam[opt] table ratios The different ratios to split into. If none is
-- provided, it is split in half.
-- @tparam[opt] string mode Either "vertical" or "horizontal". If none is
-- specified, it will split along the longest axis.
-- @method split
function screen.object.split(s, ratios, mode, _geo)
s = get_screen(s)
_geo = _geo or s.geometry
ratios = ratios or {50,50}
-- In practice, this is almost always what the user wants.
mode = mode or (
_geo.height > _geo.width and "vertical" or "horizontal"
)
assert(mode == "horizontal" or mode == "vertical")
assert((not s) or s.valid)
assert(#ratios >= 2)
local sizes, ret = normalize(
ratios, mode == "horizontal" and _geo.width or _geo.height
), {}
assert(#sizes >=2)
if s then
if mode == "horizontal" then
s:fake_resize(_geo.x, _geo.y, sizes[1], _geo.height)
else
s:fake_resize(_geo.x, _geo.y, _geo.width, sizes[1])
end
table.insert(ret, s)
end
local pos = _geo[mode == "horizontal" and "x" or "y"]
+ (s and sizes[1] or 0)
for k=2, #sizes do
local ns
if mode == "horizontal" then
ns = capi.screen.fake_add(pos, _geo.y, sizes[k], _geo.height)
else
ns = capi.screen.fake_add(_geo.x, pos, _geo.width, sizes[k])
end
table.insert(ret, ns)
if s then
ns.data.viewport = s.data.viewport
if not ns.data.viewport then
ns.outputs = s.outputs
end
end
pos = pos + sizes[k]
end
return ret
end
--- Enable the automatic calculation of the screen DPI (experimental).
--
-- This will cause many elements such as the font and some widgets to be scaled
@ -560,75 +713,52 @@ function screen.set_auto_dpi_enabled(enabled)
data.autodpi = enabled
end
--- The number of pixels per inch of the screen.
--
-- The default DPI comes from the X11 server. In most case, it will be 96. If
-- `autodpi` is set to `true` on the screen, it will use the least dense dpi
-- from the screen outputs. Most of the time, screens only have a single output,
-- however it will have two (or more) when "clone mode" is used (eg, when a
-- screen is duplicated on a projector).
--
-- @property dpi
-- @param number the DPI value.
local xft_dpi, fallback_dpi
--- The lowest density DPI from all of the (physical) outputs.
-- @property minimum_dpi
-- @param number the DPI value.
local function get_fallback()
local mm_per_inch = 25.4
--- The highest density DPI from all of the (physical) outputs.
-- @property maximum_dpi
-- @param number the DPI value.
-- Following Keith Packard's whitepaper on Xft,
-- https://keithp.com/~keithp/talks/xtc2001/paper/xft.html#sec-editing
-- the proper fallback for Xft.dpi is the vertical DPI reported by
-- the X server. This will generally be 96 on Xorg, unless the user
-- has configured it differently
if root and not fallback_dpi then
local _, h = root.size()
local _, hmm = root.size_mm()
fallback_dpi = hmm ~= 0 and h * mm_per_inch / hmm
end
--- The preferred DPI from all of the (physical) outputs.
--
-- This is computed by normalizing all output to fill the area, then picking
-- the lowest of the resulting virtual DPIs.
--
-- @property preferred_dpi
-- @param number the DPI value.
return fallback_dpi or 96
end
--- The maximum diagonal size in millimeters.
--
-- @property mm_maximum_size
-- @param number
function screen.object.get_dpi(s)
local mm_per_inch = 25.4
--- The minimum diagonal size in millimeters.
--
-- @property mm_minimum_size
-- @param number
if s.data.dpi or s.data.dpi_cache then
return s.data.dpi or s.data.dpi_cache
end
--- The maximum diagonal size in inches.
--
-- @property inch_maximum_size
-- @param number
-- Xft.dpi is explicit user configuration, so honor it
if not xft_dpi and awesome and awesome.xrdb_get_value then
xft_dpi = tonumber(awesome.xrdb_get_value("", "Xft.dpi")) or false
end
if xft_dpi then
s.data.dpi_cache = xft_dpi
return s.data.dpi_cache
end
if not data.autodpi then
s.data.dpi_cache = get_fallback()
return s.data.dpi_cache
end
-- Try to compute DPI based on outputs (use the minimum)
local dpi = nil
local geo = s.geometry
for _, o in pairs(s.outputs) do
-- Ignore outputs with width/height 0
if o.mm_width ~= 0 and o.mm_height ~= 0 then
local dpix = geo.width * mm_per_inch / o.mm_width
local dpiy = geo.height * mm_per_inch / o.mm_height
dpi = math.min(dpix, dpiy, dpi or dpix)
end
end
if dpi then
s.data.dpi_cache = dpi
return dpi
end
s.data.dpi_cache = get_fallback()
return s.data.dpi_cache
end
function screen.object.set_dpi(s, dpi)
s.data.dpi = dpi
end
--- The minimum diagonal size in inches.
--
-- @property inch_minimum_size
-- @param number
--- Emitted when a new screen is added.
--
@ -652,10 +782,190 @@ end
-- @signal request::wallpaper
-- @tparam screen s The screen object.
--- When a new (physical) screen area has been added.
--
-- Important: This only exists when Awesome is started with `--screen off`.
-- Please also note that this doesn't mean it will appear when a screen is
-- physically plugged. Depending on the configuration a tool like `arandr` or
-- the `xrandr` command is needed.
--
-- The default handler will create a screen that fills the area.
--
-- To disconnect the default handler, use:
--
-- screen.disconnect_signal(
-- "request::create", awful.screen.create_screen_handler
-- )
--
-- @signal request::create
-- @tparam table viewport
-- @tparam table viewport.geometry A table with `x`, `y`, `width` and `height`
-- keys.
-- @tparam table viewport.outputs A table with the monitor name and possibly the
-- `mm_width` and `mm_height` values if they are available.
-- @tparam number viewport.id An identifier for this viewport (by pixel
-- resolution). It
-- will not change when outputs are modified, but will change when the
-- resolution changes. Note that if it fully disappear, the next time an
-- viewport with the same resolution appears, it will have a different `id`.
-- @tparam number viewport.minimum_dpi The least dense DPI.
-- @tparam number viewport.maximum_dpi The most dense DPI.
-- @tparam number viewport.preferred_dpi The relative least dense DPI.
-- @tparam table args
-- @tparam string args.context Why was this signal sent.
-- @see outputs
-- @see awful.screen.create_screen_handler
--- When a physical monitor viewport has been removed.
--
-- Important: This only exists when Awesome is started with `--screen off`.
--
-- If you replace the default handler, it is up to you to find the screen(s)
-- associated with this viewport.
--
-- To disconnect the default handler, use:
--
-- screen.disconnect_signal(
-- "request::remove", awful.screen.remove_screen_handler
-- )
--
-- @signal request::remove
-- @tparam table viewport
-- @tparam table viewport.geometry A table with `x`, `y`, `width` and `height`
-- keys.
-- @tparam table viewport.outputs A table with the monitor name and possibly the
-- `mm_width` and `mm_height` values if they are available.
-- @tparam number viewport.id An identifier for this viewport (by pixel
-- resolution). It will not change when outputs are modified, but will change
-- when the resolution changes. Note that if it fully disappear, the next time
-- an viewport with the same resolution appears, it will have a different `id`.
-- @tparam number viewport.minimum_dpi The least dense DPI.
-- @tparam number viewport.maximum_dpi The most dense DPI.
-- @tparam number viewport.preferred_dpi The relative least dense DPI.
-- @tparam table args
-- @tparam string args.context Why was this signal sent.
-- @see awful.screen.remove_screen_handler
--- When a physical viewport resolution has changed or it has been replaced.
--
-- Important: This only exists when Awesome is started with `--screen off`.
--
-- Note that given the viewports are not the same, the `id` wont be the same.
-- Also note that if multiple new viewports fit within a single "old" viewport,
-- the resized screen will be the one with the largest total overlapping
-- viewport (`intersection.width*intersection.height`), regardless of the
-- outputs names.
--
-- To disconnect the default handler, use:
--
-- screen.disconnect_signal(
-- "request::resize", awful.screen.resize_screen_handler
-- )
--
-- @signal request::resize
-- @tparam table old_viewport
-- @tparam table old_viewport.geometry A table with `x`, `y`, `width` and
-- `height` keys.
-- @tparam table old_viewport.outputs A table with the monitor name and
-- possibly the `mm_width` and `mm_height` values if they are available.
-- @tparam number old_viewport.id An identifier for this viewport (by pixel
-- resolution). It will not change when outputs are modified, but will change
-- when the resolution changes. Note that if it fully disappear, the next
-- time an viewport with the same resolution appears, it will have a different
-- `id`.
-- @tparam number old_viewport.minimum_dpi The least dense DPI.
-- @tparam number old_viewport.maximum_dpi The most dense DPI.
-- @tparam number old_viewport.preferred_dpi The relative least dense DPI.
-- @tparam table new_viewport
-- @tparam table new_viewport.geometry A table with `x`, `y`, `width` and
-- `height` keys.
-- @tparam table new_viewport.outputs A table with the monitor name and
-- possibly the
-- `mm_width` and `mm_height` values if they are available.
-- @tparam number new_viewport.id An identifier for this viewport (by pixel
-- resolution). It will not change when outputs are modified, but will change
-- when the resolution changes. Note that if it fully disappear, the next time
-- an viewport with the same resolution appears, it will have a different `id`.
-- @tparam number new_viewport.minimum_dpi The least dense DPI.
-- @tparam number new_viewport.maximum_dpi The most dense DPI.
-- @tparam number new_viewport.preferred_dpi The relative least dense DPI.
-- @tparam table args
-- @tparam string args.context Why was this signal sent.
-- @see awful.screen.resize_screen_handler
--- Default handler for `request::create`.
--
-- Important: This only exists when Awesome is started with `--screen off`.
--
-- A simplified implementation looks like:
--
-- function(viewport --[[, args]])
-- local geo = viewport.geometry
-- local s = screen.fake_add(geo.x, geo.y, geo.width, geo.height)
-- s:emit_signal("request::desktop_decoration")
-- s:emit_signal("request::wallpaper")
-- end
--
-- If you implement this by hand, you must also implement handler for the
-- `request::remove` and `request::resize`.
--
-- @signalhandler awful.screen.create_screen_handler
-- @see request::create
--- Default handler for `request::remove`.
--
-- Important: This only exists when Awesome is started with `--screen off`.
--
-- A simplified version of the logic is:
--
-- function (viewport --[[, args]])
-- local geo = viewport.geometry
-- for s in screen do
-- if gears.geometry.rectangle.are_equal(geo, s.geometry) then
-- s:fake_remove()
-- return
-- end
-- end
-- end
--
-- @signalhandler awful.screen.remove_screen_handler
-- @see request::remove
--- Default handler for `request::resize`.
--
-- Important: This only exists when Awesome is started with `--screen off`.
--
-- A simplified version of the logic is:
--
-- function (old_viewport, new_viewport --[[, args]])
-- local old_geo, new_geo = old_viewport.geometry, new_viewport.geometry
-- for s in screen do
-- local sgeo = new_viewport.geometry
-- if gears.geometry.rectangle.are_equal(old_geo, s.geometry) then
-- s:fake_resize(
-- sgeo.x, sgeo.y, sgeo.width, sgeo.height
-- )
-- end
-- end
-- end
--
-- @signalhandler awful.screen.resize_screen_handler
-- @see request::resize
-- Add the DPI properties.
require("awful.screen.dpi")(screen, data)
-- Set the wallpaper(s) and create the bar(s) for new screens
capi.screen.connect_signal("added", function(s)
s:emit_signal("request::desktop_decoration")
s:emit_signal("request::wallpaper")
capi.screen.connect_signal("_added", function(s)
-- If it was emited from here when screens are created with fake_add,
-- the Lua code would not have an opportunity to polutate the screen
-- metadata. Thus, the DPI may be wrong when setting the wallpaper.
if s._managed ~= "Lua" then
s:emit_signal("added")
s:emit_signal("request::desktop_decoration")
s:emit_signal("request::wallpaper")
end
end)
-- Resize the wallpaper(s)
@ -667,39 +977,19 @@ end
-- Create the bar for existing screens when an handler is added
capi.screen.connect_signal("request::desktop_decoration::connected", function(new_handler)
for s in capi.screen do
new_handler(s)
if capi.screen.automatic_factory then
for s in capi.screen do
new_handler(s)
end
end
end)
-- Set the wallpaper when an handler is added.
capi.screen.connect_signal("request::wallpaper::connected", function(new_handler)
for s in capi.screen do
new_handler(s)
end
end)
-- Create some screens when none exist. This can happen when AwesomeWM is
-- started with `--screen off` and no handler is used.
capi.screen.connect_signal("scanned", function()
if capi.screen.count() == 0 then
-- Private API to scan for screens now.
if #capi.screen._viewports() == 0 then
capi.screen._scan_quiet()
if capi.screen.automatic_factory then
for s in capi.screen do
new_handler(s)
end
local viewports = capi.screen._viewports()
if #viewports > 0 then
for _, area in ipairs(viewports) do
local geo = area.geometry
capi.screen.fake_add(geo.x, geo.y, geo.width, geo.height)
end
else
capi.screen.fake_add(0, 0, 640, 480)
end
assert(capi.screen.count() > 0, "Creating screens failed")
end
end)

414
lib/awful/screen/dpi.lua
View File

@ -0,0 +1,414 @@
---------------------------------------------------------------------------
-- DPI detection code. --
---------------------------------------------------------------------------
local capi = {screen = screen}
local gtable = require("gears.table")
local grect = require("gears.geometry").rectangle
local gdebug = require("gears.debug")
local module = {}
local ascreen, data = nil, nil
-- Metric to Imperial conversion constant.
local mm_per_inch = 25.4
local xft_dpi, fallback_dpi
local function get_fallback_dpi()
-- Following Keith Packard's whitepaper on Xft,
-- https://keithp.com/~keithp/talks/xtc2001/paper/xft.html#sec-editing
-- the proper fallback for Xft.dpi is the vertical DPI reported by
-- the X server. This will generally be 96 on Xorg, unless the user
-- has configured it differently
if not fallback_dpi then
local _, h = root.size()
local _, hmm = root.size_mm()
fallback_dpi = hmm ~= 0 and h * mm_per_inch / hmm
end
return fallback_dpi or 96
end
local function dpi_for_output(viewport, output)
local dpi = nil
local geo = viewport.geometry
-- Ignore outputs with width/height 0
if output.mm_width ~= 0 and output.mm_height ~= 0 then
local dpix = geo.width * mm_per_inch / output.mm_width
local dpiy = geo.height * mm_per_inch / output.mm_height
dpi = math.min(dpix, dpiy, dpi or dpix)
elseif ascreen._get_xft_dpi() then
dpi = ascreen._get_xft_dpi()
end
return dpi or get_fallback_dpi()
end
local function dpis_for_outputs(viewport)
local max_dpi, min_dpi, max_size, min_size = 0, math.huge, 0, math.huge
for _, o in pairs(viewport.outputs) do
local dpi = dpi_for_output(viewport, o)
o.dpi = dpi
max_dpi = math.max(max_dpi, dpi)
min_dpi = math.min(min_dpi, dpi)
-- Compute the diagonal size.
if o.mm_width and o.mm_height then
o.mm_size = math.sqrt(o.mm_width^2 + o.mm_height^2)
o.inch_size = o.mm_size/mm_per_inch
max_size = math.max(max_size, o.mm_size)
min_size = math.min(min_size, o.mm_size)
end
end
-- When there is no output.
if min_dpi == math.huge then
min_dpi = get_fallback_dpi()
max_dpi = min_dpi
end
--TODO Some output may have a lower resolution than the viewport, so their
-- DPI is currently wrong. Once fixed, the preferred DPI can become
-- different from the minimum one.
local pref_dpi = min_dpi
viewport.minimum_dpi = min_dpi
viewport.maximum_dpi = max_dpi
viewport.preferred_dpi = pref_dpi
-- Guess the diagonal size using the DPI.
if min_size == math.huge then
for _, o in pairs(viewport.outputs) do
local geo = o.geometry
if geo then
o.mm_size = math.sqrt(geo.width^2 + geo.height^2)/o.dpi
max_size = math.max(max_size, o.mm_size)
min_size = math.min(min_size, o.mm_size)
end
end
-- In case there is no output information.
if min_size == math.huge then
local geo = viewport.geometry
local size = math.sqrt(geo.width^2 + geo.height^2)/max_dpi
max_size, min_size = size, size
end
end
viewport.mm_minimum_size = min_size
viewport.mm_maximum_size = max_size
viewport.inch_minimum_size = min_size/mm_per_inch
viewport.inch_maximum_size = max_size/mm_per_inch
return max_dpi, min_dpi, pref_dpi
end
local function update_outputs(old_viewport, new_viewport)
gtable.diff_merge(
old_viewport.outputs,
new_viewport.outputs,
function(o)
return o.name or (
(o.mm_height or -7)*9999 * (o.mm_width or 5)*123
)
end,
gtable.crush
)
end
-- Fetch the current viewports and compare them to the caches ones.
--
-- The idea is to keep whatever metadata kept within the existing ones and know
-- what is added and removed.
local function update_viewports(force)
if #ascreen._viewports > 0 and not force then return ascreen._viewports end
local new = ascreen._get_viewports()
local _, add, rem = gtable.diff_merge(
ascreen._viewports,
new,
function(a) return a.id end,
update_outputs
)
for _, viewport in ipairs(ascreen._viewports) do
dpis_for_outputs(viewport)
end
assert(#ascreen._viewports > 0 or #new == 0)
return ascreen._viewports, add, rem
end
-- Compute more useful viewport metadata frrom_sparse(add)om the list of output.
-- @treturn table An viewport with more information.
local function update_screen_viewport(s)
local viewport = s.data.viewport
if #ascreen._viewports == 0 then
ascreen._viewports = update_viewports(false)
end
-- The maximum is equal to the screen viewport, so no need for many loops.
if not viewport then
local big_a, i_size = nil, 0
for _, a in ipairs(ascreen._viewports) do
local int = grect.get_intersection(a.geometry, s.geometry)
if int.width*int.height > i_size then
big_a, i_size = a, int.width*int.height
end
if i_size == s.geometry.width*s.geometry.height then break end
end
if big_a then
viewport, s.data.viewport = big_a, big_a
end
end
if not viewport then
gdebug.print_warning("Screen "..tostring(s)..
" doesn't overlap a known physical monitor")
end
end
function module.create_screen_handler(viewport)
local geo = viewport.geometry
local s = capi.screen.fake_add(
geo.x,
geo.y,
geo.width,
geo.height,
{_managed = true}
)
update_screen_viewport(s)
s:emit_signal("request::desktop_decoration")
s:emit_signal("request::wallpaper")
-- Will call all `connect_for_each_screen`.
s:emit_signal("added")
end
function module.remove_screen_handler(viewport)
for s in capi.screen do
if s.data.viewport and s.data.viewport.id == viewport.id then
s:fake_remove()
return
end
end
end
function module.resize_screen_handler(old_viewport, new_viewport)
for s in capi.screen do
if s.data.viewport and s.data.viewport.id == old_viewport.id then
local ngeo = new_viewport.geometry
s:fake_resize(
ngeo.x, ngeo.y, ngeo.width, ngeo.height
)
s.data.viewport = new_viewport
return
end
end
end
-- Xft.dpi is explicit user configuration, so honor it.
-- (It isn't a local function to allow the tests to replace it)
function module._get_xft_dpi()
if not xft_dpi then
xft_dpi = tonumber(awesome.xrdb_get_value("", "Xft.dpi")) or false
end
return xft_dpi
end
-- Some of them may be present twice or a giant viewport may exist which
-- encompasses everything.
local function deduplicate_viewports(vps)
local min_x, min_y, max_x, max_y = math.huge, math.huge, 0, 0
-- Sort the viewports by `x`.
for _, vp in ipairs(vps) do
local geo = vp.geometry
min_x = math.min(min_x, geo.x)
max_x = math.max(max_x, geo.x+geo.width)
min_y = math.min(min_y, geo.y)
max_y = math.max(max_y, geo.y+geo.height)
end
-- Remove the "encompass everything" viewport (if any).
if #vps > 1 then
for k, vp in ipairs(vps) do
local geo = vp.geometry
if geo.x == min_x and geo.y == min_y
and geo.x+geo.width == max_x and geo.y+geo.height == max_y then
table.remove(vps, k)
break
end
end
end
--TODO when the rules are added, mark the viewports that are embedded into
-- each other so the rules can decide to use the smaller or larger viewport
-- when creating the screen. This happens a lot then connecting to
-- projectors when doing presentations.
return vps
end
-- Provide a way for the tests to replace `capi.screen._viewports`.
function module._get_viewports()
assert(type(capi.screen._viewports()) == "table")
return deduplicate_viewports(capi.screen._viewports())
end
local function get_dpi(s)
if s.data.dpi or s.data.dpi_cache then
return s.data.dpi or s.data.dpi_cache
end
if not s.data.viewport then
update_screen_viewport(s)
end
-- Pick a DPI (from best to worst).
local dpi = ascreen._get_xft_dpi()
or (s.data.viewport and s.data.viewport.preferred_dpi or nil)
or get_fallback_dpi()
-- Pick the screen DPI depending on the `autodpi` settings.
-- Historically, AwesomeWM size unit was the pixel. This assumption is
-- present in a lot, if not most, user config and is why this cannot be
-- enable by default for existing users.
s.data.dpi_cache = data.autodpi and dpi
or ascreen._get_xft_dpi()
or get_fallback_dpi()
return s.data.dpi_cache
end
local function set_dpi(s, dpi)
s.data.dpi = dpi
end
screen.connect_signal("request::create", module.create_screen_handler)
screen.connect_signal("request::remove", module.remove_screen_handler)
screen.connect_signal("request::resize", module.resize_screen_handler)
-- Create some screens when none exist. This can happen when AwesomeWM is
-- started with `--screen manual` and no handler is used.
capi.screen.connect_signal("scanned", function()
if capi.screen.count() == 0 then
-- Private API to scan for screens now.
if #ascreen._get_viewports() == 0 then
capi.screen._scan_quiet()
end
local cur_viewports = ascreen._get_viewports()
if #cur_viewports > 0 then
for _, viewport in ipairs(cur_viewports) do
module.create_screen_handler(viewport)
end
else
capi.screen.fake_add(0, 0, 640, 480)
end
assert(capi.screen.count() > 0, "Creating screens failed")
end
end)
-- This is the (undocumented) signal sent by capi.
capi.screen.connect_signal("property::_viewports", function(a)
if capi.screen.automatic_factory then return end
assert(#a > 0)
local _, added, removed = update_viewports(true)
local resized = {}
-- Try to detect viewports being replaced or resized.
for k2, viewport in ipairs(removed) do
local candidate, best_size, best_idx = {}, 0, nil
for k, viewport2 in ipairs(added) do
local int = grect.get_intersection(viewport.geometry, viewport2.geometry)
if (int.width*int.height) > best_size then
best_size, best_idx, candidate = (int.width*int.height), k, viewport2
end
end
if candidate and best_size > 0 then
table.insert(resized, {removed[k2], added[best_idx]})
removed[k2] = nil
table.remove(added , best_idx)
end
end
gtable.from_sparse(removed)
-- Drop the cache.
for s in capi.screen do
s.data.dpi_cache = nil
end
capi.screen.emit_signal("property::viewports", ascreen._get_viewports())
-- First, ask for screens for these new viewport.
for _, viewport in ipairs(added) do
capi.screen.emit_signal("request::create", viewport, {context="viewports_changed"})
end
-- Before removing anything, make sure to resize existing screen as it may
-- affect where clients will go when the screens are removed.
for _, p in ipairs(resized) do
capi.screen.emit_signal("request::resize", p[1], p[2], {context="viewports_changed"})
end
-- Remove the now out-of-view screens.
for _, viewport in ipairs(removed) do
capi.screen.emit_signal("request::remove", viewport, {context="viewports_changed"})
end
end)
-- Add the DPI related properties
return function(screen, d)
ascreen, data = screen, d
-- "Lua" copy of the CAPI viewports. It has more metadata.
ascreen._viewports = {}
gtable.crush(ascreen, module, true)
ascreen.object.set_dpi = set_dpi
ascreen.object.get_dpi = get_dpi
for _, prop in ipairs {"minimum_dpi" , "maximum_dpi" ,
"mm_maximum_width" , "mm_minimum_width" ,
"inch_maximum_width", "inch_minimum_width",
"preferred_dpi" } do
screen.object["get_"..prop] = function(s)
if not s.data.viewport then
update_screen_viewport(s)
end
local a = s.data.viewport or {}
return a[prop] or nil
end
end
end

9
lib/naughty/init.lua
View File

@ -6,7 +6,7 @@
local naughty = require("naughty.core")
local gdebug = require("gears.debug")
local capi = {awesome = awesome}
local capi = {awesome = awesome, screen = screen}
if dbus then
naughty.dbus = require("naughty.dbus")
end
@ -31,7 +31,7 @@ naughty.notification = require("naughty.notification")
-- screen.connect_signal("scanned", function() foobar() end)
--
local function screen_fallback()
if screen.count() == 0 then
if capi.screen.count() == 0 then
gdebug.print_warning("An error occurred before a scrren was added")
-- Private API to scan for screens now.
@ -44,10 +44,11 @@ local function screen_fallback()
if #viewports > 0 then
for _, viewport in ipairs(viewports) do
local geo = viewport.geometry
screen.fake_add(geo.x, geo.y, geo.width, geo.height)
local s = capi.screen.fake_add(geo.x, geo.y, geo.width, geo.height)
s.outputs = viewport.outputs
end
else
screen.fake_add(0, 0, 640, 480)
capi.screen.fake_add(0, 0, 640, 480)
end
end
end

2
manpages/awesome.1.fr.txt
View File

@ -48,7 +48,7 @@ OPTIONS
*-a*, *--no-argb*::
N'utilise pas le codage ARGB.
*-m*, *--screen*:: 'off' ou 'on'::
Utiliser "manual" pour exécuter rc.lua avant de créer les écrans.
Utiliser "off" pour exécuter le fichier rc.lua avant de créer les écrans.
*-r*, *--replace*::
Remplace le gestionnaire de fenêtres existant.

2
manpages/awesome.1.txt
View File

@ -47,7 +47,7 @@ OPTIONS
*-a*, *--no-argb*::
Don't use ARGB visuals.
*-m*, *--screen*:: 'off' or 'on'::
Use "off" to execute rc.lua before creating the screens.
Use "off" to execute rc.lua before creating screens.
*-r*, *--replace*::
Replace an existing window manager.

143
objects/screen.c
View File

@ -130,8 +130,16 @@
* Each viewport in the list corresponds to a **physical** screen rectangle, which
* is **not** the `viewports` property of the `screen` objects.
*
* Each entry in the `viewports` entry has the following keys:
*
* * `geometry` *(table)*: A table with an `x`, `y`, `width` and `height` keys.
* * `outputs` *(table)*: All outputs sharing this viewport.
* * `maximum_dpi` *(number)*: The DPI of the most dense output.
* * `minimum_dpi` *(number)*: The DPI of the least dense output.
* * `preferred_dpi` *(number)*: The optimal DPI.
*
* @signal property::viewports
* @tparam table viewports
* @tparam table viewports A table containing all physical viewports.
* @see automatic_factory
*/
@ -202,24 +210,6 @@
* @see screen
*/
/**
* If RANDR information is available, a list of outputs
* for this screen and their size in mm.
*
* Please note that the table content may vary.
*
* **Signal:**
*
* * *property::outputs*
*
* **Immutable:** true
* @property outputs
* @param table
* @tfield table table.name A table with the screen name as key (like `eDP1` on a laptop)
* @tfield integer table.name.mm_width The screen physical width
* @tfield integer table.name.mm_height The screen physical height
*/
/**
* The screen workarea.
*
@ -378,6 +368,7 @@ typedef struct viewport_t
int y;
int width;
int height;
int id;
struct viewport_t *next;
screen_t *screen;
screen_output_array_t outputs;
@ -385,6 +376,7 @@ typedef struct viewport_t
static viewport_t *first_screen_viewport = NULL;
static viewport_t *last_screen_viewport = NULL;
static int screen_area_gid = 1;
static void
luaA_viewport_get_outputs(lua_State *L, viewport_t *a)
@ -411,6 +403,10 @@ luaA_viewport_get_outputs(lua_State *L, viewport_t *a)
lua_pushstring(L, output->name);
lua_settable(L, -3);
lua_pushstring(L, "viewport_id");
lua_pushinteger(L, a->id);
lua_settable(L, -3);
/* Add to the outputs */
lua_rawseti(L, -2, count++);
}
@ -458,6 +454,11 @@ luaA_viewports(lua_State *L)
luaA_viewport_get_outputs(L, a);
lua_settable(L, -3);
/* Add an identifier to better detect when screens are removed */
lua_pushstring(L, "id");
lua_pushinteger(L, a->id);
lua_settable(L, -3);
lua_rawseti(L, -2, count++);
} while ((a = a->next));
@ -475,7 +476,7 @@ viewports_notify(lua_State *L)
luaA_viewports(L);
luaA_class_emit_signal(L, &screen_class, "property::viewports", 1);
luaA_class_emit_signal(L, &screen_class, "property::_viewports", 1);
}
static viewport_t *
@ -499,6 +500,7 @@ viewport_add(lua_State *L, int x, int y, int w, int h)
node->y = y;
node->width = w;
node->height = h;
node->id = screen_area_gid++;
node->next = NULL;
node->screen = NULL;
node->marked = true;
@ -588,9 +590,19 @@ screen_add(lua_State *L, screen_array_t *screens)
luaA_object_ref(L, -1);
screen_array_append(screens, new_screen);
new_screen->xid = XCB_NONE;
new_screen->lifecycle = SCREEN_LIFECYCLE_USER;
return new_screen;
}
static void
screen_wipe(screen_t *c)
{
if (c->name) {
free(c->name);
c->name = NULL;
}
}
/* Monitors were introduced in RandR 1.5 */
#ifdef XCB_RANDR_GET_MONITORS
@ -665,6 +677,7 @@ screen_scan_randr_monitors(lua_State *L, screen_array_t *screens)
continue;
new_screen = screen_add(L, screens);
new_screen->lifecycle |= SCREEN_LIFECYCLE_C;
viewport->screen = new_screen;
new_screen->viewport = viewport;
new_screen->geometry.x = monitor_iter.data->x;
@ -765,6 +778,7 @@ screen_scan_randr_crtcs(lua_State *L, screen_array_t *screens)
/* Prepare the new screen */
screen_t *new_screen = screen_add(L, screens);
new_screen->lifecycle |= SCREEN_LIFECYCLE_C;
viewport->screen = new_screen;
new_screen->viewport = viewport;
new_screen->geometry.x = crtc_info_r->x;
@ -904,6 +918,7 @@ screen_scan_xinerama(lua_State *L, screen_array_t *screens)
screen_t *s = screen_add(L, screens);
viewport->screen = s;
s->viewport = viewport;
s->lifecycle |= SCREEN_LIFECYCLE_C;
s->geometry.x = xsi[screen].x_org;
s->geometry.y = xsi[screen].y_org;
s->geometry.width = xsi[screen].width;
@ -929,6 +944,7 @@ static void screen_scan_x11(lua_State *L, screen_array_t *screens)
screen_t *s = screen_add(L, screens);
viewport->screen = s;
s->lifecycle |= SCREEN_LIFECYCLE_C;
s->viewport = viewport;
s->geometry.x = 0;
s->geometry.y = 0;
@ -942,7 +958,7 @@ screen_added(lua_State *L, screen_t *screen)
screen->workarea = screen->geometry;
screen->valid = true;
luaA_object_push(L, screen);
luaA_object_emit_signal(L, -1, "added", 0);
luaA_object_emit_signal(L, -1, "_added", 0);
lua_pop(L, 1);
}
@ -1076,7 +1092,7 @@ screen_modified(screen_t *existing_screen, screen_t *other_screen)
if(outputs_changed) {
luaA_object_push(L, existing_screen);
luaA_object_emit_signal(L, -1, "property::outputs", 0);
luaA_object_emit_signal(L, -1, "property::_outputs", 0);
lua_pop(L, 1);
}
}
@ -1132,9 +1148,11 @@ screen_refresh(gpointer unused)
for(int i = 0; i < globalconf.screens.len; i++) {
screen_t *old_screen = globalconf.screens.tab[i];
bool found = old_screen->xid == FAKE_SCREEN_XID;
foreach(new_screen, new_screens)
found |= (*new_screen)->xid == old_screen->xid;
if(!found) {
if(old_screen->lifecycle & SCREEN_LIFECYCLE_C && !found) {
screen_array_take(&globalconf.screens, i);
i--;
@ -1507,7 +1525,9 @@ luaA_screen_module_index(lua_State *L)
}
foreach(screen, globalconf.screens)
if ((*screen)->viewport)
if ((*screen)->name && A_STREQ(name, (*screen)->name))
return luaA_object_push(L, *screen);
else if ((*screen)->viewport)
foreach(output, (*screen)->viewport->outputs)
if(A_STREQ(output->name, name))
return luaA_object_push(L, *screen);
@ -1584,6 +1604,19 @@ luaA_screen_get_outputs(lua_State *L, screen_t *s)
return 1;
}
static int
luaA_screen_get_managed(lua_State *L, screen_t *s)
{
if (s->lifecycle & SCREEN_LIFECYCLE_LUA)
lua_pushstring(L, "Lua");
else if (s->lifecycle & SCREEN_LIFECYCLE_C)
lua_pushstring(L, "C");
else
lua_pushstring(L, "none");
return 1;
}
static int
luaA_screen_get_workarea(lua_State *L, screen_t *s)
{
@ -1591,6 +1624,33 @@ luaA_screen_get_workarea(lua_State *L, screen_t *s)
return 1;
}
static int
luaA_screen_set_name(lua_State *L, screen_t *s)
{
const char *buf = luaL_checkstring(L, -1);
if (s->name)
free(s->name);
s->name = a_strdup(buf);
return 0;
}
static int
luaA_screen_get_name(lua_State *L, screen_t *s)
{
lua_pushstring(L, s->name ? s->name : "screen");
/* Fallback to "screen1", "screen2", etc if no name is set */
if (!s->name) {
lua_pushinteger(L, screen_get_index(s));
lua_concat(L, 2);
}
return 1;
}
/** Get the number of screens.
*
* @return The screen count, at least 1.
@ -1629,9 +1689,22 @@ luaA_screen_fake_add(lua_State *L)
int y = luaL_checkinteger(L, 2);
int width = luaL_checkinteger(L, 3);
int height = luaL_checkinteger(L, 4);
/* If the screen is managed by internal Lua code */
bool managed = false;
/* Allow undocumented arguments for internal use only */
if(lua_istable(L, 5)) {
lua_getfield(L, 5, "_managed");
managed = lua_isboolean(L, 6) && luaA_checkboolean(L, 6);
lua_pop(L, 1);
}
screen_t *s;
s = screen_add(L, &globalconf.screens);
s->lifecycle |= managed ? SCREEN_LIFECYCLE_LUA : SCREEN_LIFECYCLE_USER;
s->geometry.x = x;
s->geometry.y = y;
s->geometry.width = width;
@ -1642,6 +1715,11 @@ luaA_screen_fake_add(lua_State *L)
luaA_class_emit_signal(L, &screen_class, "list", 0);
luaA_object_push(L, s);
foreach(c, globalconf.clients) {
screen_client_moveto(*c, screen_getbycoord(
(*c)->geometry.x, (*c)->geometry.y), false);
}
return 1;
}
@ -1700,6 +1778,11 @@ luaA_screen_fake_resize(lua_State *L)
luaA_pusharea(L, old_geometry);
luaA_object_emit_signal(L, 1, "property::geometry", 1);
/* Note: calling `screen_client_moveto` from here will create more issues
* than it would fix. Keep in mind that it means `c.screen` will be wrong
* until Lua it `fake_add` fixes it.
*/
return 0;
}
@ -1775,7 +1858,7 @@ screen_class_setup(lua_State *L)
luaA_class_setup(L, &screen_class, "screen", NULL,
(lua_class_allocator_t) screen_new,
(lua_class_collector_t) NULL,
(lua_class_collector_t) screen_wipe,
(lua_class_checker_t) screen_checker,
luaA_class_index_miss_property, luaA_class_newindex_miss_property,
screen_methods, screen_meta);
@ -1787,14 +1870,22 @@ screen_class_setup(lua_State *L)
NULL,
(lua_class_propfunc_t) luaA_screen_get_index,
NULL);
luaA_class_add_property(&screen_class, "outputs",
luaA_class_add_property(&screen_class, "_outputs",
NULL,
(lua_class_propfunc_t) luaA_screen_get_outputs,
NULL);
luaA_class_add_property(&screen_class, "_managed",
NULL,
(lua_class_propfunc_t) luaA_screen_get_managed,
NULL);
luaA_class_add_property(&screen_class, "workarea",
NULL,
(lua_class_propfunc_t) luaA_screen_get_workarea,
NULL);
luaA_class_add_property(&screen_class, "name",
(lua_class_propfunc_t) luaA_screen_set_name,
(lua_class_propfunc_t) luaA_screen_get_name,
(lua_class_propfunc_t) luaA_screen_set_name);
}
/* @DOC_cobject_COMMON@ */

14
objects/screen.h
View File

@ -30,16 +30,26 @@
typedef struct screen_output_t screen_output_t;
ARRAY_TYPE(screen_output_t, screen_output)
/** Different ways to manage screens */
typedef enum {
SCREEN_LIFECYCLE_USER = 0, /*!< Unmanaged (ei. from fake_add) */
SCREEN_LIFECYCLE_LUA = 0x1 << 0, /*!< Is managed internally by Lua */
SCREEN_LIFECYCLE_C = 0x1 << 1, /*!< Is managed internally by C */
} screen_lifecycle_t;
struct a_screen
{
LUA_OBJECT_HEADER
/** Is this screen still valid and may be used? */
bool valid;
/** Who manages the screen lifecycle */
screen_lifecycle_t lifecycle;
/** Screen geometry */
area_t geometry;
/** Screen workarea */
area_t workarea;
/** Opaque pointer to the psysical geometry */
/** The name of the screen */
char *name;
/** Opaque pointer to the viewport */
struct viewport_t *viewport;
/** Some XID identifying this screen */
uint32_t xid;

9
tests/examples/awful/screen/split1.lua Normal file
View File

@ -0,0 +1,9 @@
--DOC_GEN_IMAGE --DOC_HIDE --DOC_NO_USAGE
require("awful.screen") --DOC_HIDE
screen[1]._resize {x = 95, width = 256, height = 108} --DOC_HIDE
screen[1]:split({1/5, 3/5, 1/5})
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

9
tests/examples/awful/screen/split2.lua Normal file
View File

@ -0,0 +1,9 @@
--DOC_GEN_IMAGE --DOC_HIDE --DOC_NO_USAGE
require("awful.screen") --DOC_HIDE
screen[1]._resize {x = 175, width = 108, height = 198} --DOC_HIDE
screen[1]:split()
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80

2
tests/run.sh
View File

@ -255,7 +255,7 @@ for f in $tests; do
error="$(echo "$error" | grep -vE ".{19} W: awesome: (Can't read color .* from GTK)" || true)"
if [[ $fail_on_warning ]]; then
# Filter out ignored warnings.
error="$(echo "$error" | grep -vE ".{19} W: awesome: (a_glib_poll|Cannot reliably detect EOF|beautiful: can't get colorscheme from xrdb|Can't read color .* from GTK+3 theme|A notification|Notification)" || true)"
error="$(echo "$error" | grep -vE ".{19} W: awesome: (Removing last screen through fake_remove|a_glib_poll|Cannot reliably detect EOF|beautiful: can't get colorscheme from xrdb|Can't read color .* from GTK+3 theme|A notification|Notification)" || true)"
fi
if [[ -n "$error" ]]; then
color_red

6
tests/test-awful-screen.lua
View File

@ -68,6 +68,12 @@ local steps = {
-- Make sure the error code still works when all screens are gone.
function()
while screen.count() > 0 do
-- Before removing them, check if `name` works.
assert(screen[1].name == "screen1")
screen[1].name = "foo"
assert(screen[1].name == "foo")
assert(screen.foo == screen[1])
screen[1]:fake_remove()
end

548
tests/test-dpi.lua Normal file
View File

@ -0,0 +1,548 @@
-- This testsuite intends to tests the delayed screen creation mode and it's
-- automatic fallback when no screens are created.
local runner = require("_runner")
local ascreen = require("awful.screen")
local gtable = require("gears.table")
local grect = require("gears.geometry").rectangle
local xft_dpi = 42
local fake_viewports, max_id, allow_zero = screen._viewports(), 1, false
local called = 0
local saved_dpi1, saved_dpi2, saved_dpi3
-- Make sure what is tested matches some criteria.
-- Prevents silly errors when adding more test case.
local function validate_viewports(viewports)
for _, a in ipairs(viewports) do
assert(type(a.id) == "number")
assert(a.id > max_id)
assert(type(a.outputs ) == "table")
assert(type(a.geometry) == "table")
for _, prop in ipairs {"x", "y", "width", "height"} do
assert(type(a.geometry[prop]) == "number")
assert(a.geometry[prop] >= 0)
end
max_id = a.id
end
end
local function fake_replace(viewports)
fake_viewports = viewports
screen.emit_signal("property::_viewports", fake_viewports)
end
-- Rollback the clock and replay the initialization.
local function fake_replay(viewports)
if viewports then
validate_viewports(viewports)
end
viewports = viewports or fake_viewports
ascreen._viewports, fake_viewports = {}, viewports
while screen.count() > 0 do
screen[1]:fake_remove()
end
assert(screen.count() == 0)
screen.emit_signal("scanning")
screen.emit_signal("property::_viewports", fake_viewports)
screen.emit_signal("scanned")
assert(screen.count() == #viewports)
assert(type(ascreen._get_xft_dpi()) ~= "boolean")
-- Check of the viewports (+new metadata) is created.
for k, a in ipairs(viewports) do
local s = screen[k]
-- Check if the extra metadata are computed.
assert(s.data.viewport.maximum_dpi)
assert(s.data.viewport.minimum_dpi)
assert(s.data.viewport.preferred_dpi)
assert(s.dpi)
assert(s.maximum_dpi == s.data.viewport.maximum_dpi )
assert(s.minimum_dpi == s.data.viewport.minimum_dpi )
assert(s.preferred_dpi == s.data.viewport.preferred_dpi)
-- Make sure it enters either the main `if` or the fallback one.
assert(s.data.viewport.minimum_dpi ~= math.huge)
assert(s.data.viewport.preferred_dpi ~= math.huge)
-- Check the range.
assert(s.data.viewport.maximum_dpi >= s.data.viewport.minimum_dpi)
assert(s.data.viewport.preferred_dpi >= s.data.viewport.minimum_dpi)
assert(s.data.viewport.preferred_dpi <= s.data.viewport.maximum_dpi)
-- Check if the screen was created using the right viewport
-- (order *is* relevant).
assert(#s.data.viewport.outputs == #a.outputs)
assert(s.data.viewport and s.data.viewport.id == a.id)
end
-- The original shall not be modified, the CAPI for this is read-only.
for _, a in ipairs(fake_viewports) do
assert(not a.minimum_dpi )
assert(not a.maximum_dpi )
assert(not a.preferred_dpi)
assert(not a.dpi )
end
end
local function remove_output(viewport, name)
for k, output in ipairs(viewport.outputs) do
if output.name == name then
table.remove(viewport.outputs, k)
screen.emit_signal("property::_viewports", fake_viewports)
return
end
end
assert(false)
end
local function add_output(viewport, output)
table.insert(viewport.outputs, output)
screen.emit_signal("property::_viewports", fake_viewports)
end
local function remove_viewport(id)
for k, a in ipairs(fake_viewports) do
if a.id == id then
table.remove(fake_viewports, k)
screen.emit_signal("property::_viewports", fake_viewports)
return
end
end
assert(false)
end
local function add_viewport(viewport)
assert(viewport.id)
assert(viewport.geometry)
assert(viewport.outputs)
table.insert(fake_viewports, viewport)
screen.emit_signal("property::_viewports", fake_viewports)
end
local steps = {
-- Monkeypatch for the tests.
function()
-- This should be true for all tests for.
assert(not screen.automatic_factory)
-- Avoids touching the real XRDB, the tests don't control it.
function ascreen._get_xft_dpi()
return xft_dpi
end
-- This testsuite needs to manipulate this.
function ascreen._get_viewports()
local clone = gtable.clone(fake_viewports, true)
assert(#clone > 0 or allow_zero)
return clone
end
return true
end,
-- Remove all the screens, which is **not** supported, but necessary to play
-- with the initial screen creation code.
function()
-- Simple scenario, a single screen.
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 2,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {{ name = "leet", mm_width = 353, mm_height = 11 }},
},
}
-- It should honor the XFT DPI when set.
assert(xft_dpi == screen[1].dpi)
-- Now that we know it works, unset it for the other steps.
xft_dpi = nil
-- Check if the "normal" fallback works.
fake_replay()
assert(screen[1].dpi ~= 42)
return true
end,
-- Test with multiple outputs.
function()
-- Simple scenario, a single screen.
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 3,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {
{ name = "leet", mm_width = 353 , mm_height = 11 },
{ name = "leet", mm_width = 353/2, mm_height = 11/2 },
{ name = "leet", mm_width = 353/3, mm_height = 11/3 },
},
},
}
assert(screen[1].maximum_dpi == screen[1].minimum_dpi*3)
assert(screen[1].preferred_dpi == screen[1].minimum_dpi )
return true
end,
-- Test with zero outputs.
function()
-- Simple scenario, a single screen.
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 4,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {},
},
}
assert(screen[1].maximum_dpi == screen[1].minimum_dpi)
assert(screen[1].preferred_dpi == screen[1].minimum_dpi)
return true
end,
-- Test with 2 screens.
function()
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 5,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {{ name = "0x1ee7", mm_width = 353, mm_height = 11 }},
},
{
-- 1 has already been consumed, this makes the test more future proof.
id = 6,
geometry = { x = 1337, y = 0, width = 1337, height = 42 },
outputs = {{ name = "3leet", mm_width = 353, mm_height = 11 }},
},
}
saved_dpi1 = screen[1].preferred_dpi
return true
end,
-- Test with 2 screens with twice the density.
function()
-- Simple scenario, a single screen.
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 7,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {{ name = "0x1ee7", mm_width = 353/2, mm_height = 11/2 }},
},
{
-- 1 has already been consumed, this makes the test more future proof.
id = 8,
geometry = { x = 1337, y = 0, width = 1337, height = 42 },
outputs = {{ name = "3leet", mm_width = 353/3, mm_height = 11/3 }},
},
}
-- Test if scaling works as expected.
assert(saved_dpi1*2 == screen[1].preferred_dpi)
assert(saved_dpi1*3 == screen[2].preferred_dpi)
-- Revert to the previous settings if the DPI happens to accidentally match.
-- For the following tests, it has to be different from the fallback.
if screen[1].preferred_dpi == screen[1].dpi then
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 9,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {{ name = "0x1ee7", mm_width = 353, mm_height = 11 }},
}
}
end
saved_dpi1 = screen[1].preferred_dpi
-- The next test requires a different value.
assert(saved_dpi1 ~= screen[1].dpi)
-- Enable autodpi.
ascreen.set_auto_dpi_enabled(true)
return true
end,
-- Test if autodpi does something.
function()
-- Replay with the same settings.
fake_replay()
-- If this isn't true, then auto-dpi didn't do its job.
assert(screen[1].dpi == saved_dpi1)
-- Revert to a single viewport for the next tests.
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 10,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {{ name = "leet", mm_width = 353, mm_height = 11 }},
},
}
saved_dpi1 = screen[1].dpi
saved_dpi2 = screen[1].maximum_dpi
saved_dpi3 = screen[1].minimum_dpi
return true
end,
-- Test adding an output.
function()
local viewport = screen[1].data.viewport
add_output(fake_viewports[1], {
name = "foobar",
mm_width = 353/2,
mm_height = 11/2
})
add_output(fake_viewports[1], {
name = "foobar2",
mm_width = 353*2,
mm_height = 11*2
})
-- It should have been kept.
assert(viewport == screen[1].data.viewport)
-- If this isn't true, then auto-dpi didn't do its job.
assert(screen[1].dpi ~= saved_dpi1)
-- Now that there is multiple DPIs for the same viewport, the number
-- should double.
assert(#screen[1].data.viewport.outputs == 3)
assert(screen[1].maximum_dpi == saved_dpi2*2)
assert(screen[1].minimum_dpi == saved_dpi3/2)
assert(screen[1].dpi == saved_dpi1/2)
remove_output(fake_viewports[1], "leet")
assert(#screen[1].data.viewport.outputs == 2)
remove_output(fake_viewports[1], "foobar")
-- At this point, only 1 DPI is left.
assert(#screen[1].data.viewport.outputs == 1)
assert(screen[1].maximum_dpi == saved_dpi1/2)
assert(screen[1].minimum_dpi == saved_dpi1/2)
assert(screen[1].dpi == saved_dpi1/2)
return true
end,
-- Test adding/removing viewports.
function()
assert(screen.count() == 1)
add_viewport {
id = 11,
geometry = { x = 1337, y = 0, width = 1337, height = 42 },
outputs = {{
name = "foobar",
mm_width = 353/2,
mm_height = 11/2
}}
}
assert(screen.count() == 2)
assert(screen[1].data.viewport.id == 10)
assert(screen[2].data.viewport.id == 11)
assert(grect.are_equal(screen[1].data.viewport.geometry, screen[1].geometry))
assert(grect.are_equal(screen[2].data.viewport.geometry, screen[2].geometry))
assert(#ascreen._viewports == 2)
remove_viewport(10)
assert(#ascreen._viewports == 1)
assert(screen.count() == 1)
assert(screen[1].data.viewport.id == 11)
assert(grect.are_equal(screen[1].data.viewport.geometry, screen[1].geometry))
return true
end,
-- Test resizing.
function()
local s, sa = screen[1], screen[1].data.viewport
assert(screen.count() == 1)
assert(#ascreen._viewports == 1)
-- First, to the same size (replace internal screen with external screen).
-- It may or may not create a different viewport in practice, but it's possible
-- if the first screen is removed then the new one added in 2 steps.
fake_replace {
{
id = 12,
geometry = { x = 1337, y = 0, width = 1337, height = 42 },
outputs = {{ name = "foobar3", mm_width = 353/2, mm_height = 11/2}}
}
}
assert(screen.count() == 1)
assert(s == screen[1])
assert(s.data.viewport ~= sa)
assert(s.data.viewport.id == 12)
-- Now 2 smaller (resolution) screens side by side to make sure it doesn't
-- go haywire with overlapping
fake_replace {
{
id = 13,
geometry = { x = 1337, y = 0, width = 680, height = 42 },
outputs = {{ name = "foobar4", mm_width = 353/2, mm_height = 11/2}}
},
{
id = 14,
geometry = { x = 1337+680, y = 0, width = 1337, height = 42 },
outputs = {{ name = "foobar5", mm_width = 353/2, mm_height = 11/2}}
}
}
assert(screen.count() == 2)
assert(s == screen[1])
assert(s.data.viewport.id == 13)
assert(s.geometry.x == 1337)
assert(s.geometry.width == 680)
-- Disconnect the default handler to test the fallback.
screen.disconnect_signal("request::create", ascreen.create_screen_handler)
screen.disconnect_signal("request::remove", ascreen.remove_screen_handler)
screen.disconnect_signal("request::resize", ascreen.resize_screen_handler)
return true
end,
-- Test the fallback screen creation.
function()
fake_replay {
{
-- 1 has already been consumed, this makes the test more future proof.
id = 15,
geometry = { x = 0, y = 0, width = 1337, height = 42 },
outputs = {{ name = "0x1ee7", mm_width = 353, mm_height = 11 }},
},
{
-- 1 has already been consumed, this makes the test more future proof.
id = 16,
geometry = { x = 1337, y = 0, width = 1337, height = 42 },
outputs = {{ name = "3leet", mm_width = 353, mm_height = 11 }},
},
}
assert(screen.count() == 2)
assert(screen[1].data.viewport.id == 15)
assert(screen[2].data.viewport.id == 16)
-- Connect custom handler and see if the internals accidently depend on
-- implementation details.
screen.connect_signal("request::create", function(viewport)
assert(viewport.minimum_dpi)
assert(viewport.maximum_dpi)
assert(viewport.preferred_dpi)
local geo = viewport.geometry
local s = screen.fake_add(geo.x, geo.y, geo.width, geo.height)
s.outputs = viewport.outputs
called = called + 1
end)
screen.connect_signal("request::remove", function(viewport)
local geo = viewport.geometry
for s in screen do
if grect.are_equal(geo, s.geometry) then
s:fake_remove()
called = called + 1
return
end
end
end)
return true
end,
-- Test if alternate implementations don't explode the internals.
function()
ascreen._viewports = {}
while screen.count() > 0 do
screen[1]:fake_remove()
end
assert(screen.count() == 0)
-- screen.emit_signal("scanning")
screen.emit_signal("property::_viewports", fake_viewports)
screen.emit_signal("scanned")
assert(screen.count() == 2)
assert(grect.are_equal(
screen[1].geometry, {x = 0, y = 0, width = 1337, height = 42}
))
assert(grect.are_equal(
screen[2].geometry, {x = 1337, y = 0, width = 1337, height = 42}
))
-- Call the DPI properties just to check it doesn't cause an error)
assert(screen[1].dpi or true)
assert(screen[1].maximum_dpi or true)
assert(screen[1].minimum_dpi or true)
assert(screen[1].preferred_dpi or true)
assert(screen[2].dpi or true)
assert(screen[2].maximum_dpi or true)
assert(screen[2].minimum_dpi or true)
assert(screen[2].preferred_dpi or true)
assert(called == 2)
-- Try adding an viewport.
table.insert(fake_viewports, {
-- 1 has already been consumed, this makes the test more future proof.
id = 17,
geometry = { x = 1337, y = 42, width = 1337, height = 42 },
outputs = {{ name = "last", mm_width = 353, mm_height = 11 }},
})
screen.emit_signal("property::_viewports", fake_viewports)
assert(screen.count() == 3)
assert(called == 3)
assert(grect.are_equal(
screen[3].geometry, {x = 1337, y = 42, width = 1337, height = 42}
))
-- Remove the middle one.
table.remove(fake_viewports, 2)
screen.emit_signal("property::_viewports", fake_viewports)
assert(screen.count() == 2)
assert(called == 4)
assert(grect.are_equal(
screen[1].geometry, {x = 0, y = 0, width = 1337, height = 42}
))
assert(grect.are_equal(
screen[2].geometry, {x = 1337, y = 42, width = 1337, height = 42}
))
return true
end
}
runner.run_steps(steps)