From c4c97174e66b07132bc66ff94a2e9be5eb041af0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Emmanuel=20Lepage=20Vall=C3=A9e?= <elv1313@gmail.com>
Date: Tue, 6 Aug 2019 22:48:06 -0700
Subject: [PATCH] doc: Fix a rendering regression regarding backgrounds.
 (#2820)

The way background are rendered changed to accomodate issues regarding
cliping and border. However this broke the documentation examples.

This commit fixes this in the least hacky way I found.

Fixes #2727
---
 lib/wibox/container/background.lua        | 55 +++++++++++++++++++++++
 tests/examples/shims/_common_template.lua |  5 +++
 2 files changed, 60 insertions(+)

diff --git a/lib/wibox/container/background.lua b/lib/wibox/container/background.lua
index 455fe0477..b1941b4eb 100644
--- a/lib/wibox/container/background.lua
+++ b/lib/wibox/container/background.lua
@@ -22,6 +22,61 @@ local unpack = unpack or table.unpack -- luacheck: globals unpack (compatibility
 
 local background = { mt = {} }
 
+-- The Cairo SVG backend doesn't support surface as patterns correctly.
+-- The result is both glitchy and blocky. It is also impossible to introspect.
+-- Calling this function replace the normal code path is a "less correct", but
+-- more widely compatible version.
+function background._use_fallback_algorithm()
+    background.before_draw_children = function(self, _, cr, width, height)
+        local bw    = self._private.shape_border_width or 0
+        local shape = self._private.shape or gshape.rectangle
+
+        if bw > 0 then
+            cr:translate(bw, bw)
+            width, height = width - 2*bw, height - 2*bw
+        end
+
+        shape(cr, width, height)
+
+        if bw > 0 then
+            cr:save() --Save to avoid messing with the original source
+            cr:set_line_width(bw)
+            cr:set_source(color(self._private.shape_border_color or self._private.foreground or beautiful.fg_normal))
+            cr:stroke_preserve()
+            cr:restore()
+        end
+
+        if self._private.background then
+            cr:save() --Save to avoid messing with the original source
+            cr:set_source(self._private.background)
+            cr:fill_preserve()
+            cr:restore()
+        end
+
+        cr:translate(-bw, -bw)
+        cr:clip()
+
+        if self._private.foreground then
+            cr:set_source(self._private.foreground)
+        end
+    end
+    background.after_draw_children = function(self, _, cr, width, height)
+        local bw    = self._private.shape_border_width or 0
+        local shape = self._private.shape or gshape.rectangle
+
+        if bw > 0 then
+            cr:save()
+            cr:translate(bw, bw)
+            width, height = width - 2*bw, height - 2*bw
+            shape(cr, width, height)
+            cr:set_line_width(bw)
+            cr:set_source(color(self._private.shape_border_color or self._private.foreground or beautiful.fg_normal))
+            cr:stroke()
+            cr:restore()
+        end
+    end
+end
+
 -- Make sure a surface pattern is freed *now*
 local function dispose_pattern(pattern)
     local status, s = pattern:get_surface()
diff --git a/tests/examples/shims/_common_template.lua b/tests/examples/shims/_common_template.lua
index 8c31f0283..9f69c3199 100644
--- a/tests/examples/shims/_common_template.lua
+++ b/tests/examples/shims/_common_template.lua
@@ -26,6 +26,11 @@ return function(_, _)
 
     -- Silence debug warnings
     require("gears.debug").print_warning = function() end
+
+    -- Revert the background widget to something compatible with Cairo SVG
+    -- backend.
+    local bg = require("wibox.container.background")
+    bg._use_fallback_algorithm()
 end
 
 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80