Bg color + fix default config

.gitignore

@@ -1,12 +1,14 @@
 *.o
 *.a
 *.patch
+*.data
+.*.md
+**.tar.zst
 .cache/
 bin/
 pkg/
 /ragnar/
-**.tar.zst
+src/ragnar/
 .gdb.log
 compile_commands.json
 compile_flags.txt
-.*.md

Makefile

@@ -4,7 +4,13 @@ CC = cc
 # bought nothing and -ffinite-math-only would let divisions by a zero-sized
 # monitor fold away instead of showing up.
 CFLAGS ?= -O2
-ALL_CFLAGS = $(CFLAGS) $(CPPFLAGS) -Wall -Wextra -pedantic -isystem api/include
+WARN_CFLAGS = -Wall -Wextra -pedantic -isystem api/include
+ALL_CFLAGS = $(CFLAGS) $(CPPFLAGS) $(WARN_CFLAGS)
+
+# -O1 : for readable ASAN traces. Separate from CFLAGS because that is ?=
+# and a distro build must not pick these up.
+DEBUG_CFLAGS = -O1 -g -fno-omit-frame-pointer -fsanitize=address,undefined
+ALL_DEBUG_CFLAGS = $(DEBUG_CFLAGS) $(CPPFLAGS) $(WARN_CFLAGS)
 
 LDLIBS = -lxcb -lxcb-keysyms -lxcb-icccm -lxcb-cursor -lxcb-randr -lxcb-xfixes -lX11 -lX11-xcb -lconfig
 
@@ -20,6 +26,16 @@ all:
 	mkdir -p ./bin
 	$(CC) -o bin/$(BIN) $(ALL_CFLAGS) $(LDFLAGS) $(SRC) $(LDLIBS)
 
+# ASan + UBSan + LSan build, overwrites bin/ragnar. LSan only reports on a
+# normal exit, so quit ragnar through its own keybind: a SIGKILL prints
+# nothing. .PHONY matters here, the ./debug Xephyr script shares the name
+# and make would otherwise call the target up to date.
+#   make debug && ./debug
+.PHONY: debug
+debug:
+	mkdir -p ./bin
+	$(CC) -o bin/$(BIN) $(ALL_DEBUG_CFLAGS) $(LDFLAGS) $(SRC) $(LDLIBS)
+
 # client-side IPC library. the WM links none of it, only the headers under
 # api/include are needed to build. opt-in, for writing external clients.
 .PHONY: api
@@ -37,15 +53,31 @@ install-api:
 .PHONY: install
 install:
 	install -Dm755 bin/$(BIN) -t $(DESTDIR)$(BINDIR)
-	install -Dm644 ragnar.desktop -t $(DESTDIR)$(PREFIX)/share/xsessions
 	install -Dm644 cfg/ragnar.cfg -t $(DESTDIR)$(SYSCONFDIR)/ragnarwm
 
