Merge branch 'fifo-logger'

Author: dsalt

Makefile

@@ -44,7 +44,7 @@ endif
 
 DEPEND=Makefile.dep
 
-OBJECTS=$(OBJ)/config.o $(OBJ)/devilspie2.o $(OBJ)/xutils.o $(OBJ)/script.o $(OBJ)/script_functions.o $(OBJ)/error_strings.o
+OBJECTS=$(OBJ)/config.o $(OBJ)/devilspie2.o $(OBJ)/xutils.o $(OBJ)/script.o $(OBJ)/script_functions.o $(OBJ)/error_strings.o $(OBJ)/logger.o
 
 ifndef PREFIX
 	ifdef INSTALL_PREFIX

README.md

@@ -20,12 +20,26 @@ Unfortunately the rules of the original Devil's Pie are not supported.
 |:--|:--|
 | `-h`, `--help`         | Show help options |
 | `-d`, `--debug`        | Print debug information to stdout |
+| `-D`, `--debug-fifo`   | Print debug info & copy stdout to a FIFO |
+| `-P`, `--print-fifo`   | Print the debug FIFO's file name then quit |
 | `-e`, `--emulate`      | Don't apply any rules, only emulate execution |
 | `-f`, `--folder`       | Search for scripts in this folder |
 | `-v`, `--version`      | Print program version then quit |
 | `-w`, `--wnck-version` | Show libwnck version then quit |
 | `-l`, `--lua-version`  | Show Lua version then quit |
 
+If you run `devilspie2 --debug-fifo`, you can connect to its FIFO at any
+time and see the same text as for `devilspie --debug`. The reason for this
+is to allow `devilspie2` to be dæmonised while still having access to
+debugging output etc. at need.
+
+A useful way of doing this is to run, in a terminal, this command:
+```sh
+cat "$(devilspie2 -P)"
+```
+(No text backlog will be shown; if there's nothing reading the FIFO, nothing
+is written to it.)
+
 ## Configuration
 
 Scripts are read from the scripts folder, which is customisable by using the

devilspie2.1

@@ -23,8 +23,24 @@ Displays the version of Devilspie2.
 Sets the folder where the Lua scripts are loaded from.
 .TP
 \fB\-d\fR, \fB\-\-debug
-Shows debug information from the Lua scripts. If debug_print is used in the Lua
-scripts, that output will only be printed to stdout if this option is used.
+Shows debug information from the Lua scripts. If \fIdebug_print\fR is used
+in the Lua scripts, it will output to stdout.
+.TP
+\fB\-D\fR, \fB\-\-debug\-fifo
+Copy stdout & send debug info to a FIFO. If \fIdebug_print\fR is used in
+the Lua scripts, it will output to the FIFO. This is intended for running
+dæmonised while allowing access to debug text etc. at need.
+
+Nothing is output to the FIFO if nothing is reading it.
+You can read it using a program such as \fBcat\fR.
+
+\fB\-\-debug\fR and \fB\-\-debug\-fifo\fR may be used together.
+.TP
+\fB\-P\fR, \fB\-\-print\-fifo
+Print the FIFO's file name then exit. This may be used as follows:
+.EX
+cat "$(devilspie2 \-\-print\-fifo)"
+.EE
 .TP
 \fB\-e\fR, \fB\-\-emulate
 Emulation mode. This prevents windows from being affected by the scripts,
@@ -41,6 +57,17 @@ See
 .I /usr/share/doc/devilspie2/README.md
 for a detailed description of the commands recognised in Lua scripts.
 
+.SH Files
+.TP
+.B $XDG_RUNTIME_DIR/devilspie2\-$DISPLAY
+.TP
+.B $TMPDIR/devilspie2\-$DISPLAY
+.TP
+.B /tmp/devilspie2\-$DISPLAY
+These are the possible locations of the FIFO which is created if
+\fB\-\-debug\-fifo\fR is used. The first one for which the referenced
+environment variables are set is used.
+
 .SH Author
 .P
 .B Devilspie2

src/compat.h

@@ -22,8 +22,10 @@
 
 #if defined(__GNUC__) || defined(__clang__)
 # define ATTR_MALLOC __attribute__((malloc))
+# define ATTR_FORMAT_PRINTF(fmt, args) __attribute__((format(printf, fmt, args)))
 #else
 # define ATTR_MALLOC
+# define ATTR_FORMAT_PRINTF(fmt, args)
 #endif
 
 #endif /* __HEADER_COMPAT_ */

src/config.c

@@ -33,6 +33,7 @@
 
 #include "script.h"
 #include "script_functions.h"
+#include "logger.h"
 
 #include "config.h"
 
