cleanup logging

ensure translation setup was done
fixed tempfile writes for %a tools
added CMakeLists.txt as a template for clang-tidy runs

Author: WrapEarnPass

autorun/CMakeLists.txt

@@ -0,0 +1,22 @@
+cmake_minimum_required(VERSION 3.27)
+
+list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+
+project(
+  autorun
+  VERSION 0.0.1
+  LANGUAGES C
+  DESCRIPTION "Geany action interceptor plugin")
+
+# the `pkg_check_modules` function is created with this call
+find_package(PkgConfig REQUIRED)
+# these calls create special `PkgConfig::<MODULE>` variables
+pkg_check_modules(geany REQUIRED IMPORTED_TARGET GLOBAL geany)
+
+add_library(${PROJECT_NAME} SHARED src/plugin_main.c src/autorun.c src/utils.c
+                                   src/spawn.c)
+# prevent cmake from prefixing the shared library
+set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "")
+target_link_libraries(${PROJECT_NAME} PRIVATE PkgConfig::geany)
+# install to users bin
+install(TARGETS ${PROJECT_NAME} DESTINATION plugins)

autorun/src/autorun.c

@@ -38,39 +38,38 @@ AUTORUN_CMD* autorun_cmd_new() {
 void autorun_cmd_free(AUTORUN_CMD* cmd) {
 	/* do not check for cmd->invalid because it could be a partial command
 	 * or invalidated after assembly. */
-	if (cmd == NULL) {
+	if (!cmd) {
 		// who are you and why are you in my attic?
 		return;
 	}
 	// free the command
-	if (cmd->file_type != NULL) {
+	if (cmd->file_type) {
 		cmd->file_type = NULL;
 	}
-	if (cmd->interceptor != NULL) {
+	if (cmd->interceptor) {
 		g_free(cmd->interceptor);
 		cmd->interceptor = NULL;
 	}
-	if (cmd->command != NULL) {
+	if (cmd->command) {
 		g_free(cmd->command);
 		cmd->command = NULL;
 	}
-	if (cmd->working_dir != NULL) {
+	if (cmd->working_dir) {
 		g_free(cmd->working_dir);
 		cmd->working_dir = NULL;
 	}
 }
 
 void autorun_cmd_list_free(GSList* command_list) {
-	if (command_list == NULL) {
+	if (!command_list) {
 		// why are you naked?
 		return;
 	}
-	g_message("command list had %i", g_slist_length(command_list));
 	g_slist_free_full(command_list, (GDestroyNotify)autorun_cmd_free);
 }
 
 void autorun_globals_init(GeanyPlugin* plugin) {
-	if (!autorun_globals || autorun_globals == NULL) {
+	if (!autorun_globals) {
 		autorun_globals = g_new0(AUTORUN_GLOBALS, 1);
 		autorun_globals->plugin = plugin;
 		autorun_globals->data = plugin->geany_data;
@@ -80,12 +79,12 @@ void autorun_globals_init(GeanyPlugin* plugin) {
 }
 
 void autorun_globals_free(void) {
-	if (autorun_globals != NULL) {
-		if (autorun_globals->filedef_commands != NULL) {
+	if (autorun_globals) {
+		if (autorun_globals->filedef_commands) {
 			autorun_cmd_list_free(autorun_globals->filedef_commands);
 			autorun_globals->filedef_commands = NULL;
 		}
-		if (autorun_globals->project_commands != NULL) {
+		if (autorun_globals->project_commands) {
 			autorun_cmd_list_free(autorun_globals->project_commands);
 			autorun_globals->project_commands = NULL;
 		}
@@ -114,21 +113,16 @@ void load_filedefs(void) {
 				GError* gerr = NULL;
 				gchar** handlers = g_key_file_get_keys(config, "autorun", &key_len, &gerr);
 				// if the keyfile has an [autorun] section
-				if (gerr == NULL) {
-					g_message("found %s autorun", (gchar*)node->data);
+				if (!gerr) {
 					gchar** handler_key;
 					foreach_strv(handler_key, handlers) {
-						g_message(" %s", *handler_key);
 						if (g_str_has_suffix(*handler_key, "CM")) {
 							AUTORUN_CMD* cmd = autorun_cmd_new();
 							cmd->file_type = filetypes_detect_from_file(node->data);
-							g_message("filetype was %s", filetypes_get_display_name(cmd->file_type));
 							parse_intercept_actions(*handler_key, config, cmd);
 							if (!cmd->invalid) {
 								// add the command
 								autorun_globals->filedef_commands = g_slist_prepend(autorun_globals->filedef_commands, cmd);
-								g_message("filedef list is %i", g_slist_length(autorun_globals->filedef_commands));
-
 							} else {
 								// free the command
 								autorun_cmd_free(cmd);
@@ -157,13 +151,11 @@ void load_projectdefs(GKeyFile* config) {
 	GError* gerr = NULL;
 	gchar** handlers = g_key_file_get_keys(config, "autorun", &key_len, &gerr);
 	// if the keyfile has an [autorun] section
-	if (gerr == NULL) {
-		g_message("found project autorun");
+	if (!gerr) {
 		gchar** handler_key;
 		// load any handlers
 		foreach_strv(handler_key, handlers) {
 			// over any existing [autorun] handlers
-			g_message(" %s", *handler_key);
 			if (g_str_has_suffix(*handler_key, "CM")) {
 				AUTORUN_CMD* cmd = autorun_cmd_new();
 				parse_intercept_actions(*handler_key, config, cmd);
@@ -178,7 +170,6 @@ void load_projectdefs(GKeyFile* config) {
 		}
 		// flip it around
 		autorun_globals->project_commands = g_slist_reverse(autorun_globals->project_commands);
-		g_message("proj command list is %i", g_slist_length(autorun_globals->project_commands));
 	} else {
 		g_free(gerr);
 	}

autorun/src/plugin_main.c

@@ -24,57 +24,64 @@
 
 /* Handler to read any Project declared Auto-run configs */
 static void on_project_open(G_GNUC_UNUSED GObject* obj, GKeyFile* config, G_GNUC_UNUSED gpointer user_data) {
-	g_message("on_project_open start");
-	// TODO make this more smarter
-	if (autorun_globals->project_commands == NULL) {
+	if (!autorun_globals->project_commands) {
 		load_projectdefs(config);
 	}
-	g_message("on_project_open end");
 }
 
 // this handler is currently disconnected due to geany/geany#4603
 /* Handler to read any Project declared Auto-run configs */
 // static void on_project_save(G_GNUC_UNUSED GObject* obj, GKeyFile* config, G_GNUC_UNUSED gpointer user_data){
-//	g_message("on_project_save");
 //	load_projectdefs(config);
 // }
 
 /* Handler to clear any old Project declared Auto-run configs */
 static void on_project_close(G_GNUC_UNUSED GObject* obj, G_GNUC_UNUSED gpointer user_data) {
-	g_message("project close start");
 	// unload project handlers
 	autorun_cmd_list_free(autorun_globals->project_commands);
 	autorun_globals->project_commands = NULL;
-	g_message("project close end");
 }
 
 /* Handler to run any applicable Auto-run configs after a write*/
-void on_doc_save(G_GNUC_UNUSED GObject* obj, GeanyDocument* doc, G_GNUC_UNUSED gpointer user_data) {
-	g_message("on save start");
+static void on_doc_save(G_GNUC_UNUSED GObject* obj, GeanyDocument* doc, G_GNUC_UNUSED gpointer user_data) {
 	/* disabled because geany/geany#4604 never sets doc->changed
 	if(!doc->changed)
 	{
-		g_message("doc not changed?");
 		return;
 	}
 	*/
+	if (sci_get_length(doc->editor->sci) < 1) {
+		// no point in processing a file so short
+		return;
+	}
 	ui_progress_bar_start(NULL);
+	/*
+	 * dont reset the msgwin here, as document-save
+	 * is the second stage of document-before-save
+	 * and the messages will all be logically related
+	 * to the user selecting File>Save
+	 */
 	dispatch_run("OS", doc);
 	ui_progress_bar_stop();
-	g_message("on save end");
 }
 
 /* Handler to run any applicable Auto-run configs before a write*/
-void on_doc_before_save(G_GNUC_UNUSED GObject* obj, GeanyDocument* doc, G_GNUC_UNUSED gpointer user_data) {
-	g_message("before save start");
+static void on_doc_before_save(G_GNUC_UNUSED GObject* obj, GeanyDocument* doc, G_GNUC_UNUSED gpointer user_data) {
 	if (!doc->changed) {
-		g_message("doc not changed?");
+		return;
+	}
+	if (sci_get_length(doc->editor->sci) < 1) {
+		// no point in processing a file so short
 		return;
 	}
 	ui_progress_bar_start(NULL);
+	// status is used for return codes, so dont clear that one
+	// messages is used for stdout
+	msgwin_clear_tab(MSG_MESSAGE);
+	// compiler is used for stderr
+	msgwin_clear_tab(MSG_COMPILER);
 	dispatch_run("BS", doc);
 	ui_progress_bar_stop();
-	g_message("before save end");
 }
 
 // clang-format off
@@ -90,38 +97,31 @@ PluginCallback plugin_callbacks[] = {
 
 /* Bring up plugin and load filetypes.FILE that exist for Auto-run */
 static gboolean autorun_init(GeanyPlugin* plugin, gpointer pdata) {
-	g_message("autorun_init start");
-	if (!autorun_globals || autorun_globals == NULL) {
+	if (!autorun_globals) {
 		autorun_globals_init(plugin);
 		load_filedefs();
-		g_message("filedef command list is %i", g_slist_length(autorun_globals->filedef_commands));
 
 		// if initialized while a project is already open, manually ingest the project
 		if (autorun_globals->data->app && autorun_globals->data->app->project) {
 			// force a GKeyFile
 			GKeyFile* config = g_key_file_new();
 			g_key_file_load_from_file(config, autorun_globals->data->app->project->file_name, G_KEY_FILE_NONE, NULL);
 			load_projectdefs(config);
-			g_message("proj command list is %i", g_slist_length(autorun_globals->project_commands));
 			g_free(config);
 		}
 	}
-	g_message("autorun_init end");
 	return TRUE;
 }
 
 /* ensure destruction of any Auto-run objects */
 static void autorun_cleanup(GeanyPlugin* plugin, gpointer pdata) {
-	g_message("autorun_cleanup start");
-	if (autorun_globals != NULL) {
+	if (autorun_globals) {
 		autorun_globals_free();
 	}
-	g_message("autorun_cleanup end");
 }
 
 G_MODULE_EXPORT
 void geany_load_module(GeanyPlugin* plugin) {
-	g_message("load_module start");
 	// who am we?
 	plugin->info->name = "Auto-run";
 	plugin->info->description = _("Geany action interceptor plugin");
@@ -138,5 +138,4 @@ void geany_load_module(GeanyPlugin* plugin) {
 
 	// go forth and come fifth.
 	GEANY_PLUGIN_REGISTER(plugin, 225);
-	g_message("load_module end");
 }