+# the shipped cfg is the only fallback a fresh install has: readconfig
+# terminates when neither the user nor the global path parses, so a syntax
+# error here means a fresh install cannot start at all.
+.PHONY: check
+check:
+	mkdir -p ./bin
+	$(CC) -o bin/config_check $(ALL_CFLAGS) $(LDFLAGS) cfg/config_check.c -lconfig
+	./bin/config_check cfg/ragnar.cfg
+
+# makepkg's $srcdir defaults to ./src, which collides with this project's
+# own src/. build out of tree so the clone never lands in the worktree.
+BUILDDIR ?= /tmp/makepkg
+SRCDEST  ?= $(HOME)/.cache/makepkg/sources
+
+.PHONY: package
+package:
+	BUILDDIR=$(BUILDDIR) SRCDEST=$(SRCDEST) makepkg -f
+
 .PHONY: clean
 clean:
 	$(RM) bin/*
 
 .PHONY: uninstall
 uninstall:
 	$(RM) $(DESTDIR)$(BINDIR)/$(BIN)
-	$(RM) $(DESTDIR)$(PREFIX)/share/xsessions/ragnar.desktop
 	$(RM) -r $(DESTDIR)$(SYSCONFDIR)/ragnarwm

PKGBUILD

@@ -26,14 +26,18 @@ depends=(
 )
 makedepends=('git' 'make' 'gcc')
 optdepends=(
-  'picom: for proper vsync/fix tearing'
+  'picom: additional compositor features'
+  'dmenu: default launcher'
   'alacritty: default terminal keybind'
   'polybar: optional status/desktops bars'
+  'feh: optional set wallpaper for X displays'
   'ttf-dejavu: fonts for both the above'
   'wireplumber: default volume keybinds'
   'brightnessctl: default brightness keybinds'
   'playerctl: default media player keybinds'
+  'xorg-xset: for screenblanking idle/DPMS'
 )
+
 provides=('ragnarwm')
 options=('!debug')
 backup=('etc/ragnarwm/ragnar.cfg')
@@ -43,6 +47,7 @@ install="${pkgname}.install"
 source=("${_pkgname}::git+${url}.git#branch=${_branch}")
 sha256sums=('SKIP')
 
+# TODO add a release flow that bumps on gh automatically
 pkgver() {
   cd $_pkgname || exit 1
   echo $pkgver
@@ -53,6 +58,12 @@ build() {
   make
 }
 
+# check the shipped config is not borken
+check() {
+  cd $_pkgname || exit 1
+  make check
+}
+
 package() {
   cd $_pkgname || exit 1
   # single source of truth: same install target ./install.sh drives.

README.md

@@ -79,16 +79,18 @@ Ragnar uses `libconfig` to load an external configuration file:
 ~/.config/ragnarwm/ragnar.cfg
 ```
 
-The configuration is loaded on startup and can be reloaded while the window manager is running, typically through a keybinding.
+The configuration is loaded on startup and can be reloaded while the window manager is running, typically through a keybinding (Super+C).
 
 Example contents of `.xinitrc`:
 
 ```console
+feh --bg-fill ~/Downloads/nerd.jpg;
+xset s off -dpms;
 picom -b; polybar &
 exec ragnar
 ```
 
-Then simply; `startx`
+Then simply; `startx` (and `pkill xinit` to stop it.)
 
 > By default it uses `alacritty` (Super+Return) and `dmenu` (Super+S), if you haven't edited these yet.
 > Both of these need fonts file; for instance `ttf-dejavu`

api/api.c

@@ -106,10 +106,10 @@ clientinit(socket_client_t* cl) {
 
   memset(&cl->addr, 0, sizeof(struct sockaddr_un));
   cl->addr.sun_family = AF_UNIX;
-  strncpy(cl->addr.sun_path, SOCKPATH, sizeof(cl->addr.sun_path) - 1);
+  rg_socket_path(cl->addr.sun_path, sizeof(cl->addr.sun_path));
 
   if(s_logging) {
-    printf("ragnar api: created unix domain socket on: '%s'\n", SOCKPATH);
+    printf("ragnar api: created unix domain socket on: '%s'\n", cl->addr.sun_path);
   }
   return 0;
 }

api/include/ragnar/api.h

@@ -2,6 +2,36 @@
 
 #include <stdbool.h>
 #include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+/*
+ * IPC socket path, computed rather than fixed. XDG_RUNTIME_DIR scopes it
+ * per user and DISPLAY per X server: one hardcoded path meant a second
+ * instance (a nested Xephyr session, a second seat) unlinked the running
+ * WM's socket out from under it at startup
+ *
+ * static inline in the public header on purpose. The WM links none of
+ * api.c and only includes these headers, so this is the single place both
+ * sides can share the path and not drift apart
+ */
+static inline void
+rg_socket_path(char* buf, size_t len) {
+  const char* dir = getenv("XDG_RUNTIME_DIR");
+  if(!dir) {
+    dir = "/tmp";
+  }
+  const char* display = getenv("DISPLAY");
+  if(!display) {
+    display = ":0";
+  }
+  // DISPLAY is ":1" or ":0.0"; drop the leading colon so the result reads
+  // as ragnar-1.socket rather than ragnar-:1.socket
+  if(*display == ':') {
+    display++;
+  }
+  snprintf(buf, len, "%s/ragnar-%s.socket", dir, display);
+}
 
 typedef int32_t RgWindow;
 

cfg/config_check.c

@@ -0,0 +1,21 @@
+#include <libconfig.h>
+#include <stdio.h>
+
+int main(int argc, char** argv) {
+  if(argc != 2) {
+    fprintf(stderr, "usage: %s <config file>\n", argv[0]);
+    return 2;
+  }
+
+  config_t cfg;
+  config_init(&cfg);
+  if(config_read_file(&cfg, argv[1])) {
+    config_destroy(&cfg);
+    printf("sample config is valid.");
+    return 0;
+  }
+
+  fprintf(stderr, "%s:%d: %s\n", argv[1], config_error_line(&cfg), config_error_text(&cfg));
+  config_destroy(&cfg);
+  return 1;
+}

cfg/ragnar.cfg

@@ -58,6 +58,7 @@
 #   - setfloatingmode
 #   - updatebarslayout
 #   - cycledownlayout
+#   - cycleuplayout
 #   - addmasterlayout
 #   - removemasterlayout
 #   - incmasterarealayout
@@ -73,33 +74,37 @@
 #   - cyclefocusmonitordown
 #   - cyclefocusmonitorup
 #   - togglescratchpad
