feat: Add unpacker functions for events structures.

Author: iphydf

CMakeLists.txt

@@ -272,7 +272,9 @@ set(toxcore_SOURCES ${toxcore_SOURCES}
   toxcore/events/events_alloc.h
   toxcore/events/self_connection_status.c
   toxcore/tox_events.c
-  toxcore/tox_events.h)
+  toxcore/tox_events.h
+  toxcore/tox_unpack.c
+  toxcore/tox_unpack.h)
 set(toxcore_API_HEADERS ${toxcore_API_HEADERS} ${toxcore_SOURCE_DIR}/toxcore/tox_events.h^tox)
 set(toxcore_LINK_MODULES ${toxcore_LINK_MODULES} ${MSGPACK_LIBRARIES})
 set(toxcore_PKGCONFIG_REQUIRES ${toxcore_PKGCONFIG_REQUIRES} msgpack)

auto_tests/tox_dispatch_test.c

@@ -44,10 +44,31 @@ static void dump_events(const char *path, const Tox_Events *events)
 
 static void print_events(Tox_Events *events)
 {
-    if (tox_events_bytes_size(events) > 24) {
+    const uint32_t size = tox_events_bytes_size(events);
+
+    if (size > 24) {
+        tox_events_print(events);
+    }
+
+    uint8_t *bytes = (uint8_t *)malloc(size);
+    ck_assert(bytes != nullptr);
+
+    tox_events_get_bytes(events, bytes);
+
+    Tox_Events *events_copy = tox_events_load(bytes, size);
+    ck_assert(events_copy != nullptr);
+    free(bytes);
+
+    if (!tox_events_equal(events, events_copy)) {
+        printf("serialised and deserialised events are not equal:\n");
+        printf("a = ");
         tox_events_print(events);
+        printf("b = ");
+        tox_events_print(events_copy);
+        abort();
     }
 
+    tox_events_free(events_copy);
     tox_events_free(events);
 }
 

toxcore/BUILD.bazel

@@ -460,6 +460,18 @@ cc_library(
     ],
 )
 
