Refactor

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 57 insertions, 6 deletions

diff --git a/src/location-geoclue2.c b/src/location-geoclue2.c
index 84ef6b4..69323c2 100644
--- a/src/location-geoclue2.c
+++ b/src/location-geoclue2.c
@@ -1,4 +1,5 @@
-/* redshift-ng - Automatically adjust display colour temperature according the Sun
+/*-
+ * redshift-ng - Automatically adjust display colour temperature according the Sun
  * 
  * Copyright (c) 2009-2018        Jon Lund Steffensen <jonlst@gmail.com>
  * Copyright (c) 2014-2016, 2025  Mattias Andrée <m@maandree.se>
@@ -33,21 +34,62 @@
 # pragma clang diagnostic pop
 #endif
 
+
+/**
+ * D-Bus error indicating denial of access
+ */
 #define DBUS_ACCESS_ERROR  "org.freedesktop.DBus.Error.AccessDenied"
 
 
+/**
+ * Location data
+ */
 struct location_data {
+	/**
+	 * The user's geographical location
+	 */
 	struct location location;
+
+	/**
+	 * Whether the location provider is available
+	 */
 	int available;
+
+	/**
+	 * Whether an unrecoverable error has occurred
+	 */
 	int error;
 };
 
+
 struct location_state {
 	GMainLoop *loop;
+
+	/**
+	 * Slave thread, used to receive location updates
+	 */
 	GThread *thread;
+
+	/**
+	 * Read-end of piped used to send location data
+	 * from the slave thread to the master thread
+	 */
 	int pipe_fd_read;
+
+	/**
+	 * Write-end of piped used to send location data
+	 * from the slave thread to the master thread
+	 */
 	int pipe_fd_write;
+
+	/**
+	 * Location data available from the slave thread
+	 */
 	struct location_data data;
+
+	/**
+	 * Location data sent to the master thread
+	 */
 	struct location_data saved_data;
 };
 
@@ -64,12 +106,14 @@ print_denial_message(void)
 		"information.\n"));
 }
 
+
 static void
 send_data(struct location_state *state)
 {
 	while (write(state->pipe_fd_write, &state->data, sizeof(state->data)) == -1 && errno == EINTR);
 }
 
+
 /* Indicate an unrecoverable error during GeoClue2 communication */
 static void
 mark_error(struct location_state *state)
@@ -78,6 +122,7 @@ mark_error(struct location_state *state)
 	send_data(state);
 }
 
+
 /* Handle position change callbacks */
 static void
 geoclue_client_signal_cb(GDBusProxy *client, gchar *sender_name, gchar *signal_name, GVariant *parameters, gpointer user_data)
@@ -119,6 +164,7 @@ geoclue_client_signal_cb(GDBusProxy *client, gchar *sender_name, gchar *signal_n
 	send_data(state);
 }
 
+
 /* Callback when GeoClue name appears on the bus */
 static void
 on_name_appeared(GDBusConnection *conn, const gchar *name, const gchar *name_owner, gpointer user_data)
@@ -230,6 +276,7 @@ on_name_appeared(GDBusConnection *conn, const gchar *name, const gchar *name_own
 	g_variant_unref(ret_v);
 }
 
+
 /* Callback when GeoClue disappears from the bus */
 static void
 on_name_vanished(GDBusConnection *connection, const gchar *name, gpointer user_data)
@@ -243,6 +290,7 @@ on_name_vanished(GDBusConnection *connection, const gchar *name, gpointer user_d
 	send_data(state);
 }
 
+
 /* Callback when the pipe to the main thread is closed */
 static gboolean
 on_pipe_closed(GIOChannel *channel, GIOCondition condition, gpointer user_data)
@@ -294,6 +342,7 @@ run_geoclue2_loop(void *state_)
 	return NULL;
 }
 
+
 static int
 geoclue2_create(struct location_state **state_out)
 {
@@ -304,6 +353,7 @@ geoclue2_create(struct location_state **state_out)
 	return 0;
 }
 
+
 static int
 geoclue2_start(struct location_state *state)
 {
@@ -318,11 +368,7 @@ geoclue2_start(struct location_state *state)
 	state->data.location.longitude = 0;
 	state->saved_data = state->data;
 
-	if (pipe_rdnonblock(pipefds)) {
-		weprintf(_("Failed to start GeoClue2 provider!"));
-		return -1;
-	}
-
+	pipe_rdnonblock(pipefds);
 	state->pipe_fd_read = pipefds[0];
 	state->pipe_fd_write = pipefds[1];
 
@@ -333,6 +379,7 @@ geoclue2_start(struct location_state *state)
 	return 0;
 }
 
+
 static void
 geoclue2_free(struct location_state *state)
 {
@@ -346,6 +393,7 @@ geoclue2_free(struct location_state *state)
 	free(state);
 }
 
+
 static void
 geoclue2_print_help(FILE *f)
 {
@@ -353,6 +401,7 @@ geoclue2_print_help(FILE *f)
 	fputs("\n", f);
 }
 
+
 static int
 geoclue2_set_option(struct location_state *state, const char *key, const char *value)
 {
@@ -362,12 +411,14 @@ geoclue2_set_option(struct location_state *state, const char *key, const char *v
 	return -1;
 }
 
+
 static int
 geoclue2_get_fd(struct location_state *state)
 {
 	return state->pipe_fd_read;
 }
 
+
 static int
 geoclue2_fetch(struct location_state *state, struct location *location_out, int *available_out)
 {