summaryrefslogtreecommitdiff
path: root/libs/libtox/src/toxcore/list.h
diff options
context:
space:
mode:
authoraunsane <aunsane@gmail.com>2017-12-15 01:05:56 +0300
committeraunsane <aunsane@gmail.com>2017-12-15 01:05:56 +0300
commite124aa3611f38573898aa79c6eabe77bc874e58f (patch)
tree819464260f758bbc002b23c0c8a77f93751dcb42 /libs/libtox/src/toxcore/list.h
parentbbd9647d47f20d10b39570def918a0ac68c305c9 (diff)
preparing to build tox from sources
Diffstat (limited to 'libs/libtox/src/toxcore/list.h')
-rw-r--r--libs/libtox/src/toxcore/list.h85
1 files changed, 85 insertions, 0 deletions
diff --git a/libs/libtox/src/toxcore/list.h b/libs/libtox/src/toxcore/list.h
new file mode 100644
index 0000000000..cb3b328c5a
--- /dev/null
+++ b/libs/libtox/src/toxcore/list.h
@@ -0,0 +1,85 @@
+/*
+ * Simple struct with functions to create a list which associates ids with data
+ * -Allows for finding ids associated with data such as IPs or public keys in a short time
+ * -Should only be used if there are relatively few add/remove calls to the list
+ */
+
+/*
+ * Copyright © 2016-2017 The TokTok team.
+ * Copyright © 2014 Tox project.
+ *
+ * This file is part of Tox, the free peer to peer instant messenger.
+ *
+ * Tox is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Tox is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Tox. If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef LIST_H
+#define LIST_H
+
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+
+typedef struct {
+ uint32_t n; //number of elements
+ uint32_t capacity; //number of elements memory is allocated for
+ uint32_t element_size; //size of the elements
+ uint8_t *data; //array of elements
+ int *ids; //array of element ids
+} BS_LIST;
+
+/* Initialize a list, element_size is the size of the elements in the list and
+ * initial_capacity is the number of elements the memory will be initially allocated for
+ *
+ * return value:
+ * 1 : success
+ * 0 : failure
+ */
+int bs_list_init(BS_LIST *list, uint32_t element_size, uint32_t initial_capacity);
+
+/* Free a list initiated with list_init */
+void bs_list_free(BS_LIST *list);
+
+/* Retrieve the id of an element in the list
+ *
+ * return value:
+ * >= 0 : id associated with data
+ * -1 : failure
+ */
+int bs_list_find(const BS_LIST *list, const uint8_t *data);
+
+/* Add an element with associated id to the list
+ *
+ * return value:
+ * 1 : success
+ * 0 : failure (data already in list)
+ */
+int bs_list_add(BS_LIST *list, const uint8_t *data, int id);
+
+/* Remove element from the list
+ *
+ * return value:
+ * 1 : success
+ * 0 : failure (element not found or id does not match)
+ */
+int bs_list_remove(BS_LIST *list, const uint8_t *data, int id);
+
+/* Removes the memory overhead
+ *
+ * return value:
+ * 1 : success
+ * 0 : failure
+ */
+int bs_list_trim(BS_LIST *list);
+
+#endif