[Issue #21] Adds the ability to put count and ratio in the layout.

.cppcheck.supp

@@ -1,7 +1,7 @@
 unusedFunction:pro/*.h
 
 unusedFunction:tst/asserts.h
-unusedFunction:tst/util.c
+unusedFunction:tst/file.c
 unusedFunction:tst/wrap-*.c
 
 # TODO use --check-level=exhaustive once available in CI

.github/workflows/ci.yml

@@ -16,8 +16,8 @@ jobs:
       run: |
         sudo add-apt-repository universe
         sudo apt install clang wayland-protocols libwlroots-dev libcmocka-dev cppcheck valgrind -y
-    - name: gcc
-      run: make CC=gcc CXX=g++ clean wideriver
+    # - name: gcc
+    #   run: make CC=gcc CXX=g++ clean wideriver
     - name: clang
       run: make CC=clang CXX=clang++ clean wideriver
     - name: test

.iwyu.mappings

@@ -0,0 +1,4 @@
+[
+{ symbol: [ va_start, private, <stdarg.h>, public] },
+{ symbol: [ va_end,   private, <stdarg.h>, public] }
+]

GNUmakefile

@@ -69,7 +69,7 @@ doc: wideriver
 #
 iwyu: override CC = $(IWYU) -Xiwyu --check_also="inc/*h"
 iwyu: clean $(SRC_O) $(TST_O)
-IWYU = include-what-you-use -Xiwyu --no_fwd_decls -Xiwyu --error=1 -Xiwyu --verbose=3
+IWYU = include-what-you-use -Xiwyu --no_fwd_decls -Xiwyu --error=1 -Xiwyu --verbose=3 -Xiwyu --mapping_file=.iwyu.mappings
 
 #
 # cppcheck

flake.nix

@@ -0,0 +1,90 @@
+{
+  description = "A simple C program using jansson built with Nix flakes";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+  };
+
+  outputs = { self, nixpkgs }: {
+    packages = nixpkgs.lib.genAttrs [ "aarch64-darwin" "x86_64-linux" ] (system:
+    let pkgs = import nixpkgs { inherit system; };
+    in rec {
+      wideriver = pkgs.stdenv.mkDerivation {
+        pname = "wideriver";
+        version = "1.0";
+
+        src = ./.;
+
+        nativeBuildInputs = with pkgs; [
+          wayland-scanner
+        ];
+        buildInputs = with pkgs; [
+          clang
+          wayland
+          wayland-scanner
+          wlr-protocols
+          wlroots
+          pkg-config
+        ];
+
+        buildPhase = ''
+          make
+        '';
+
+        installFlags = [ "PREFIX=$(out)" ];
+
+        installPhase = ''
+          mkdir -p $out/bin
+          cp wideriver $out/bin/
+        '';
+
+        meta = with pkgs.lib; {
+          description = "A simple program using jansson";
+          license = licenses.mit;
+          maintainers = [ maintainers.yourname ];
+          platforms = platforms.unix;
+        };
+      };
+    });
+
+    devShell = nixpkgs.lib.genAttrs [ "aarch64-darwin" "x86_64-linux" ] (system:
+    let pkgs = import nixpkgs { inherit system; };
+    in pkgs.mkShell {
+      nativeBuildInputs = with pkgs; [
+        wayland-scanner
+      ];
+      buildInputs = with pkgs; [
+        clang
+        clang-tools  # Includes clangd
+		cppcheck
+		cmocka
+		include-what-you-use
+		valgrind
+        wayland
+        wayland-scanner
+        wlr-protocols
+        wlroots
+        pkg-config
+      ];
+
+      shellHook = ''
+        echo "Development environment loaded."
+      '';
+    });
+
+    defaultPackage = {
+      aarch64-darwin = self.packages.aarch64-darwin.wideriver;
+      x86_64-linux = self.packages.x86_64-linux.wideriver;
+    };
+
+    defaultApp = {
+      forAllSystems = nixpkgs.lib.mapAttrs' (system: pkg: {
+        inherit system;
+        defaultApp = {
+          type = "app";
+          program = "${pkg.wideriver}/bin/wideriver";
+        };
+      }) self.packages;
+    };
+  };
+}

inc/cfg.h

@@ -41,6 +41,8 @@
 
 #define BORDER_COLOR_UNFOCUSED_DEFAULT "0x586e75"
 
+#define LAYOUT_FORMAT_LEN 90
+
 // never null
 extern const struct Cfg * const cfg;
 
@@ -61,6 +63,7 @@ struct Cfg {
 	char border_color_focused[11];
 	char border_color_focused_monocle[11];
 	char border_color_unfocused[11];
+	char layout_format[LAYOUT_FORMAT_LEN];
 };
 
 // returns false if not valid
@@ -77,6 +80,7 @@ bool cfg_set_inner_gaps(const char *s);
 bool cfg_set_outer_gaps(const char *s);
 bool cfg_set_border_width(const char *s);
 bool cfg_set_border_width_monocle(const char *s);
+bool cfg_set_layout_format(const char *s);
 
 // returns false if not 0xRRGGBB
 bool cfg_set_border_color_focused(const char *s);

inc/enum.h

@@ -27,6 +27,15 @@ enum LogThreshold {
 	LOG_THRESHOLD_DEFAULT = INFO,
 };
 
+enum LayoutFormatElem {
+	LAYOUT = 'l',
+	COUNT = 'c',
+	RATIO = 'r',
+	NAME = 'n',
+};
+
+#define DEFAULT_LAYOUT_FORMAT "{l}"
+
 const char *layout_name(const enum Layout layout);
 enum Layout layout_val(const char *name);
 

inc/layout.h

@@ -21,14 +21,22 @@ struct Box {
 	uint32_t height;
 };
 
-// return a river layout name, caller frees
-const char *layout_description(const struct Demand *demand, const struct Tag *tag);
+// return a river layout name
+// caller frees
+char *layout_description(const struct Demand *demand, const struct Tag *tag);
 
 // populate views with Box for river layout push dimensions, caller frees
 struct SList *layout(const struct Demand *demand, const struct Tag *tag);
 
 // push Box views
 void push(const struct SList *views, struct river_layout_v3 *river_layout_v3, const uint32_t serial);
 
+// layout image
+// caller frees
+char *layout_image(const struct Demand* const demand, const struct Tag* const tag);
+
+// fully rendered layout
+const char *description_info(const struct Demand* const demand, const struct Tag* const tag);
+
 #endif // LAYOUT_H
 

inc/util.h

@@ -0,0 +1,5 @@
+// return a copy of src with instances of target substituted with replacement
+// returns unmodified on zero length target
+// returns NULL on any NULL parameter
+// caller frees
+char *string_replace(const char * const src, const char * const target, const char * const replacement);

result

@@ -0,0 +1 @@
+/nix/store/p98n306sq7xk0yvc0px9yzkgcasrl1jr-wideriver-1.0

src/args.c

@@ -34,6 +34,7 @@ static struct option cli_long_options[] = {
 	{ "help-defaults",                no_argument,       0, 0, }, // 18
 	{ "log-threshold",                required_argument, 0, 0, }, // 19
 	{ "version",                      no_argument,       0, 0, }, // 20
+	{ "layout-format",                required_argument, 0, 0, }, // 21
 	{ 0,                              0,                 0, 0, }
 };
 
@@ -179,6 +180,13 @@ void args_cli(int argc, char **argv) {
 				fprintf(stdout, "wideriver version %s\n", VERSION);
 				exit(EXIT_SUCCESS);
 				return;
+			case 21:
+				if (!cfg_set_layout_format(optarg)) {
+					log_error("invalid --layout-format '%s'\n", optarg);
+					usage(EXIT_FAILURE);
+					return;
+				}
+				break;
 			default:
 				fprintf(stderr, "\n");
 				usage(EXIT_FAILURE);
@@ -202,6 +210,7 @@ void args_cli(int argc, char **argv) {
 	log_info("--border-color-focused         %s", cfg->border_color_focused);
 	log_info("--border-color-focused-monocle %s", cfg->border_color_focused_monocle);
 	log_info("--border-color-unfocused       %s", cfg->border_color_unfocused);
+	log_info("--layout-format                %s", cfg->layout_format);
 	log_info("--log-threshold                %s", log_threshold_name(log_get_threshold()));
 }
 

src/cfg.c

@@ -24,6 +24,7 @@ struct Cfg c = {
 	.border_color_focused = BORDER_COLOR_FOCUSED_DEFAULT,
 	.border_color_focused_monocle = BORDER_COLOR_FOCUSED_MONOCLE_DEFAULT,
 	.border_color_unfocused = BORDER_COLOR_UNFOCUSED_DEFAULT,
+	.layout_format = DEFAULT_LAYOUT_FORMAT,
 };
 
 const struct Cfg * const cfg = &c;
@@ -190,6 +191,39 @@ bool cfg_set_border_width_monocle(const char *s) {
 	}
 }
 
+bool cfg_set_layout_format(const char *s) {
+	if (strlen(s) > LAYOUT_FORMAT_LEN)
+		return false;
+
+	int escaped = 0;
+	bool in_brackets = false;
+
+	for (int i = 0; s[i] != '\0'; i++) {
+		if (s[i] == '{' && escaped == 0)
+			in_brackets = true;
+		else if (s[i] == '}' && escaped == 0 && in_brackets) {
+			if ((s[i-1] != LAYOUT &&
+						s[i-1] != COUNT   &&
+						s[i-1] != NAME    &&
+						s[i-1] != RATIO) ||
+					s[i-2] != '{'
+			   ) {
+				return false;
+			}
+			in_brackets = false;
+		} else if (s[i] ==  '\\' && escaped == 0 && !in_brackets) {
+			escaped = 2;
+		}
+
+		escaped -= 1;
+		if (escaped < 0)
+			escaped = 0;
+	}
+
+	strncpy(c.layout_format, s, sizeof(c.layout_format));
+	return true;
+}
+
 bool cfg_set_border_color_focused(const char *s) {
 	if (valid_colour(s)) {
 		snprintf(c.border_color_focused, 11, "%s", s);

src/cmd.c

@@ -1,5 +1,4 @@
 #include <stdbool.h>
-#include <stddef.h>
 #include <stdlib.h>
 #include <string.h>
 

src/enum.c

@@ -1,6 +1,5 @@
-#include <unistd.h>
 #include <strings.h>
-
+#include <stddef.h>
 #include "enum.h"
 
 struct NameVal {