add rc_client_create_subset_list (#486)

Author: Jamiras

include/rc_client.h

@@ -364,6 +364,22 @@ RC_EXPORT const rc_client_subset_t* RC_CCONV rc_client_get_subset_info(rc_client
 
 RC_EXPORT void RC_CCONV rc_client_get_user_subset_summary(const rc_client_t* client, uint32_t subset_id, rc_client_user_game_summary_t* summary);
 
+typedef struct rc_client_subset_list_t {
+  const rc_client_subset_t** subsets;
+  uint32_t num_subsets;
+} rc_client_subset_list_t;
+
+/**
+ * Creates a list of subsets for the currently loaded game.
+ * Returns an allocated list that must be free'd by calling rc_client_destroy_subset_list.
+ */
+RC_EXPORT rc_client_subset_list_t* RC_CCONV rc_client_create_subset_list(rc_client_t* client);
+
+/**
+ * Destroys a list allocated by rc_client_create_subset_list_list.
+ */
+RC_EXPORT void RC_CCONV rc_client_destroy_subset_list(rc_client_subset_list_t* list);
+
 /*****************************************************************************\
 | Fetch Game Hashes                                                           |
 \*****************************************************************************/
@@ -538,7 +554,7 @@ enum {
 RC_EXPORT rc_client_achievement_list_t* RC_CCONV rc_client_create_achievement_list(rc_client_t* client, int category, int grouping);
 
 /**
- * Destroys a list allocated by rc_client_get_achievement_list.
+ * Destroys a list allocated by rc_client_create_achievement_list.
  */
 RC_EXPORT void RC_CCONV rc_client_destroy_achievement_list(rc_client_achievement_list_t* list);
 

src/rc_client.c

@@ -3487,6 +3487,58 @@ const rc_client_subset_t* rc_client_get_subset_info(rc_client_t* client, uint32_
   return NULL;
 }
 
+rc_client_subset_list_t* rc_client_create_subset_list(rc_client_t* client)
+{
+  rc_client_subset_list_info_t* list;
+  const rc_client_subset_info_t* subset;
+  const rc_client_subset_t** subset_ptr;
+  const uint32_t list_size = RC_ALIGN(sizeof(*list));
+  uint32_t num_subsets = 0;
+
+  if (!client)
+    return (rc_client_subset_list_t*)calloc(1, list_size);
+
+#ifdef RC_CLIENT_SUPPORTS_EXTERNAL
+  if (client->state.external_client && client->state.external_client->create_subset_list)
+    return (rc_client_subset_list_t*)client->state.external_client->create_subset_list();
+#endif
+
+  if (!client->game)
+    return (rc_client_subset_list_t*)calloc(1, list_size);
+
+  rc_mutex_lock(&client->state.mutex);
+
+  subset = client->game->subsets;
+  for (; subset; subset = subset->next) {
+    if (subset->active)
+      num_subsets++;
+  }
+
+  list = (rc_client_subset_list_info_t*)malloc(list_size + num_subsets * sizeof(rc_client_subset_t*));
+  list->public_.subsets = subset_ptr = (const rc_client_subset_t**)((uint8_t*)list + list_size);
+
+  subset = client->game->subsets;
+  for (; subset; subset = subset->next) {
+    if (subset->active)
+      *subset_ptr++ = &subset->public_;
+  }
+
+  rc_mutex_unlock(&client->state.mutex);
+
+  list->destroy_func = NULL;
+  list->public_.num_subsets = (uint32_t)(subset_ptr - list->public_.subsets);
+  return &list->public_;
+}
+
+void rc_client_destroy_subset_list(rc_client_subset_list_t* list)
+{
+  rc_client_subset_list_info_t* info = (rc_client_subset_list_info_t*)list;
+  if (info->destroy_func)
+    info->destroy_func(info);
+  else
+    free(list);
+}
+
 /* ===== Fetch Game Hashes ===== */
 
 typedef struct rc_client_fetch_hash_library_callback_data_t {

src/rc_client_external.h

@@ -61,6 +61,11 @@ typedef rc_client_async_handle_t* (RC_CCONV *rc_client_external_begin_fetch_lead
 typedef rc_client_async_handle_t* (RC_CCONV *rc_client_external_begin_fetch_leaderboard_entries_around_user_func_t)(rc_client_t* client,
   uint32_t leaderboard_id, uint32_t count, rc_client_fetch_leaderboard_entries_callback_t callback, void* callback_userdata);
 
+/* NOTE: rc_client_external_create_subset_list_func_t returns an internal wrapper structure which contains the public list
+ * and a destructor function. */
+struct rc_client_subset_list_info_t;
+typedef struct rc_client_subset_list_info_t* (RC_CCONV* rc_client_external_create_subset_list_func_t)();
+
 
 typedef size_t (RC_CCONV *rc_client_external_progress_size_func_t)(void);
 typedef int (RC_CCONV *rc_client_external_serialize_progress_func_t)(uint8_t* buffer, size_t buffer_size);
@@ -144,6 +149,9 @@ typedef struct rc_client_external_t
   rc_client_external_get_user_game_summary_func_t get_user_game_summary_v5;
   rc_client_external_get_user_subset_summary_func_t get_user_subset_summary;
 
+  /* VERSION 6 */
+  rc_client_external_create_subset_list_func_t create_subset_list;
+
 } rc_client_external_t;
 
 #define RC_CLIENT_EXTERNAL_VERSION 5

src/rc_client_internal.h

@@ -222,6 +222,14 @@ typedef struct rc_client_subset_info_t {
   uint8_t pending_events;
 } rc_client_subset_info_t;
 
+struct rc_client_subset_list_info_t;
+typedef void (RC_CCONV* rc_client_destroy_subset_list_func_t)(struct rc_client_subset_list_info_t* list);
+
+typedef struct rc_client_subset_list_info_t {
+  rc_client_subset_list_t public_;
+  rc_client_destroy_subset_list_func_t destroy_func;
+} rc_client_subset_list_info_t;
+
 /*****************************************************************************\
 | Game                                                                        |
 \*****************************************************************************/

test/test_rc_client.c

@@ -4072,6 +4072,50 @@ static void test_load_subset(void)
   rc_client_destroy(g_client);
 }
 
+static void test_subset_list(void)
+{
+  rc_client_subset_list_t* list;
+  const rc_client_subset_t* subset;
+
+  g_client = mock_client_game_loaded(patchdata_subset, no_unlocks);
+
+  list = rc_client_create_subset_list(g_client);
+  ASSERT_PTR_NOT_NULL(list);
+  if (list) {
+    ASSERT_NUM_EQUALS(list->num_subsets, 2);
+
+    subset = list->subsets[0];
+    ASSERT_NUM_EQUALS(subset->id, 1111);
+    ASSERT_STR_EQUALS(subset->title, "Sample Game");
+    ASSERT_STR_EQUALS(subset->badge_name, "112233");
+    ASSERT_NUM_EQUALS(subset->num_achievements, 7);
+    ASSERT_NUM_EQUALS(subset->num_leaderboards, 7);
+    ASSERT_STR_EQUALS(subset->badge_url, "http://server/Images/112233.png");
+
+    subset = list->subsets[1];
+    ASSERT_NUM_EQUALS(subset->id, 2345);
+    ASSERT_STR_EQUALS(subset->title, "Bonus");
+    ASSERT_STR_EQUALS(subset->badge_name, "112234");
+    ASSERT_NUM_EQUALS(subset->num_achievements, 3);
+    ASSERT_NUM_EQUALS(subset->num_leaderboards, 2);
+    ASSERT_STR_EQUALS(subset->badge_url, "http://server/Images/112234.png");
+
+    rc_client_destroy_subset_list(list);
+  }
+
+  rc_client_unload_game(g_client);
+  ASSERT_PTR_NULL(g_client->game);
+
+  list = rc_client_create_subset_list(g_client);
+  ASSERT_PTR_NOT_NULL(list);
+  if (list) {
+    ASSERT_NUM_EQUALS(list->num_subsets, 0);
+    rc_client_destroy_subset_list(list);
+  }
+
+  rc_client_destroy(g_client);
+}
+
 /* ----- achievement list ----- */
 
 static void test_achievement_list_simple(void)
@@ -10163,6 +10207,7 @@ void test_client(void) {
 
   /* subset */
   TEST(test_load_subset);
+  TEST(test_subset_list);
 
   /* achievements */
   TEST(test_achievement_list_simple);

test/test_rc_client_external.c

@@ -1335,6 +1335,66 @@ static void test_get_subset_info(void)
   rc_client_destroy(g_client);
 }
 
+static void rc_client_external_destroy_subset_list(rc_client_subset_list_info_t* list)
+{
+  g_external_event = "destroyed";
+  free(list);
+}
+
+static rc_client_subset_list_info_t* rc_client_external_create_subset_list_v6()
+{
+  rc_client_subset_list_info_t* list;
+
+  list = (rc_client_subset_list_info_t*)calloc(1, sizeof(*list) + sizeof(rc_client_subset_t*) * 2);
+  if (list) {
+    const rc_client_subset_t** subset;
+    rc_client_subset_t* mutable_subset;
+    list->public_.num_subsets = 2;
+    list->public_.subsets = subset = (const rc_client_subset_t**)((uint8_t*)list + sizeof(*list));
+    *subset++ = rc_client_external_get_subset_info_v3(1111);
+    *subset = rc_client_external_get_subset_info_v3(2345);
+    mutable_subset = (rc_client_subset_t*)*subset;
+    mutable_subset->title = "Bonus";
+    mutable_subset->num_achievements = 1;
+    mutable_subset->num_leaderboards = 0;
+
+    list->destroy_func = rc_client_external_destroy_subset_list;
+  }
+
+  return list;
+}
+
+static void test_create_subset_list(void)
+{
+  rc_client_subset_list_t* list;
+
+  g_client = mock_client_with_external();
+  g_client->state.external_client->create_subset_list = rc_client_external_create_subset_list_v6;
+
+  list = rc_client_create_subset_list(g_client);
+  ASSERT_PTR_NOT_NULL(list);
+  ASSERT_NUM_EQUALS(list->num_subsets, 2);
+  ASSERT_PTR_NOT_NULL(list->subsets);
+  ASSERT_NUM_EQUALS(list->subsets[0]->id, 1111);
+  ASSERT_STR_EQUALS(list->subsets[0]->title, "Subset Title");
+  ASSERT_STR_EQUALS(list->subsets[0]->badge_name, "BDG001");
+  ASSERT_NUM_EQUALS(list->subsets[0]->num_achievements, 2);
+  ASSERT_NUM_EQUALS(list->subsets[0]->num_leaderboards, 1);
+  ASSERT_STR_EQUALS(list->subsets[0]->badge_url, "/Badge/BDG001.png");
+  ASSERT_NUM_EQUALS(list->subsets[1]->id, 2345);
+  ASSERT_STR_EQUALS(list->subsets[1]->title, "Bonus");
+  ASSERT_STR_EQUALS(list->subsets[1]->badge_name, "BDG001");
+  ASSERT_NUM_EQUALS(list->subsets[1]->num_achievements, 1);
+  ASSERT_NUM_EQUALS(list->subsets[1]->num_leaderboards, 0);
+  ASSERT_STR_EQUALS(list->subsets[1]->badge_url, "/Badge/BDG001.png");
+
+  rc_client_destroy_subset_list(list);
+
+  ASSERT_STR_EQUALS(g_external_event, "destroyed");
+
+  rc_client_destroy(g_client);
+}
+
 static void test_unload_game(void)
 {
   g_client = mock_client_with_external();
@@ -2068,6 +2128,7 @@ void test_client_external(void) {
   TEST(test_v3_subset_field_offsets);
   TEST(test_get_subset_info_v1);
   TEST(test_get_subset_info);
+  TEST(test_create_subset_list);
 
   /* achievements */
   TEST(test_v1_achievement_field_offsets);