+cc_library(
+    name = "tox_unpack",
+    srcs = ["tox_unpack.c"],
+    hdrs = ["tox_unpack.h"],
+    visibility = ["//c-toxcore:__subpackages__"],
+    deps = [
+        ":ccompat",
+        ":toxcore",
+        "@msgpack-c",
+    ],
+)
+
 cc_library(
     name = "tox_events",
     srcs = ["tox_events.c"] + glob([
@@ -470,6 +482,7 @@ cc_library(
     visibility = ["//c-toxcore:__subpackages__"],
     deps = [
         ":ccompat",
+        ":tox_unpack",
         ":toxcore",
         "@msgpack-c",
     ],

toxcore/Makefile.inc

@@ -60,6 +60,8 @@ libtoxcore_la_SOURCES = ../toxcore/ccompat.h \
                         ../toxcore/tox_dispatch.c \
                         ../toxcore/tox_events.h \
                         ../toxcore/tox_events.c \
+                        ../toxcore/tox_unpack.h \
+                        ../toxcore/tox_unpack.c \
                         ../toxcore/tox_private.h \
                         ../toxcore/tox_api.c \
                         ../toxcore/util.h \

toxcore/events/conference_connected.c

@@ -11,6 +11,7 @@
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
+#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -24,13 +25,6 @@ struct Tox_Event_Conference_Connected {
     uint32_t conference_number;
 };
 
-static void tox_event_conference_connected_pack(const Tox_Event_Conference_Connected *event, msgpack_packer *mp)
-{
-    assert(event != nullptr);
-    msgpack_pack_array(mp, 1);
-    msgpack_pack_uint32(mp, event->conference_number);
-}
-
 static void tox_event_conference_connected_construct(Tox_Event_Conference_Connected *conference_connected)
 {
     *conference_connected = (Tox_Event_Conference_Connected) {
@@ -42,19 +36,39 @@ static void tox_event_conference_connected_destruct(Tox_Event_Conference_Connect
     return;
 }
 
-static void tox_event_conference_connected_set_conference_number(Tox_Event_Conference_Connected *conference_connected,
-        uint32_t conference_number)
+static void tox_event_conference_connected_set_conference_number(
+    Tox_Event_Conference_Connected *conference_connected, uint32_t conference_number)
 {
     assert(conference_connected != nullptr);
     conference_connected->conference_number = conference_number;
 }
-uint32_t tox_event_conference_connected_get_conference_number(const Tox_Event_Conference_Connected
-        *conference_connected)
+uint32_t tox_event_conference_connected_get_conference_number(
+    const Tox_Event_Conference_Connected *conference_connected)
 {
     assert(conference_connected != nullptr);
     return conference_connected->conference_number;
 }
 
+static void tox_event_conference_connected_pack(
+    const Tox_Event_Conference_Connected *event, msgpack_packer *mp)
+{
+    assert(event != nullptr);
+    msgpack_pack_array(mp, 1);
+    msgpack_pack_uint32(mp, event->conference_number);
+}
+
+static bool tox_event_conference_connected_unpack(
+    Tox_Event_Conference_Connected *event, const msgpack_object *obj)
+{
+    assert(event != nullptr);
+
+    if (obj->type != MSGPACK_OBJECT_ARRAY || obj->via.array.size < 1) {
+        return false;
+    }
+
+    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0]);
+}
+
 
 /*****************************************************
  *
@@ -132,6 +146,28 @@ void tox_events_pack_conference_connected(const Tox_Events *events, msgpack_pack
     }
 }
 
+bool tox_events_unpack_conference_connected(Tox_Events *events, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_ARRAY) {
+        return false;
+    }
+
+    for (uint32_t i = 0; i < obj->via.array.size; ++i) {
+        Tox_Event_Conference_Connected *event = tox_events_add_conference_connected(events);
+
+        if (event == nullptr) {
+            return false;
+        }
+
+        if (!tox_event_conference_connected_unpack(event, &obj->via.array.ptr[i])) {
+            return false;
+        }
+    }
+
+    return true;
+}
+
+
 
 /*****************************************************
  *

toxcore/events/conference_invite.c

@@ -11,6 +11,7 @@
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
+#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -27,16 +28,6 @@ struct Tox_Event_Conference_Invite {
     size_t cookie_length;
 };
 
-static void tox_event_conference_invite_pack(const Tox_Event_Conference_Invite *event, msgpack_packer *mp)
-{
-    assert(event != nullptr);
-    msgpack_pack_array(mp, 3);
-    msgpack_pack_uint32(mp, event->friend_number);
-    msgpack_pack_uint32(mp, event->type);
-    msgpack_pack_bin(mp, event->cookie_length);
-    msgpack_pack_bin_body(mp, event->cookie, event->cookie_length);
-}
-
 static void tox_event_conference_invite_construct(Tox_Event_Conference_Invite *conference_invite)
 {
     *conference_invite = (Tox_Event_Conference_Invite) {
@@ -73,8 +64,7 @@ Tox_Conference_Type tox_event_conference_invite_get_type(const Tox_Event_Confere
 }
 
 static bool tox_event_conference_invite_set_cookie(Tox_Event_Conference_Invite *conference_invite,
-        const uint8_t *cookie,
-        size_t cookie_length)
+        const uint8_t *cookie, size_t cookie_length)
 {
     assert(conference_invite != nullptr);
 
@@ -105,6 +95,31 @@ const uint8_t *tox_event_conference_invite_get_cookie(const Tox_Event_Conference
     return conference_invite->cookie;
 }
 
+static void tox_event_conference_invite_pack(
+    const Tox_Event_Conference_Invite *event, msgpack_packer *mp)
+{
+    assert(event != nullptr);
+    msgpack_pack_array(mp, 3);
+    msgpack_pack_uint32(mp, event->friend_number);
+    msgpack_pack_uint32(mp, event->type);
+    msgpack_pack_bin(mp, event->cookie_length);
+    msgpack_pack_bin_body(mp, event->cookie, event->cookie_length);
+}
+
+static bool tox_event_conference_invite_unpack(
+    Tox_Event_Conference_Invite *event, const msgpack_object *obj)
+{
+    assert(event != nullptr);
+
+    if (obj->type != MSGPACK_OBJECT_ARRAY || obj->via.array.size < 3) {
+        return false;
+    }
+
+    return tox_unpack_u32(&event->friend_number, &obj->via.array.ptr[0])
+           && tox_unpack_conference_type(&event->type, &obj->via.array.ptr[1])
+           && tox_unpack_bin(&event->cookie, &event->cookie_length, &obj->via.array.ptr[2]);
+}
+
 
 /*****************************************************
  *
@@ -181,6 +196,27 @@ void tox_events_pack_conference_invite(const Tox_Events *events, msgpack_packer
     }
 }
 
+bool tox_events_unpack_conference_invite(Tox_Events *events, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_ARRAY) {
+        return false;
+    }
+
+    for (uint32_t i = 0; i < obj->via.array.size; ++i) {
+        Tox_Event_Conference_Invite *event = tox_events_add_conference_invite(events);
+
+        if (event == nullptr) {
+            return false;
+        }
+
+        if (!tox_event_conference_invite_unpack(event, &obj->via.array.ptr[i])) {
+            return false;
+        }
+    }
+
+    return true;
+}
+
 
 /*****************************************************
  *

toxcore/events/conference_message.c

@@ -11,6 +11,7 @@
 #include "../ccompat.h"
 #include "../tox.h"
 #include "../tox_events.h"
+#include "../tox_unpack.h"
 
 
 /*****************************************************
@@ -28,17 +29,6 @@ struct Tox_Event_Conference_Message {
     size_t message_length;
 };
 
-static void tox_event_conference_message_pack(const Tox_Event_Conference_Message *event, msgpack_packer *mp)
-{
-    assert(event != nullptr);
-    msgpack_pack_array(mp, 5);
-    msgpack_pack_uint32(mp, event->conference_number);
-    msgpack_pack_uint32(mp, event->peer_number);
-    msgpack_pack_uint32(mp, event->type);
-    msgpack_pack_bin(mp, event->message_length);
-    msgpack_pack_bin_body(mp, event->message, event->message_length);
-}
-
 static void tox_event_conference_message_construct(Tox_Event_Conference_Message *conference_message)
 {
     *conference_message = (Tox_Event_Conference_Message) {
@@ -118,6 +108,33 @@ const uint8_t *tox_event_conference_message_get_message(const Tox_Event_Conferen
     return conference_message->message;
 }
 
+static void tox_event_conference_message_pack(
+    const Tox_Event_Conference_Message *event, msgpack_packer *mp)
+{
+    assert(event != nullptr);
+    msgpack_pack_array(mp, 4);
+    msgpack_pack_uint32(mp, event->conference_number);
+    msgpack_pack_uint32(mp, event->peer_number);
+    msgpack_pack_uint32(mp, event->type);
+    msgpack_pack_bin(mp, event->message_length);
+    msgpack_pack_bin_body(mp, event->message, event->message_length);
+}
+
+static bool tox_event_conference_message_unpack(
+    Tox_Event_Conference_Message *event, const msgpack_object *obj)
+{
+    assert(event != nullptr);
+
+    if (obj->type != MSGPACK_OBJECT_ARRAY || obj->via.array.size < 4) {
+        return false;
+    }
+
+    return tox_unpack_u32(&event->conference_number, &obj->via.array.ptr[0])
+           && tox_unpack_u32(&event->peer_number, &obj->via.array.ptr[1])
+           && tox_unpack_message_type(&event->type, &obj->via.array.ptr[2])
+           && tox_unpack_bin(&event->message, &event->message_length, &obj->via.array.ptr[3]);
+}
+
 
 /*****************************************************
  *
@@ -194,6 +211,27 @@ void tox_events_pack_conference_message(const Tox_Events *events, msgpack_packer
     }
 }
 
+bool tox_events_unpack_conference_message(Tox_Events *events, const msgpack_object *obj)
+{
+    if (obj->type != MSGPACK_OBJECT_ARRAY) {
+        return false;
+    }
+
+    for (uint32_t i = 0; i < obj->via.array.size; ++i) {
+        Tox_Event_Conference_Message *event = tox_events_add_conference_message(events);
+
+        if (event == nullptr) {
+            return false;
+        }
+
+        if (!tox_event_conference_message_unpack(event, &obj->via.array.ptr[i])) {
+            return false;
+        }
+    }
+
+    return true;
+}
+
 
 /*****************************************************
  *