From 5447de8a4701aec496638486e02ebf6acae7bb45 Mon Sep 17 00:00:00 2001
From: Colin Geniet <colin.geniet@ens-lyon.fr>
Date: Wed, 24 Apr 2024 10:15:01 +0200
Subject: [PATCH] utils: Add parser/writer for 'first-page-column'

The 'first-page-column' setting is a string representing a list of integers.
This is annoying to manipulate.  Currently, it has a single accessor,
'find_first_page_column', which looks up the nth value.
The next commit will add a function to change it.

To avoid this turning into a horrible buggy mess of string manipulation,
add functions to convert the settings string to and from integer arrays.
Rewrite 'find_first_page_column' using these functions.

Efficiency: the new functions are slower than 'find_first_page_column'
because they parse all values in the string.  This is irrelevant since
the string is supposed to be tiny, and is only used when opening a
document or when the page layout is modified by the user.
---
 zathura/utils.c | 65 ++++++++++++++++++++++++++++++++++++++++---------
 zathura/utils.h | 24 ++++++++++++++++++
 2 files changed, 77 insertions(+), 12 deletions(-)

diff --git a/zathura/utils.c b/zathura/utils.c
index 32d1e5f..b064071 100644
--- a/zathura/utils.c
+++ b/zathura/utils.c
@@ -244,6 +244,52 @@ get_selection(zathura_t* zathura)
   return selection;
 }
 
+char*
+write_first_page_column_list(unsigned int* first_page_columns, unsigned int size)
+{
+  if (first_page_columns == NULL)
+    return NULL;
+
+  char** tokens = g_malloc_n(size+1, sizeof(char*));
+  tokens[size] = NULL;
+
+  for (unsigned int i=0; i<size; i++) {
+    tokens[i] = g_strdup_printf("%d", first_page_columns[i]);
+  }
+
+  char* first_page_column_list = g_strjoinv(":", tokens);
+  g_strfreev(tokens);
+
+  return first_page_column_list;
+}
+
+unsigned int*
+parse_first_page_column_list(const char* first_page_column_list, unsigned int* size)
+{
+  if (first_page_column_list == NULL || size == NULL)
+    return NULL;
+
+  char** tokens = g_strsplit(first_page_column_list, ":", 0);
+  unsigned int length = g_strv_length(tokens);
+
+  unsigned int* settings = g_malloc_n(length, sizeof(unsigned int));
+
+  for (unsigned int i=0; i<length; i++) {
+    unsigned long column = 1;
+
+    if (g_ascii_string_to_unsigned(tokens[i], 10, 1, i+1, &column, NULL)) {
+      settings[i] = (unsigned int)column;
+    } else {
+      settings[i] = 1;
+    }
+  }
+
+  g_strfreev(tokens);
+
+  *size = length;
+  return settings;
+}
+
 unsigned int
 find_first_page_column(const char* first_page_column_list,
                        const unsigned int pages_per_row)
@@ -251,23 +297,18 @@ find_first_page_column(const char* first_page_column_list,
   /* sanity checks */
   unsigned int first_page_column = 1;
   g_return_val_if_fail(first_page_column_list != NULL,  first_page_column);
-  g_return_val_if_fail(*first_page_column_list != '\0', first_page_column);
   g_return_val_if_fail(pages_per_row > 0,               first_page_column);
 
-  /* split settings list */
-  char** settings = g_strsplit(first_page_column_list, ":", pages_per_row + 1);
-  const size_t settings_size = g_strv_length(settings);
+  unsigned int size = 0;
+  unsigned int* settings = parse_first_page_column_list(first_page_column_list, &size);
 
-  /* read setting value corresponding to the specified pages per row */
-  unsigned int index = pages_per_row - 1;
-  if (index < settings_size && *settings[index] != '\0') {
-    first_page_column = atoi(settings[index]);
-  } else if (*settings[settings_size - 1] != '\0') {
-    first_page_column = atoi(settings[settings_size - 1]);
+  if (pages_per_row <= size) {
+    first_page_column = settings[pages_per_row - 1];
+  } else if (size > 0) {
+    first_page_column = settings[size - 1];
   }
 
-  /* free buffers */
-  g_strfreev(settings);
+  g_free(settings);
 
   return first_page_column;
 }
diff --git a/zathura/utils.h b/zathura/utils.h
index e1da74b..5e4a1f0 100644
--- a/zathura/utils.h
+++ b/zathura/utils.h
@@ -107,6 +107,30 @@ GdkAtom* get_selection(zathura_t* zathura);
 double zathura_correct_zoom_value(girara_session_t* session, const double
     zoom);
 
+/**
+ * Write a list of 'pages per row to first column' values as a colon separated string.
+ *
+ * For valid settings list, this is the inverse of parse_first_page_column_list.
+ *
+ * @param[in] first_page_columns The settings vector
+ * @param[in] size The size of the settings vector
+ *
+ * @return The new settings string
+ */
+char* write_first_page_column(unsigned int* first_page_columns, unsigned int size);
+
+/**
+ * Parse a 'pages per row to first column' settings list.
+ *
+ * For valid settings list, this is the inverse of write_first_page_column_list.
+ *
+ * @param[in] first_page_column_list The settings list
+ * @param[in] size A cell to return the size of the result, mandatory
+ *
+ * @return The values from the settings list as a new vector
+ */
+unsigned int* parse_first_page_column(const char* first_page_column_list, unsigned int* size);
+
 /**
  * Extracts the column the first page should be rendered in from the specified
  * list of settings corresponding to the specified pages per row