@@ -221,7 +222,7 @@ int load_config(gchar *filename)
 	if (g_file_test(filename, G_FILE_TEST_EXISTS)) {
 
 		if (run_script(config_lua_state, filename) != 0) {
-			printf(_("Error: %s\n"), filename);
+			logger_err_printf(_("Error: %s\n"), filename);
 			result = -1;
 			goto EXITPOINT;
 		}

src/devilspie2.c

@@ -37,6 +37,7 @@
 
 #include "script.h"
 #include "script_functions.h"
+#include "logger.h"
 
 #include "error_strings.h"
 
@@ -53,7 +54,11 @@
 GMainLoop *loop = NULL;
 
 static gboolean debug = FALSE;
+static gboolean logtofifo = FALSE;
 static gboolean emulate = FALSE;
+
+static gboolean show_fifo = FALSE;
+
 static gboolean show_version = FALSE;
 
 // libwnck Version Information is only availible if you have
@@ -215,7 +220,7 @@ static void signal_handler(int sig)
 /**
  *
  */
-void print_list(GSList *list)
+static void print_list(GSList *list)
 {
 	GSList *temp_list;
 	if (list != NULL) {
@@ -226,7 +231,7 @@ void print_list(GSList *list)
 
 			if (file_name) {
 				if (g_str_has_suffix((gchar*)file_name, ".lua")) {
-					printf("%s\n", (gchar*)file_name);
+					logger_printf("%s\n", (gchar*)file_name);
 				}
 			}
 			temp_list = temp_list->next;
@@ -238,30 +243,26 @@ void print_list(GSList *list)
 /**
  *
  */
-void print_script_lists()
+static void print_script_lists()
 {
 	gboolean have_any_files = FALSE;
 	win_event_type i;
 
-	if (debug)
-		printf("------------\n");
+	logger_print("------------\n");
 
 	for (i = 0; i < W_NUM_EVENTS; i++) {
 		if (event_lists[i])
 			have_any_files = TRUE;
 		// If we are running debug mode - print the list of files:
-		if (debug) {
-			printf(_("List of Lua files handling \"%s\" events in folder:"),
-				   event_names[i]);
-			printf("\n");
-			if (event_lists[i]) {
-				print_list(event_lists[i]);
-			}
+		logger_printf(_("List of Lua files handling \"%s\" events in folder:\n"),
+		              event_names[i]);
+		if (event_lists[i]) {
+			print_list(event_lists[i]);
 		}
 	}
 
 	if (!have_any_files) {
-		printf("%s\n\n", _("No script files found in the script folder - exiting."));
+		logger_err_printf("%s\n\n", _("No script files found in the script folder - exiting."));
 		exit(EXIT_SUCCESS);
 	}
 }
@@ -275,19 +276,17 @@ void refresh_config_and_script()
 	set_current_window(NULL);
 
 	if (load_config(config_filename) != 0) {
-		printf("Configuration file cannot be re-loaded. Processing will not continue until the error is corrected");
+		logger_print_always("Configuration file cannot be re-loaded. Processing will not continue until the error is corrected.\n");
 		return;
 	}
 
 	global_lua_state = reinit_script(global_lua_state, script_folder);
 
-	if (debug)
-		printf("Files in folder updated!\n - new lists:\n\n");
+	logger_print("Files in folder updated!\n - new lists:\n\n");
 
 	print_script_lists();
 
-	if (debug)
-		printf("-----------\n");
+	logger_print("-----------\n");
 }
 
 /**
@@ -332,7 +331,6 @@ void folder_changed_callback(GFileMonitor *mon G_GNUC_UNUSED,
 	}
 }
 
-
 /**
  * Program main entry
  */
@@ -342,6 +340,12 @@ int main(int argc, char *argv[])
 		{ "debug",        'd', 0, G_OPTION_ARG_NONE,   &debug,
 		  N_("Print debug info to stdout"), NULL
 		},
+		{ "debug-fifo",   'D', 0, G_OPTION_ARG_NONE,   &logtofifo,
+		  N_("Print debug info & copy stdout to a FIFO"), NULL
+		},
+		{ "print-fifo",   'P', 0, G_OPTION_ARG_NONE,   &show_fifo,
+		  N_("Print the debug FIFO's file name then quit"), NULL
+		},
 		{ "emulate",      'e', 0, G_OPTION_ARG_NONE,   &emulate,
 		  N_("Don't apply any rules, only emulate execution"), NULL
 		},
@@ -383,6 +387,12 @@ int main(int argc, char *argv[])
 		printf("\n");
 		exit(EXIT_FAILURE);
 	}
+
+	if (show_fifo) {
+		puts(logger_get_fifo_name());
+		exit(EXIT_SUCCESS);
+	}
+
 	gboolean shown = FALSE;
 	if (show_version) {
 		printf("Devilspie2 v%s\n", DEVILSPIE2_VERSION);
@@ -503,9 +513,11 @@ int main(int argc, char *argv[])
 	                 (gpointer)(config_filename));
 
 	global_lua_state = init_script(script_folder);
+	if (logtofifo)
+		logger_create(global_lua_state);
 	print_script_lists();
 
-	if (debug) printf("------------\n");
+	logger_print("------------\n");
 
 	// remove stuff cleanly
 	atexit(devilspie_exit);