From e5f90f25d755b19151dfcfd98790c1bad3eb8068 Mon Sep 17 00:00:00 2001
From: Brian Ashworth <bosrsf04@gmail.com>
Date: Wed, 28 Nov 2018 11:08:54 -0500
Subject: [PATCH] Introduce a way to show config warnings in swaynag

Adds the function `config_add_swaynag_warning(char *fmt, ...)` so that
handlers can add warnings to the swaynag config log in a uniform way.
The formatting is identical to errors and include the line number, line,
and config path.

This also alters the background file access warning to use the function
and introduces a warning for duplicate bindings.
---
 include/sway/config.h             |  7 +++++++
 sway/commands/bind.c              |  8 ++++++--
 sway/commands/output/background.c |  7 ++-----
 sway/config.c                     | 28 ++++++++++++++++++++++++++++
 4 files changed, 43 insertions(+), 7 deletions(-)

diff --git a/include/sway/config.h b/include/sway/config.h
index 1ff9a104..d02b0d63 100644
--- a/include/sway/config.h
+++ b/include/sway/config.h
@@ -425,6 +425,8 @@ struct sway_config {
 	list_t *config_chain;
 	const char *current_config_path;
 	const char *current_config;
+	int current_config_line_number;
+	char *current_config_line;
 
 	enum sway_container_border border;
 	enum sway_container_border floating_border;
@@ -489,6 +491,11 @@ bool load_include_configs(const char *path, struct sway_config *config,
 bool read_config(FILE *file, struct sway_config *config,
 		struct swaynag_instance *swaynag);
 
+/**
+ * Adds a warning entry to the swaynag instance used for errors.
+ */
+void config_add_swaynag_warning(char *fmt, ...);
+
 /**
  * Free config struct
  */
diff --git a/sway/commands/bind.c b/sway/commands/bind.c
index 34881b0f..9112815f 100644
--- a/sway/commands/bind.c
+++ b/sway/commands/bind.c
@@ -255,8 +255,12 @@ static struct cmd_results *cmd_bindsym_or_bindcode(int argc, char **argv,
 	for (int i = 0; i < mode_bindings->length; ++i) {
 		struct sway_binding *config_binding = mode_bindings->items[i];
 		if (binding_key_compare(binding, config_binding)) {
-			wlr_log(WLR_DEBUG, "overwriting old binding with command '%s'",
-				config_binding->command);
+			wlr_log(WLR_INFO, "Overwriting binding '%s' for device '%s' "
+					"from `%s` to `%s`", argv[0], binding->input,
+					binding->command, config_binding->command);
+			config_add_swaynag_warning("Overwriting binding '%s' for device "
+					"'%s' to `%s` from `%s`", argv[0], binding->input,
+					binding->command, config_binding->command);
 			free_sway_binding(config_binding);
 			mode_bindings->items[i] = binding;
 			overwritten = true;
diff --git a/sway/commands/output/background.c b/sway/commands/output/background.c
index 30fb47c4..2cd1b76a 100644
--- a/sway/commands/output/background.c
+++ b/sway/commands/output/background.c
@@ -116,11 +116,8 @@ struct cmd_results *output_cmd_background(int argc, char **argv) {
 		if (!can_access) {
 			wlr_log(WLR_ERROR, "Unable to access background file '%s': %s",
 					src, strerror(errno));
-			if (config->reading && !config->validating) {
-				swaynag_log(config->swaynag_command,
-						&config->swaynag_config_errors,
-						"Unable to access background file '%s'", src);
-			}
+			config_add_swaynag_warning("Unable to access background file '%s'",
+					src);
 			free(src);
 		} else {
 			// Escape double quotes in the final path for swaybg
diff --git a/sway/config.c b/sway/config.c
index ed288060..46322374 100644
--- a/sway/config.c
+++ b/sway/config.c
@@ -700,6 +700,8 @@ bool read_config(FILE *file, struct sway_config *config,
 			free(line);
 			return false;
 		}
+		config->current_config_line_number = line_number;
+		config->current_config_line = line;
 		struct cmd_results *res;
 		if (block && strcmp(block, "<commands>") == 0) {
 			// Special case
@@ -761,10 +763,36 @@ bool read_config(FILE *file, struct sway_config *config,
 	}
 	list_foreach(stack, free);
 	list_free(stack);
+	config->current_config_line_number = 0;
+	config->current_config_line = NULL;
 
 	return success;
 }
 
+void config_add_swaynag_warning(char *fmt, ...) {
+	if (config->reading && !config->validating) {
+		va_list args;
+		va_start(args, fmt);
+		size_t length = vsnprintf(NULL, 0, fmt, args) + 1;
+		va_end(args);
+
+		char *temp = malloc(length + 1);
+		if (!temp) {
+			wlr_log(WLR_ERROR, "Failed to allocate buffer for warning.");
+			return;
+		}
+
+		va_start(args, fmt);
+		vsnprintf(temp, length, fmt, args);
+		va_end(args);
+
+		swaynag_log(config->swaynag_command, &config->swaynag_config_errors,
+			"Warning on line %i (%s) '%s': %s",
+			config->current_config_line_number, config->current_config_path,
+			config->current_config_line, temp);
+	}
+}
+
 char *do_var_replacement(char *str) {
 	int i;
 	char *find = str;