From 8d9bd2d747d43c0fc61e9b51e2628323131f15e2 Mon Sep 17 00:00:00 2001
From: Johan Malm <jgm323@gmail.com>
Date: Thu, 2 Jan 2025 20:40:41 +0000
Subject: [PATCH] theme: use 'labwc' directory

as well as 'openbox-3', for example: /usr/share/themes/foo/labwc/themerc

Give 'labwc' higher precedence than 'openbox-3' if both exist.

For several reasons not all themes designed for labwc render well on
Openbox:

1. Labwc support some features like SVG/PNG icons and #rrggbbaa color
   definitions which Openbox does not.

2. Openbox generally defaults to black/white colors and will not render
   themes accurate without certain options specified in themerc. For
   example, in Openbox the following will just render as black:

       window.active.title.bg.color: #589bda

   ...because Openbox defaults the texture to "Gradient Vertical" and
   therefore either needs:

      window.active.title.bg.colorTo: #3c7cb7

   ...or remove 'Gradient' from the bg definition and just use something
   like:

      window.active.title.bg: Flat Border

Whilst none of this is a problem when using labwc, it causes problems for
setups with both Openbox and labwc because themes designed for labwc only
will now show up in obconf, lxappearance, etc causing confusion for users.
---
 README.md              |  2 +-
 docs/labwc-theme.5.scd |  5 +++++
 include/theme.h        |  2 +-
 src/common/dir.c       | 15 +++++++++++++--
 src/theme.c            |  6 +++++-
 5 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 9aff6c03..ce98e7fd 100644
--- a/README.md
+++ b/README.md
@@ -192,7 +192,7 @@ For a step-by-step initial configuration guide, see [getting-started].
 
 ## 4. Theming
 
-Themes are located at `~/.local/share/themes/\<theme-name\>/openbox-3/` or
+Themes are located at `~/.local/share/themes/\<theme-name\>/labwc/` or
 equivalent `XDG_DATA_{DIRS,HOME}` location in accordance with freedesktop XDG
 directory specification.
 
diff --git a/docs/labwc-theme.5.scd b/docs/labwc-theme.5.scd
index 16cb390f..9ce8a0a8 100644
--- a/docs/labwc-theme.5.scd
+++ b/docs/labwc-theme.5.scd
@@ -9,6 +9,11 @@ labwc - theme files
 The theme engine aims to be compatible with openbox and themes will be
 searched for in the following order:
 
+- ${XDG_DATA_HOME:-$HOME/.local/share}/themes/<theme-name>/labwc/
+- $HOME/.themes/<theme-name>/labwc/
+- /usr/share/themes/<theme-name>/labwc/
+- /usr/local/share/themes/<theme-name>/labwc/
+- /opt/share/themes/<theme-name>/labwc/
 - ${XDG_DATA_HOME:-$HOME/.local/share}/themes/<theme-name>/openbox-3/
 - $HOME/.themes/<theme-name>/openbox-3/
 - /usr/share/themes/<theme-name>/openbox-3/
diff --git a/include/theme.h b/include/theme.h
index 88b43e28..c6893ea2 100644
--- a/include/theme.h
+++ b/include/theme.h
@@ -163,7 +163,7 @@ struct server;
  * theme_init - read openbox theme and generate button textures
  * @theme: theme data
  * @server: server
- * @theme_name: theme-name in <theme-dir>/<theme-name>/openbox-3/themerc
+ * @theme_name: theme-name in <theme-dir>/<theme-name>/labwc/themerc
  * Note <theme-dir> is obtained in theme-dir.c
  */
 void theme_init(struct theme *theme, struct server *server, const char *theme_name);
diff --git a/src/common/dir.c b/src/common/dir.c
index 201c9b03..2b0016d7 100644
--- a/src/common/dir.c
+++ b/src/common/dir.c
@@ -75,7 +75,15 @@ build_config_path(struct ctx *ctx, char *prefix, const char *path)
 }
 
 static void
-build_theme_path(struct ctx *ctx, char *prefix, const char *path)
+build_theme_path_labwc(struct ctx *ctx, char *prefix, const char *path)
+{
+	assert(prefix);
+	snprintf(ctx->buf, ctx->len, "%s/%s/%s/labwc/%s", prefix, path,
+		ctx->theme_name, ctx->filename);
+}
+
+static void
+build_theme_path_openbox(struct ctx *ctx, char *prefix, const char *path)
 {
 	assert(prefix);
 	snprintf(ctx->buf, ctx->len, "%s/%s/%s/openbox-3/%s", prefix, path,
@@ -169,7 +177,7 @@ paths_theme_create(struct wl_list *paths, const char *theme_name,
 	static char buf[4096] = { 0 };
 	wl_list_init(paths);
 	struct ctx ctx = {
-		.build_path_fn = build_theme_path,
+		.build_path_fn = build_theme_path_labwc,
 		.filename = filename,
 		.buf = buf,
 		.len = sizeof(buf),
@@ -178,6 +186,9 @@ paths_theme_create(struct wl_list *paths, const char *theme_name,
 		.list = paths,
 	};
 	find_dir(&ctx);
+
+	ctx.build_path_fn = build_theme_path_openbox;
+	find_dir(&ctx);
 }
 
 void
diff --git a/src/theme.c b/src/theme.c
index 0d0938a3..d2cb9826 100644
--- a/src/theme.c
+++ b/src/theme.c
@@ -1496,7 +1496,11 @@ theme_init(struct theme *theme, struct server *server, const char *theme_name)
 	 */
 	theme_builtin(theme, server);
 
-	/* Read <data-dir>/share/themes/$theme_name/openbox-3/themerc */
+	/*
+	 * Read
+	 *   - <data-dir>/share/themes/$theme_name/labwc/themerc
+	 *   - <data-dir>/share/themes/$theme_name/openbox-3/themerc
+	 */
 	struct wl_list paths;
 	paths_theme_create(&paths, theme_name, "themerc");
 	theme_read(theme, &paths);
-- 
2.52.0