+#   - reloadconfigfile
 #
 # ----------------------
 # NOTE: For all key options, see the functions at:
 # https://github.com/cococry/ragnar/blob/main/src/structs.h#L17
 # ----------------------
-#
 
 # Specifies the width of the border around client
 # windows
 win_border_width = 2;
+
 # Specifies the color of the border around client
 # windows
 win_border_color = 0x3B3B3B;
+
 # Specifies the color of the border around
 # selected/focused client windows
 win_border_color_selected = 0xE6DFDC;
 
 # Specifies the main modifier key that is
 # used to execute window manager shortcuts
 mod_key = "Super";
+
 # Specifies the modifier key that is used
 # to interact with clients windows
 win_mod = "Super";
 
 # Specfies the mouse button that needs to be
 # held in order to move client windows
 move_button = "LeftMouse";
+
 # Specfies the mouse button that needs to be
 # held in order to resize client windows
 resize_button = "RightMouse";
@@ -113,47 +118,30 @@ resize_button = "RightMouse";
 # Specifies the desktop index that is initially
 # selected on every monitor
 initial_desktop = 0;
+
 # Specfies the number of allocated virtual
 # desktops
 num_desktops = 9;
+
 # Specifies the name of every virtual desktop
 # in order.
 desktop_names = ["1", "2", "3", "4", "5", "6", "7", "8", "9"];
 
-# Specifies whether or not server-side window
-# decorations should be enabled.
-use_decoration = false;
-# Specifies whether or not server-side titlebars
-# should be shown on startup. (Ignored when
-# use_decoration is set to false.)
-show_titlebars_init = false;
-
-# Specifies the height (in pixels) of the
-# titlebar of client windows.
-titlebar_height = 30
-# Specifies the color of titlebars of
-# client windows
-titlebar_color = 0xffffff;
-
-# Specifies the color of the font that is used
-# across the window manager's UI
-font_color = 0xff0000ff;
-# Specifies the path to the font file to use as
-# the window manager's font
-font_path = "/usr/share/fonts/TTF/JetBrainsMonoNerdFont-Bold.ttf";
-
 # Specifies the area that the master window takes
 # up in master-slave layouts initially.
 # (in 0.0-1.0 %)
 layout_master_area = 0.5;
+
 # Specifies the minimum area that master windows
 # need to take up in master-slave layouts
 # (in 0.0-1.0 %)
 layout_master_area_min = 0.1;
+
 # Specifies the maximum a2rea that master windows
 # can take up in master-slave layouts
 # (in 0.0-1.0 %)
 layout_master_area_max = 0.9;
+
 # Specifies the amount that the master area changes/steps
 # when it is decreased/increased.
 # (in 0.0-1.0 %)
@@ -162,6 +150,7 @@ layout_master_area_step = 0.1;
 # Specifies the amount that areas of windows
 # within layouts change when they are increased/decreased
 # (in px)
+
 layout_size_step = 100.0;
 # Specifies the minimum area that windows within
 # layouts need to take up
@@ -176,9 +165,11 @@ key_win_move_step = 100.0;
 # Specifies the initial gap between windows
 # within layouts (in px)
 win_layout_gap = 5;
+
 # Specifies the maximum gap that windows within
 # layouts can have around each other (in px)
 win_layout_gap_max = 150;
+
 # Specifies the amount that the gap between
 # non-floating windows changes when it's
 # decreased/increased (in px)
@@ -208,15 +199,18 @@ max_struts = 8;
 # Specifies the cursor image to use for the root window
 cursor_image = "arrow";
 
-# Logging (log file is ~/.ragnarwm.log)
+# Specifies the colour the root window is painted with.
+# Optional: when unset does nothing. (Let ex: `feh` take-over)
+# bg_color = 0x1A1A1A;
 
 # Specifies whether or not to log messages
 # to the console
-log_messages = true;
+log_messages = false;
 
 # Specifies whether or not to log messages
 # to the log file
-should_log_to_file = true;
+# builds it as $HOME/.ragnarwm.log
+should_log_to_file = false;
 
 # Specifies the maximum number of scratchpads
 # that can be allocated
@@ -226,6 +220,8 @@ max_scratchpads = 10;
 
 # =========== Key bindings ===========
 
+# four sub-keys per entry: mod (optional), key, do, and then cmd / i as the
+# passthrough payload. Any other sub-key here is ignored silently.
 keybinds = (
   {
     mod = "Super";
@@ -550,6 +546,7 @@ keybinds = (
     key = "KeyC";
     do = "reloadconfigfile";
   },
+  {
     key = "KeyAudioLowerVolume";
     do  = "runcmd";
     cmd = "wpctl set-volume -l 1.0 @DEFAULT_AUDIO_SINK@ 5%-";